feat: allow empty footer too (git commit defaults)

Signed-off-by: Charlike Mike Reagent <[email protected]>

Author: Charlike Mike Reagent

src/commit.js

@@ -158,11 +158,11 @@ export function checkCommit(commit) {
 
   const isValid =
     'footer' in commit && commit.footer !== null
-      ? isValidString(commit.footer)
+      ? typeof commit.footer === 'string'
       : true;
 
   if (!isValid) {
-    throw new TypeError('commit.footer should be non empty string when given');
+    throw new TypeError('commit.footer should be string when given');
   }
 
   return Object.assign({ body: null, footer: null }, commit, { header });

test/commit/check.test.js

@@ -38,10 +38,7 @@ test('.checkCommit throw if commit.body is not a string when given', (t) => {
 });
 test('.checkCommit throw if commit.footer is not a string when given', (t) => {
   const commit = { header: { type: 'fix', subject: 'qux zaz' }, footer: 123 };
-  t.throws(
-    () => checkCommit(commit),
-    /footer should be non empty string when given/,
-  );
+  t.throws(() => checkCommit(commit), /footer should be string when given/);
 });
 
 test('.checkCommit should commit.body be `null` when explicitly null given', (t) => {
@@ -96,10 +93,18 @@ test('.checkCommit object with scope, body and footer', (t) => {
   t.deepStrictEqual(checkCommit(commit), commit);
 });
 
-test('should checkCommit allow empty string body', (t) => {
+test('should checkCommit allow empty string body (git commit deafults)', (t) => {
   const header = { type: 'feat', scope: 'zazzy', subject: 'okey dude' };
   const commit = { header, body: '' };
   const result = checkCommit(commit);
 
   t.strictEqual(result.body, '');
 });
+
+test('should checkCommit allow empty string footer (git commit deafults)', (t) => {
+  const header = { type: 'feat', scope: 'zazzy', subject: 'okey dude' };
+  const commit = { header, footer: '' };
+  const result = checkCommit(commit);
+
+  t.strictEqual(result.footer, '');
+});

test/commit/snapshots/check.test.snapshot.json

@@ -0,0 +1 @@
+{".checkCommit throw if not object given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":1,"str":"(t) => {\n  t.throws(() => checkCommit({}), TypeError);\n  t.throws(() => checkCommit([]), TypeError);\n  t.throws(() => checkCommit(null), TypeError);\n  t.throws(() => checkCommit(123), /expect `commit` to be an object/);\n}","title":".checkCommit throw if not object given"},".checkCommit throw if commit.header.type is not a string":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":2,"str":"(t) => {\n  const fixture = () => checkCommit({ header: { foo: 'bar' } });\n  t.throws(fixture, /type should be non empty string/);\n}","title":".checkCommit throw if commit.header.type is not a string"},".checkCommit throw if commit.header.subject is not a string":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":3,"str":"(t) => {\n  t.throws(\n    () => checkCommit({ header: { type: 'fix' } }),\n    /subject should be non empty string/,\n  );\n  t.throws(\n    () => checkCommit({ header: { type: 'fix', subject: '' } }),\n    /subject should be non empty string/,\n  );\n}","title":".checkCommit throw if commit.header.subject is not a string"},".checkCommit throw if commit.header.scope is not a string when given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":4,"str":"(t) => {\n  const commit = { header: { type: 'fix', subject: 'qux zaz', scope: 123 } };\n  t.throws(\n    () => checkCommit(commit),\n    /scope should be non empty string when given/,\n  );\n}","title":".checkCommit throw if commit.header.scope is not a string when given"},".checkCommit throw if commit.body is not a string when given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":5,"str":"(t) => {\n  const commit = { header: { type: 'fix', subject: 'qux zaz' }, body: 123 };\n  t.throws(() => checkCommit(commit), /body should be string when given/);\n}","title":".checkCommit throw if commit.body is not a string when given"},".checkCommit throw if commit.footer is not a string when given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":6,"str":"(t) => {\n  const commit = { header: { type: 'fix', subject: 'qux zaz' }, footer: 123 };\n  t.throws(() => checkCommit(commit), /footer should be string when given/);\n}","title":".checkCommit throw if commit.footer is not a string when given"},".checkCommit should commit.body be `null` when explicitly null given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":7,"str":"(t) => {\n  const header = { type: 'fix', scope: 'cli', subject: 'zzz' };\n  const commit = { header, body: null, footer: 'xyz' };\n  const result = checkCommit(commit);\n\n  t.deepStrictEqual(result, {\n    header: { type: 'fix', scope: 'cli', subject: 'zzz' },\n    body: null,\n    footer: 'xyz',\n  });\n}","title":".checkCommit should commit.body be `null` when explicitly null given"},".checkCommit should commit.body be null when not given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":8,"str":"(t) => {\n  const header = { type: 'feat', scope: 'zazzy', subject: 'okey dude' };\n  const commit = { header, footer: 'ok ok' };\n  const result = checkCommit(commit);\n\n  t.deepStrictEqual(result, { header, body: null, footer: 'ok ok' });\n}","title":".checkCommit should commit.body be null when not given"},".checkCommit should commit.footer be `null` when explicitly null given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":9,"str":"(t) => {\n  const header = { type: 'fix', scope: 'cli', subject: 'zzz' };\n  const commit = { header, footer: null, body: 'BREAKING CHANGE: whoa!' };\n  const result = checkCommit(commit);\n\n  t.deepStrictEqual(result, {\n    header: { type: 'fix', scope: 'cli', subject: 'zzz' },\n    body: 'BREAKING CHANGE: whoa!',\n    footer: null,\n  });\n}","title":".checkCommit should commit.footer be `null` when explicitly null given"},".checkCommit should commit.footer be null when not given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":10,"str":"(t) => {\n  const header = { type: 'feat', scope: 'zazzy', subject: 'okey dude' };\n  const commit = { header };\n  const result = checkCommit(commit);\n  t.deepStrictEqual(result, { header, body: null, footer: null });\n}","title":".checkCommit should commit.footer be null when not given"},".checkCommit object with scope, body and footer":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":11,"str":"(t) => {\n  const commit = {\n    header: {\n      type: 'feat',\n      scope: 'quxie',\n      subject: 'woo hoo',\n    },\n    body: 'qux zaz faz',\n    footer: 'Breaking yeah',\n  };\n  t.deepStrictEqual(checkCommit(commit), commit);\n}","title":".checkCommit object with scope, body and footer"},"should checkCommit allow empty string body (git commit deafults)":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":12,"str":"(t) => {\n  const header = { type: 'feat', scope: 'zazzy', subject: 'okey dude' };\n  const commit = { header, body: '' };\n  const result = checkCommit(commit);\n\n  t.strictEqual(result.body, '');\n}","title":"should checkCommit allow empty string body (git commit deafults)"},"should checkCommit allow empty string footer (git commit deafults)":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":13,"str":"(t) => {\n  const header = { type: 'feat', scope: 'zazzy', subject: 'okey dude' };\n  const commit = { header, footer: '' };\n  const result = checkCommit(commit);\n\n  t.strictEqual(result.footer, '');\n}","title":"should checkCommit allow empty string footer (git commit deafults)"}}

