fix: shell special characters escaping (#108)

ISSUES CLOSED: #107
leoforfree · Jul 15, 2022 · d9fd78a · d9fd78a
1 parent 0ad552e
commit d9fd78a
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 9 deletions.
diff --git a/__tests__/build-commit.test.js b/__tests__/build-commit.test.js
@@ -98,4 +98,11 @@ line 2`;
  expect(buildCommit(answersNoScope, options)).toEqual(expecteMessage);
  });
  });
+
+ it('should escape harmful characters', () => {
+ const altAnswers = { ...answers, subject: 'th"is i\'s a n`ew $ f<ea>ture &' };
+
+ // eslint-disable-next-line prettier/prettier, no-useless-escape
+ expect(buildCommit(altAnswers, {})).toEqual('feat(app): th\\\"is i\'s a n\\`ew \\\\$ f\\<ea\\>ture \\&');
+ });
 });
diff --git a/lib/build-commit.js b/lib/build-commit.js
@@ -48,17 +48,17 @@ const addFooter = (footer, config) => {
  return `\n\n${footerPrefix} ${addBreaklinesIfNeeded(footer, config.breaklineChar)}`;
 };
 
-const escapeSpecialChars = result => {
- // eslint-disable-next-line no-useless-escape
- const specialChars = ['`'];
-
+const escapeSpecialChars = (result) => {
+ // eslint-disable-next-line no-useless-escape, prettier/prettier
+ const specialChars = ['`', '"', '\\$', '!', '<', '>', '&'];
  let newResult = result;
- // eslint-disable-next-line array-callback-return
- specialChars.map(item => {
- // If user types "feat: `string`", the commit preview should show "feat: `\string\`".
- // Don't worry. The git log will be "feat: `string`"
- newResult = result.replace(new RegExp(item, 'g'), '\\`');
+
+ specialChars.forEach((item) => {
+ // If user types `feat: "string"`, the commit preview should show `feat: \"string\"`.
+ // Don't worry. The git log will be `feat: "string"`
+ newResult = newResult.replace(new RegExp(item, 'g'), `\\${item}`);
  });
+
  return newResult;
 };