feat: ensurance tests + allow body to be empty string

Signed-off-by: Charlike Mike Reagent <mameto2011@gmail.com>

Author: Charlike Mike Reagent

src/commit.js

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

test/commit/check.test.js

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

test/commit/snapshots/parse.test.snapshot.json

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

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

@@ -1,6 +1,7 @@
+import { EOL } from 'os';
 import test from 'asia';
 import dedent from 'dedent';
-import { applyPlugins, plugins, mappers, parse } from '../src';
+import { applyPlugins, plugins, mappers, parse, check } from '../src';
 
 test('index: basic', (t) => {
   t.strictEqual(typeof applyPlugins, 'function');
@@ -108,3 +109,27 @@ test('should result.increment be false if no bump needed', (t) => {
   t.strictEqual(result.header.scope, 'zz');
   t.strictEqual(result.header.subject, 'foo bar');
 });
+
+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)));
+
+  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');
+});

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

@@ -0,0 +1 @@
+{".validate 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 = validate({\n    header,\n    body: 'foo',\n  });\n  const boolFalse = validate({ header, body: 111, footer: 'sasa' });\n\n  t.strictEqual(boolTrue, true);\n  t.strictEqual(boolFalse, false);\n}","title":".validate should return boolean when second param `ret` is not given"},".validate should return { error, value } objects 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 = validate({ header, body: 'okkk' }, true);\n\n  t.deepStrictEqual(result.value, [{ header, body: 'okkk', footer: null }]);\n\n  const res2 = validate({ 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":".validate should return { error, value } objects when `ret` is true"},"should validate() similar to check() be able to accept array of mixed values":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":3,"str":"(t) => {\n  const commits = [\n    'fix: abr\\n\\nquxx qq',\n    { header: { type: 'qq', subject: 'ok ok' } },\n  ];\n  const { value } = validate(commits, true);\n\n  t.deepStrictEqual(value, [\n    {\n      header: { type: 'fix', scope: null, subject: 'abr' },\n      body: 'quxx qq',\n      footer: null,\n    },\n    {\n      header: { type: 'qq', scope: null, subject: 'ok ok' },\n      body: null,\n      footer: null,\n    },\n  ]);\n}","title":"should validate() similar to check() be able to accept array of mixed values"}}