test/commit/snapshots/stringify.test.snapshot.json

@@ -0,0 +1 @@
+{".stringifyCommit throw if invalid header is given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":1,"str":"(t) => {\n  t.throws(() => stringifyCommit(1234), TypeError);\n  t.throws(() => stringifyCommit({ header: { type: 'foo' } }), TypeError);\n  t.throws(() => stringifyCommit(), /expect `commit` to be an object/);\n}","title":".stringifyCommit throw if invalid header is given"},".stringifyCommit object":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":2,"str":"(t) => {\n  const header = { type: 'fix', scope: 'huh', subject: 'yeah yeah' };\n  const result = stringifyCommit({ header });\n\n  t.strictEqual(result, 'fix(huh): yeah yeah');\n\n  const cmt = {\n    header,\n    body: 'resolves #1\\nfixes #3',\n    footer: 'BREAKING CHANGE: yeah!',\n  };\n  const commitMessage = dedent`${result}\n\n  resolves #1\n  fixes #3\n\n  BREAKING CHANGE: yeah!`;\n\n  t.strictEqual(stringifyCommit(cmt), commitMessage);\n}","title":".stringifyCommit object"},".stringifyCommit object without scope":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":3,"str":"(t) => {\n  const header = {\n    header: { type: 'fix', subject: 'yeah yeah' },\n    body: 'woo hoo',\n  };\n  const result = stringifyCommit(header);\n\n  t.strictEqual(result, 'fix: yeah yeah\\n\\nwoo hoo');\n}","title":".stringifyCommit object without scope"}}

test/commit/snapshots/validate.test.snapshot.json

