Skip to content
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

feat: STRF-9705 MessageFormat errors mark as warning #272

Merged
merged 1 commit into from
Mar 18, 2022
Merged

feat: STRF-9705 MessageFormat errors mark as warning #272

Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## Pending
- bump paper-handlerbars [#x](https://github.com/bigcommerce/paper/pull/x)
- STRF-9705 MessageFormat errors mark as warning [#x](https://github.com/bigcommerce/paper/pull/x)

## 3.0.3 (2022-03-02)
- STRF-9658 logger accepts strings instead of objects [#270](https://github.com/bigcommerce/paper/pull/270)

Expand Down
4 changes: 2 additions & 2 deletions lib/translator/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Translator.prototype.translate = function (key, parameters) {
try {
return this._formatFunctions[key](parameters);
} catch (err) {
this._logger.error(err.message);
this._logger.warn(err.message);
return '';
}
};
Expand Down Expand Up @@ -163,7 +163,7 @@ Translator.prototype._compileTemplate = function (key) {
return formatter.compile(this._language.translations[key]);
} catch (err) {
if (err.name === 'SyntaxError') {
this._logger.error(`Language File Syntax Error: ${err.message} for key "${key}"`, err.expected);
this._logger.warn(`Language File Syntax Error: ${err.message} for key "${key}"`, err.expected);
return () => '';
}

Expand Down
2 changes: 1 addition & 1 deletion lib/translator/transformer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ function flatten(translations, preferredLocales, logger = console) {
try {
result[locale] = flattenObject(translations[locale]);
} catch (err) {
logger.error(`Failed to flatten ${locale} - Error: ${err}`);
logger.warn(`Failed to flatten ${locale} - Error: ${err}`);
result[locale] = {};
}
}
Expand Down
11 changes: 6 additions & 5 deletions spec/lib/translator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ describe('Translator', () => {
loggerStub = {
log: Sinon.fake(),
error: Sinon.fake(),
warn: Sinon.fake(),
};

done();
Expand Down Expand Up @@ -112,7 +113,7 @@ describe('Translator', () => {
const translator = Translator.create('nl', Object.assign({}, translations, { nl: nl }), loggerStub);

expect(translator.translate('bye')).to.equal('Bye bye');
expect(loggerStub.error.called).to.equal(true);
expect(loggerStub.warn.called).to.equal(true);

done();
});
Expand All @@ -130,8 +131,8 @@ describe('Translator', () => {
const translator = Translator.create('en', translations, loggerStub);

expect(translator.translate('hello')).to.equal('');
expect(loggerStub.error.called).to.equal(true);
expect(loggerStub.error.getCall(0).args[0]).to.equal("MessageFormat: Data required for 'name'.")
expect(loggerStub.warn.called).to.equal(true);
expect(loggerStub.warn.getCall(0).args[0]).to.equal("MessageFormat: Data required for 'name'.")

done();
});
Expand All @@ -146,8 +147,8 @@ describe('Translator', () => {
const result = translator.translate('items_with_syntax_error', { count: 1 });
const errMessage = 'Language File Syntax Error: Expected "plural" or "select" but "p" found. for key "items_with_syntax_error"';
expect(result).to.equal("");
expect(loggerStub.error.called).to.equal(true);
expect(loggerStub.error.getCall(0).args[0]).to.equal(errMessage);
expect(loggerStub.warn.called).to.equal(true);
expect(loggerStub.warn.getCall(0).args[0]).to.equal(errMessage);

done();
});
Expand Down