Skip to content

fix(core): normalize line endings in template hash calculation #826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mttrbrts merged 1 commit into from
Feb 24, 2026
Merged

fix(core): normalize line endings in template hash calculation #826

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 34 additions & 6 deletions packages/cicero-core/src/template.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,19 @@ class Template {
return this.getMetadata().getDescription();
}

/**
* Normalizes line endings to \n to ensure consistent hashing across OS
* @param {string} str the string to normalize
* @return {string} the normalized string
* @private
*/
_normalize(str) {
if(str && typeof str === 'string') {
return str.replace(/\r/g, '');
}
return str;
}

/**
* Gets a content based SHA-256 hash for this template. Hash
* is based on the metadata for the template plus the contents of
Expand All @@ -155,21 +168,36 @@ class Template {
getHash() {
const content = {};
content.metadata = this.getMetadata().toJSON();

// Normalize README
if (content.metadata.README) {
content.metadata.README = this._normalize(content.metadata.README);
}

// Normalize Samples
if (content.metadata.samples) {
Object.keys(content.metadata.samples).forEach(key => {
if (typeof content.metadata.samples[key] === 'string') {
content.metadata.samples[key] = this._normalize(content.metadata.samples[key]);
}
});
}

if(this.getTemplate()) {
content.grammar = this.getTemplate();
content.grammar = this._normalize(this.getTemplate());
}
content.models = {};
content.scripts = {};

let modelFiles = this.getModelManager().getModels();
modelFiles.forEach(function (file) {
content.models[file.namespace] = file.content;
modelFiles.forEach((file) => {
content.models[file.namespace] = this._normalize(file.content);
});

let scriptManager = this.getScriptManager();
let scriptFiles = scriptManager.getScripts();
scriptFiles.forEach(function (file) {
content.scripts[file.getIdentifier()] = file.contents;
scriptFiles.forEach((file) => {
content.scripts[file.getIdentifier()] = this._normalize(file.contents);
});

const hasher = crypto.createHash('sha256');
Expand Down Expand Up @@ -491,4 +519,4 @@ class Template {
}
}

module.exports = Template;
module.exports = Template;
Loading