@@ -0,0 +1 @@
+{".validateCommit should return boolean when second param `ret` is not given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":1,"str":"(t) => {\n  const header = { type: 'fix', subject: 'bar qux' };\n  const boolTrue = validateCommit({\n    header,\n    body: 'foo',\n  });\n  const boolFalse = validateCommit({ header, body: 111, footer: 'sasa' });\n\n  t.strictEqual(boolTrue, true);\n  t.strictEqual(boolFalse, false);\n}","title":".validateCommit should return boolean when second param `ret` is not given"},".validateCommit should return { error, value } object when `ret` is true":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":2,"str":"(t) => {\n  const header = { type: 'major', scope: 'qux', subject: 'some awful change' };\n  const result = validateCommit({ header, body: 'okkk' }, true);\n\n  t.deepStrictEqual(result, {\n    value: { header, body: 'okkk', footer: null },\n  });\n\n  const res2 = validateCommit({ header: { foo: 1 }, body: 'a' }, true);\n  t.ok(res2.error);\n  t.ok(res2.error instanceof Error);\n  t.ok(!res2.value);\n}","title":".validateCommit should return { error, value } object when `ret` is true"}}

test/header/snapshots/check.test.snapshot.json

@@ -0,0 +1 @@
+{".checkHeader throw if not object given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":1,"str":"(t) => {\n  t.throws(() => checkHeader({}), TypeError);\n  t.throws(() => checkHeader([]), TypeError);\n  t.throws(() => checkHeader(null), TypeError);\n  t.throws(() => checkHeader(123), /expect `header` to be an object/);\n}","title":".checkHeader throw if not object given"},".checkHeader throw if header.type is not a string":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":2,"str":"(t) => {\n  const fixture = () => checkHeader({ foo: 'bar' });\n  t.throws(fixture, /type should be non empty string/);\n}","title":".checkHeader throw if header.type is not a string"},".checkHeader throw if header.subject is not a string":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":3,"str":"(t) => {\n  t.throws(\n    () => checkHeader({ type: 'fix' }),\n    /subject should be non empty string/,\n  );\n  t.throws(\n    () => checkHeader({ type: 'fix', subject: '' }),\n    /subject should be non empty string/,\n  );\n}","title":".checkHeader throw if header.subject is not a string"},".checkHeader throw if header.scope is not a string when given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":4,"str":"(t) => {\n  t.throws(\n    () => checkHeader({ type: 'fix', subject: 'qux zaz', scope: 123 }),\n    /scope should be non empty string when given/,\n  );\n}","title":".checkHeader throw if header.scope is not a string when given"},".checkHeader should header.scope be `null` when explicitly null given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":5,"str":"(t) => {\n  const result = checkHeader({ type: 'fix', subject: 'ss', scope: null });\n  t.deepStrictEqual(result, { type: 'fix', subject: 'ss', scope: null });\n}","title":".checkHeader should header.scope be `null` when explicitly null given"},".checkHeader should header.scope be null when not given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":6,"str":"(t) => {\n  const res = checkHeader({ type: 'aaa', subject: 'quxie bar' });\n  t.deepStrictEqual(res, { type: 'aaa', subject: 'quxie bar', scope: null });\n}","title":".checkHeader should header.scope be null when not given"},".checkHeader correctly header object without scope":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":7,"str":"(t) => {\n  const result = checkHeader({\n    type: 'fix',\n    subject: 'bar qux',\n  });\n\n  t.deepStrictEqual(result, { type: 'fix', scope: null, subject: 'bar qux' });\n}","title":".checkHeader correctly header object without scope"},".checkHeader object with scope":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":8,"str":"(t) => {\n  const header = {\n    type: 'feat',\n    scope: 'quxie',\n    subject: 'woo hoo',\n  };\n\n  t.deepStrictEqual(checkHeader(header), header);\n}","title":".checkHeader object with scope"}}

test/header/snapshots/parse.test.snapshot.json

@@ -0,0 +1 @@
+{".parseHeader throw if not a string given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":1,"str":"(t) => {\n  t.throws(() => parseHeader(123), TypeError);\n  t.throws(() => parseHeader(123), /expect `header` to be non empty string/);\n  t.throws(() => parseHeader(''), /expect `header` to be non empty string/);\n}","title":".parseHeader throw if not a string given"},".parseHeader throw when invalid conventional commits":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":2,"str":"(t) => {\n  function fixture() {\n    parseHeader('fix bar qux');\n  }\n  t.throws(fixture, Error);\n  t.throws(fixture, /<type>\\[optional scope\\]: <description>/);\n}","title":".parseHeader throw when invalid conventional commits"},".parseHeader NOT throw when header is valid by conventional commits":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":3,"str":"(t) => {\n  const one = parseHeader('fix: zzz qux');\n  const two = parseHeader('fix(cli): aaaa qux');\n  const res = parseHeader('fix(cli): qqqqq qux\\n\\nSome awesome body');\n\n  t.ok(isObject(one));\n  t.ok(isObject(two));\n  t.ok(isObject(res));\n}","title":".parseHeader NOT throw when header is valid by conventional commits"},".parseHeader correctly header string without scope":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":4,"str":"(t) => {\n  const result = parseHeader('fix: bar qux');\n\n  t.deepStrictEqual(result, { type: 'fix', scope: null, subject: 'bar qux' });\n}","title":".parseHeader correctly header string without scope"},".parseHeader header string with scope":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":5,"str":"(t) => {\n  t.deepStrictEqual(parseHeader('fix(cli): bar qux'), {\n    type: 'fix',\n    scope: 'cli',\n    subject: 'bar qux',\n  });\n}","title":".parseHeader header string with scope"}}

