test: add missing tests

Author: martinmcwhorter

src/commit-template.test.ts

@@ -0,0 +1,25 @@
+import { PromptAnswers, headerTemplate, commitTemplate } from './commit-template';
+
+describe('commit-template', () => {
+  describe('headerTemplate', () => {
+    test.each<[PromptAnswers, string]>([
+      [{ type: 'foo', scope: 'bar', subject: 'baz' }, 'foo(bar): baz'],
+      [{ type: 'foo' }, 'foo: '],
+      [{ type: 'foo', subject: 'bar' }, 'foo: bar']
+    ])(`should convert answers %o to template '%s'`, (answers, expected) => {
+      const result = headerTemplate(answers.type, answers.scope, answers.subject);
+
+      expect(result).toBe(expected);
+    });
+  });
+
+  describe('headerTemplate', () => {
+    test.each<[PromptAnswers, string]>([
+      [{ type: 'foo', scope: 'bar', subject: 'baz', body: '\nbody', footer: '\nfooter' }, `foo(bar): baz\nbody\nfooter`]
+    ])(`should convert answers %o to template '%s'`, (answers, expected) => {
+      const result = commitTemplate(answers);
+
+      expect(result).toBe(expected);
+    });
+  });
+});

src/commit-template.ts

@@ -12,7 +12,7 @@ export type PromptAnswers = {
 
 export type Question = DistinctQuestion<PromptAnswers>;
 
-export function header(type?: string, scope?: string, subject?: string): string {
+export function headerTemplate(type?: string, scope?: string, subject?: string): string {
   let header = `${type}`;
   if (scope) {
     header += `(${scope})`;
@@ -27,10 +27,12 @@ export function header(type?: string, scope?: string, subject?: string): string
   return header;
 }
 
-export function commitTemplate(answers: Answers) {
-  const head = header(answers.type, answers.scope, answers.subject);
+export function commitTemplate(answers: PromptAnswers) {
+  let template = headerTemplate(answers.type, answers.scope, answers.subject);
 
-  const template = head + answers.breakingChange ? answers.breakingBody : answers.body;
+  template += answers.body ?? '';
+
+  template += answers.footer ?? '';
 
   return template;
 }

src/filters.test.ts

@@ -32,6 +32,12 @@ describe('filters', () => {
 
       expect(result).toBe('foo');
     });
+
+    test('does not add blank line to empty string', () => {
+      const result = leadingBlankFilter('', [2, 'always', undefined]);
+
+      expect(result).toBe('');
+    });
   });
 
   describe('fullStopFilter', () => {
@@ -90,6 +96,12 @@ describe('filters', () => {
 
       expect(result).toBe('FOO_bar');
     });
+
+    test('should not change when rule is array of cases', () => {
+      const result = wordCaseFilter('foo', [Level.Error, 'always', ['upper-case', 'lower-case']]);
+
+      expect(result).toBe('foo');
+    });
   });
 
   describe('maxLineLengthFilter', () => {

src/prompts/subject-maker.ts

@@ -3,11 +3,11 @@ import { red, green } from 'chalk';
 import { pipeWith, valueFromRule } from '../utils';
 import { caseValidator, emptyValidator, maxLengthValidator, minLengthValidator, validate } from '../validators';
 import { fullStopFilter, wordCaseFilter } from '../filters';
-import { header, PromptAnswers, Question } from '../commit-template';
+import { headerTemplate, PromptAnswers, Question } from '../commit-template';
 
 export function validatorFactory(rules: Rules) {
   return (value: string, answers: PromptAnswers) => {
-    const headerValue = header(answers.type, answers.scope, value);
+    const headerValue = headerTemplate(answers.type, answers.scope, value);
 
     return validate([
       {
@@ -62,7 +62,7 @@ export function messageFactory(rules: Rules) {
     }
 
     return `Write a short, imperative tense description of the change (max ${maxLength -
-      header(answers.type, answers.scope).length} chars):\n`;
+      headerTemplate(answers.type, answers.scope).length} chars):\n`;
   };
 }
 
@@ -73,7 +73,8 @@ export function transformerFactory(rules: Rules) {
     const headerMaxLength = valueFromRule(rules['header-max-length']);
 
     if (headerMaxLength) {
-      const color = filter(value).length <= headerMaxLength - header(answers.type, answers.scope).length ? green : red;
+      const color =
+        filter(value).length <= headerMaxLength - headerTemplate(answers.type, answers.scope).length ? green : red;
       return color(`(${value.length}) ${value}`);
     }
 

src/utils.test.ts

@@ -1,5 +1,6 @@
 import { Case, Level } from '@commitlint/load';
-import { getLongest, pipeWith, valueFromRule, wordCase } from './utils';
+import { green, red } from 'chalk';
+import { getLongest, pipeWith, valueFromRule, wordCase, maxLengthTransformerFactory } from './utils';
 
 describe('getLongest', () => {
   test('return longest string length in array', () => {
@@ -70,4 +71,18 @@ describe('wordCase', () => {
       expect(result).toBe(72);
     });
   });
+
+  describe('maxLengthTransformerFactory', () => {
+    test.each<[number | undefined, string, string]>([
+      [3, 'foo', green('(3) foo')],
+      [3, 'foo bar', red('(7) foo bar')],
+      [undefined, 'foo', 'foo']
+    ])('should transform when length: %n to expected: %s', (length, value, expected) => {
+      const factory = maxLengthTransformerFactory(length);
+
+      const result = factory(value);
+
+      expect(result).toBe(expected);
+    });
+  });
 });