test/header/snapshots/validate.test.snapshot.json

@@ -0,0 +1 @@
+{".validateHeader should return boolean when second param `ret` is not given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":1,"str":"(t) => {\n  const boolTrue = validateHeader({ type: 'fix', subject: 'bar qux' });\n  const boolFalse = validateHeader({ type: 'fix' });\n\n  t.strictEqual(boolTrue, true);\n  t.strictEqual(boolFalse, false);\n}","title":".validateHeader should return boolean when second param `ret` is not given"},".validateHeader should return { error, value } object when `ret` is true":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":2,"str":"(t) => {\n  const result = validateHeader({ type: 'fix', subject: 'bar qux' }, true);\n\n  t.deepStrictEqual(result, {\n    value: { type: 'fix', scope: null, subject: 'bar qux' },\n  });\n\n  const res2 = validateHeader({ type: 'fix' }, true);\n  t.ok(res2.error);\n  t.ok(res2.error instanceof Error);\n  t.ok(!res2.value);\n}","title":".validateHeader should return { error, value } object when `ret` is true"}}

test/index.js

@@ -112,24 +112,39 @@ test('should result.increment be false if no bump needed', (t) => {
 
 test('ensure most common usage', (t) => {
   const commitMsg = 'fix: bar qux';
-  const res1 = applyPlugins(plugins, check(parse(commitMsg)));
-  const res2 = applyPlugins(plugins, check(parse(commitMsg + EOL)));
-  const res3 = applyPlugins(plugins, check(parse(commitMsg + EOL + EOL)));
+  const [res1] = applyPlugins(plugins, check(parse(commitMsg)));
+  const [res2] = applyPlugins(plugins, check(parse(commitMsg + EOL)));
+  const [res3] = applyPlugins(plugins, check(parse(commitMsg + EOL + EOL)));
 
   t.deepStrictEqual(res1, res2);
 
-  t.strictEqual(res2[0].body, null);
-  t.strictEqual(res2[0].header.type, 'fix');
-  t.strictEqual(res2[0].header.scope, null);
-  t.strictEqual(res2[0].header.subject, 'bar qux');
-  t.strictEqual(res2[0].isBreaking, false);
-  t.strictEqual(res2[0].increment, 'patch');
-
-  const [cmt] = res3;
-  t.strictEqual(cmt.header.type, 'fix');
-  t.strictEqual(cmt.header.scope, null);
-  t.strictEqual(cmt.header.subject, 'bar qux');
-  t.strictEqual(cmt.body.trim(), '');
-  t.strictEqual(cmt.isBreaking, false);
-  t.strictEqual(cmt.increment, 'patch');
+  t.strictEqual(res2.body, null);
+  t.strictEqual(res2.header.type, 'fix');
+  t.strictEqual(res2.header.scope, null);
+  t.strictEqual(res2.header.subject, 'bar qux');
+  t.strictEqual(res2.isBreaking, false);
+  t.strictEqual(res2.increment, 'patch');
+
+  t.strictEqual(res3.body.trim(), '');
+  t.strictEqual(res3.header.type, 'fix');
+  t.strictEqual(res3.header.scope, null);
+  t.strictEqual(res3.header.subject, 'bar qux');
+  t.strictEqual(res3.isBreaking, false);
+  t.strictEqual(res3.increment, 'patch');
+});
+
+test('ensure empty footer is allowed (git commit defaults)', (t) => {
+  const commitMsg = 'fix: bar qux\n\nBar qux';
+  const [res1] = applyPlugins(plugins, check(parse(commitMsg)));
+  const [res2] = applyPlugins(plugins, check(parse(commitMsg + EOL)));
+  const [res3] = applyPlugins(plugins, check(parse(commitMsg + EOL + EOL)));
+
+  t.strictEqual(res1.body, 'Bar qux');
+  t.strictEqual(res1.footer, null);
+
+  t.strictEqual(res2.body, `Bar qux${EOL}`);
+  t.strictEqual(res2.footer, null);
+
+  t.strictEqual(res3.body, 'Bar qux');
+  t.strictEqual(res3.footer, '');
 });