fix(cz-commitlint): support multiple cases & fix to sentence-case

curly210102 · curly210102 · commit 8cd15ee68ac5 · 2021-10-12T08:44:36.000+08:00
diff --git a/@commitlint/cz-commitlint/package.json b/@commitlint/cz-commitlint/package.json
@@ -36,6 +36,7 @@
     }
   },
   "dependencies": {
+    "@commitlint/ensure": "^13.2.0",
     "@commitlint/load": "^13.2.1",
     "@commitlint/types": "^13.2.0",
     "chalk": "^4.1.0",
@@ -47,6 +48,7 @@
     "inquirer": "^8.0.0"
   },
   "devDependencies": {
-    "@types/inquirer": "^8.0.0"
+    "@types/inquirer": "^8.0.0",
+    "commitizen": "^4.2.4"
   }
 }
diff --git a/@commitlint/cz-commitlint/src/Question.test.ts b/@commitlint/cz-commitlint/src/Question.test.ts
@@ -15,6 +15,11 @@ const QUESTION_CONFIG = {
 	messages: MESSAGES,
 };
 
+const caseFn = (input: string | string[], delimiter?: string) =>
+	(Array.isArray(input) ? input : [input])
+		.map((segment) => segment[0].toUpperCase() + segment.slice(1))
+		.join(delimiter);
+
 describe('name', () => {
 	test('should throw error when name is not a meaningful string', () => {
 		expect(
@@ -195,55 +200,44 @@ describe('filter', () => {
 	test('should auto fix case and full-stop', () => {
 		const question = new Question('body', {
 			...QUESTION_CONFIG,
-			caseFn: (input: string) => input[0].toUpperCase() + input.slice(1),
+			caseFn,
 			fullStopFn: (input: string) => input + '!',
 		}).question;
 
 		expect(question.filter?.('xxxx', {})).toBe('Xxxx!');
 	});
 
-	test('should split the string to items when multipleValueDelimiters is defined', () => {
-		const question = new Question('body', {
-			...QUESTION_CONFIG,
-			caseFn: (input: string) => input[0].toUpperCase() + input.slice(1),
-			fullStopFn: (input: string) => input + '!',
-			multipleValueDelimiters: /,|\|/g,
-		}).question;
-
-		expect(question.filter?.('xxxx,yyyy|zzzz', {})).toBe('Xxxx,Yyyy|Zzzz!');
-	});
-
-	test('should delimiters keep origin when multipleSelectDefaultDelimiter is defined', () => {
+	test('should transform each item with same case when input is array', () => {
 		const question = new Question('body', {
 			...QUESTION_CONFIG,
-			caseFn: (input: string) => input[0].toUpperCase() + input.slice(1),
+			caseFn,
 			fullStopFn: (input: string) => input + '!',
-			multipleValueDelimiters: /,|\|/g,
-			multipleSelectDefaultDelimiter: '/',
 		}).question;
 
-		expect(question.filter?.('xxxx,yyyy|zzzz', {})).toBe('Xxxx,Yyyy|Zzzz!');
+		expect(question.filter?.(['xxxx', 'yyyy'], {})).toBe('Xxxx,Yyyy!');
 	});
 
-	test('should fix each item when input is array', () => {
+	test('should concat items with multipleSelectDefaultDelimiter when input is array', () => {
 		const question = new Question('body', {
 			...QUESTION_CONFIG,
-			caseFn: (input: string) => input[0].toUpperCase() + input.slice(1),
+			caseFn,
 			fullStopFn: (input: string) => input + '!',
+			multipleSelectDefaultDelimiter: '|',
 		}).question;
 
-		expect(question.filter?.(['xxxx', 'yyyy'], {})).toBe('Xxxx,Yyyy!');
+		expect(question.filter?.(['xxxx', 'yyyy'], {})).toBe('Xxxx|Yyyy!');
 	});
 
-	test('should concat items with multipleSelectDefaultDelimiter when input is array', () => {
+	test('should split the string to items when multipleValueDelimiters is defined', () => {
 		const question = new Question('body', {
 			...QUESTION_CONFIG,
-			caseFn: (input: string) => input[0].toUpperCase() + input.slice(1),
+			caseFn,
 			fullStopFn: (input: string) => input + '!',
-			multipleSelectDefaultDelimiter: '|',
+			multipleValueDelimiters: /,|\|/g,
 		}).question;
 
-		expect(question.filter?.(['xxxx', 'yyyy'], {})).toBe('Xxxx|Yyyy!');
+		expect(question.filter?.('xxxx,yyyy|zzzz', {})).toBe('Xxxx,Yyyy|Zzzz!');
+		expect(question.filter?.('xxxx-yyyy-zzzz', {})).toBe('Xxxx-yyyy-zzzz!');
 	});
 
 	test('should works well when does not pass caseFn/fullStopFn', () => {
@@ -307,7 +301,7 @@ describe('transformer', () => {
 	test('should auto transform case and full-stop', () => {
 		const question = new Question('body', {
 			...QUESTION_CONFIG,
-			caseFn: (input: string) => input[0].toUpperCase() + input.slice(1),
+			caseFn,
 			fullStopFn: (input: string) => input + '!',
 		}).question;
 
diff --git a/@commitlint/cz-commitlint/src/Question.ts b/@commitlint/cz-commitlint/src/Question.ts
@@ -59,7 +59,10 @@ export default class Question {
 		this.title = title ?? '';
 		this.skip = skip ?? false;
 		this.fullStopFn = fullStopFn ?? ((_: string) => _);
-		this.caseFn = caseFn ?? ((_: string) => _);
+		this.caseFn =
+			caseFn ??
+			((input: string | string[], delimiter?: string) =>
+				Array.isArray(input) ? input.join(delimiter) : input);
 		this.multipleValueDelimiters = multipleValueDelimiters;
 		this.multipleSelectDefaultDelimiter = multipleSelectDefaultDelimiter;
 
@@ -149,17 +152,30 @@ export default class Question {
 	}
 
 	protected filter(input: string | string[]): string {
-		// Array
-		// String,is enable MultiSelect -> input.replace(delimeter, this.case); -> Array
-
-		const toCased = Array.isArray(input)
-			? input.map(this.caseFn).join(this.multipleSelectDefaultDelimiter)
-			: this.multipleValueDelimiters
-			? input.replace(
-					new RegExp(`[^${this.multipleValueDelimiters.source}]+`, 'g'),
-					this.caseFn
-			  )
-			: this.caseFn(input);
+		let toCased;
+
+		// array
+		// - multipleSelectDefaultDelimiter
+		// - no multipleSelectDefaultDelimiter
+		// string + multipleValueDelimiters
+		// - split
+		// - not split
+		// string
+		if (Array.isArray(input)) {
+			toCased = this.caseFn(input, this.multipleSelectDefaultDelimiter);
+		} else if (this.multipleValueDelimiters) {
+			const segments = input.split(this.multipleValueDelimiters);
+			const casedString = this.caseFn(segments, ',');
+			const casedSegments = casedString.split(',');
+			toCased = input.replace(
+				new RegExp(`[^${this.multipleValueDelimiters.source}]+`, 'g'),
+				(segment) => {
+					return casedSegments[segments.indexOf(segment)];
+				}
+			);
+		} else {
+			toCased = this.caseFn(input);
+		}
 
 		return this.fullStopFn(toCased);
 	}
diff --git a/@commitlint/cz-commitlint/src/utils/case-fn.test.ts b/@commitlint/cz-commitlint/src/utils/case-fn.test.ts
@@ -1,7 +1,7 @@
 import {RuleConfigSeverity} from '@commitlint/types';
 import getCaseFn from './case-fn';
 
-test('should not apply', () => {
+test('should not transform when rule is disabled', () => {
 	let rule = getCaseFn([RuleConfigSeverity.Disabled]);
 	expect(rule('test')).toBe('test');
 	expect(rule('test-foo')).toBe('test-foo');
@@ -19,29 +19,17 @@ test('should not apply', () => {
 	expect(rule('test-foo')).toBe('test-foo');
 	expect(rule('testFoo')).toBe('testFoo');
 	expect(rule('TEST_FOO')).toBe('TEST_FOO');
-
-	rule = getCaseFn([
-		RuleConfigSeverity.Warning,
-		'always',
-		['camel-case', 'lowercase'],
-	]);
-	expect(rule('test')).toBe('test');
-	expect(rule('test-foo')).toBe('test-foo');
-	expect(rule('testFoo')).toBe('testFoo');
-	expect(rule('TEST_FOO')).toBe('TEST_FOO');
 });
 
 test('should throw error on invalid casing', () => {
-	expect(() => getCaseFn([RuleConfigSeverity.Warning, 'always'])).toThrow(
-		'Unknown target case "undefined"'
-	);
+	let rule = getCaseFn([RuleConfigSeverity.Warning, 'always']);
+	expect(() => rule('test')).toThrow('Unknown target case "undefined"');
 
-	expect(() =>
-		getCaseFn([RuleConfigSeverity.Warning, 'always', 'foo'])
-	).toThrow('Unknown target case "foo"');
+	rule = getCaseFn([RuleConfigSeverity.Warning, 'always', 'foo']);
+	expect(() => rule('test')).toThrow('Unknown target case "foo"');
 });
 
-test('should convert text correctly', () => {
+test('should transform text correctly with single case', () => {
 	let rule = getCaseFn([RuleConfigSeverity.Warning, 'always', 'camel-case']);
 	expect(rule('TEST_FOOBar-baz baz')).toBe('testFooBarBazBaz');
 
@@ -64,10 +52,10 @@ test('should convert text correctly', () => {
 	expect(rule('TEST_FOOBar-baz baz')).toBe('TEST_FOOBAR-BAZ BAZ');
 
 	rule = getCaseFn([RuleConfigSeverity.Warning, 'always', 'sentence-case']);
-	expect(rule('TEST_FOOBar-baz baz')).toBe('Test_foobar-baz baz');
+	expect(rule('tEST_FOOBar-baz baz')).toBe('TEST_FOOBar-baz baz');
 
 	rule = getCaseFn([RuleConfigSeverity.Warning, 'always', 'sentencecase']);
-	expect(rule('TEST_FOOBar-baz baz')).toBe('Test_foobar-baz baz');
+	expect(rule('tEST_FOOBar-baz baz')).toBe('TEST_FOOBar-baz baz');
 
 	rule = getCaseFn([RuleConfigSeverity.Warning, 'always', 'lower-case']);
 	expect(rule('TEST_FOOBar-baz baz')).toBe('test_foobar-baz baz');
@@ -77,4 +65,27 @@ test('should convert text correctly', () => {
 
 	rule = getCaseFn([RuleConfigSeverity.Warning, 'always', 'lowerCase']);
 	expect(rule('TEST_FOOBar-baz baz')).toBe('test_foobar-baz baz');
+
+	rule = getCaseFn([RuleConfigSeverity.Warning, 'always', 'lowerCase']);
+	expect(rule(['TEST_FOOBar-baz', 'bAz'])).toBe('test_foobar-baz,baz');
+
+	rule = getCaseFn([RuleConfigSeverity.Warning, 'always', 'lowerCase']);
+	expect(rule(['TEST_FOOBar-baz', 'bAz'], '|')).toBe('test_foobar-baz|baz');
+});
+
+test('should transform text correctly with multiple cases', () => {
+	const rule = getCaseFn([
+		RuleConfigSeverity.Warning,
+		'always',
+		['camel-case', 'lowercase'],
+	]);
+	expect(rule('test')).toBe('test');
+	expect(rule('test-foo')).toBe('test-foo');
+	expect(rule('testFoo')).toBe('testFoo');
+	expect(rule('TEST_FOO')).toBe('testFoo');
+
+	expect(rule(['testFoo', 'test_foo'])).toBe('testFoo,testFoo');
+	expect(rule(['TEST_foo', 'test_foo'])).toBe('test_foo,test_foo');
+	expect(rule(['TEST_FOO', 'Test_foo'])).toBe('testFoo,testFoo');
+	expect(rule(['TEST_FOO', 'Test_foo'], '|')).toBe('testFoo|testFoo');
 });
diff --git a/@commitlint/cz-commitlint/src/utils/case-fn.ts b/@commitlint/cz-commitlint/src/utils/case-fn.ts
@@ -1,53 +1,75 @@
+import _ from 'lodash';
 import camelCase from 'lodash/camelCase';
 import kebabCase from 'lodash/kebabCase';
 import snakeCase from 'lodash/snakeCase';
 import startCase from 'lodash/startCase';
 import upperFirst from 'lodash/upperFirst';
-import {Rule} from '../types';
 import {ruleIsActive, ruleIsNotApplicable} from './rules';
+import {TargetCaseType} from '@commitlint/types';
+import {case as ensureCase} from '@commitlint/ensure';
+import {Rule} from '../types';
 
-export type CaseFn = (input: string) => string;
+export type CaseFn = (input: string | string[], delimiter?: string) => string;
 
 /**
  * Get forced case for rule
  * @param rule to parse
  * @return transform function applying the enforced case
  */
 export default function getCaseFn(rule?: Rule): CaseFn {
-	const noop = (input: string) => input;
+	const noop = (input: string | string[], delimiter?: string) =>
+		Array.isArray(input) ? input.join(delimiter) : input;
 
 	if (!rule || !ruleIsActive(rule) || ruleIsNotApplicable(rule)) {
 		return noop;
 	}
 
-	const target = rule[2];
+	const value = rule[2];
 
-	if (Array.isArray(target)) {
-		return noop;
-	}
+	const caseList = Array.isArray(value) ? value : [value];
+
+	return (input: string | string[], delimiter?: string) => {
+		let matchedCase: TargetCaseType = caseList[0];
+		const segments = Array.isArray(input) ? input : [input];
+
+		for (const segment of segments) {
+			const check = caseList.find((a) => ensureCase(segment, a));
+			if (check) {
+				matchedCase = check;
+				break;
+			}
+		}
+
+		return segments
+			.map((segment) => {
+				return toCase(segment, matchedCase);
+			})
+			.join(delimiter);
+	};
+}
 
+function toCase(input: string, target: TargetCaseType): string {
 	switch (target) {
 		case 'camel-case':
-			return (input: string) => camelCase(input);
+			return camelCase(input);
 		case 'kebab-case':
-			return (input: string) => kebabCase(input);
+			return kebabCase(input);
 		case 'snake-case':
-			return (input: string) => snakeCase(input);
+			return snakeCase(input);
 		case 'pascal-case':
-			return (input: string) => upperFirst(camelCase(input));
+			return upperFirst(camelCase(input));
 		case 'start-case':
-			return (input: string) => startCase(input);
+			return startCase(input);
 		case 'upper-case':
 		case 'uppercase':
-			return (input: string) => input.toUpperCase();
+			return input.toUpperCase();
 		case 'sentence-case':
 		case 'sentencecase':
-			return (input: string) =>
-				`${input.charAt(0).toUpperCase()}${input.substring(1).toLowerCase()}`;
+			return input.charAt(0).toUpperCase() + input.slice(1);
 		case 'lower-case':
 		case 'lowercase':
 		case 'lowerCase': // Backwards compat config-angular v4
-			return (input: string) => input.toLowerCase();
+			return input.toLowerCase();
 		default:
 			throw new TypeError(`Unknown target case "${target}"`);
 	}
diff --git a/yarn.lock b/yarn.lock
@@ -3798,7 +3798,7 @@ commander@~2.20.3:
   resolved "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33"
   integrity sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==
 
-commitizen@4.2.4:
+commitizen@4.2.4, commitizen@^4.2.4:
   version "4.2.4"
   resolved "https://registry.npmjs.org/commitizen/-/commitizen-4.2.4.tgz#a3e5b36bd7575f6bf6e7aa19dbbf06b0d8f37165"
   integrity sha512-LlZChbDzg3Ir3O2S7jSo/cgWp5/QwylQVr59K4xayVq8S4/RdKzSyJkghAiZZHfhh5t4pxunUoyeg0ml1q/7aw==
@@ -7352,11 +7352,21 @@ lodash.truncate@^4.4.2:
   resolved "https://registry.npmjs.org/lodash.truncate/-/lodash.truncate-4.4.2.tgz#5a350da0b1113b837ecfffd5812cbe58d6eae193"
   integrity sha1-WjUNoLERO4N+z//VgSy+WNbq4ZM=
 
-lodash@4.17.15, lodash@4.x, lodash@^3.3.1, lodash@^4.17.12, lodash@^4.17.15, lodash@^4.17.19, lodash@^4.17.20, lodash@^4.17.21, lodash@^4.5.1, lodash@^4.7.0:
+lodash@4.17.15:
+  version "4.17.15"
+  resolved "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz#b447f6670a0455bbfeedd11392eff330ea097548"
+  integrity sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A==
+
+lodash@4.x, lodash@^4.17.12, lodash@^4.17.15, lodash@^4.17.19, lodash@^4.17.20, lodash@^4.17.21, lodash@^4.5.1, lodash@^4.7.0:
   version "4.17.21"
   resolved "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c"
   integrity sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==
 
+lodash@^3.3.1:
+  version "3.10.1"
+  resolved "https://registry.npmjs.org/lodash/-/lodash-3.10.1.tgz#5bf45e8e49ba4189e17d482789dfd15bd140b7b6"
+  integrity sha1-W/Rejkm6QYnhfUgnid/RW9FAt7Y=
+
 log-update@^1.0.2:
   version "1.0.2"
   resolved "https://registry.npmjs.org/log-update/-/log-update-1.0.2.tgz#19929f64c4093d2d2e7075a1dad8af59c296b8d1"

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@`
`36`	`36`	`}`
`37`	`37`	`},`
`38`	`38`	`"dependencies": {`
	`39`	`+ "@commitlint/ensure": "^13.2.0",`
`39`	`40`	`"@commitlint/load": "^13.2.1",`
`40`	`41`	`"@commitlint/types": "^13.2.0",`
`41`	`42`	`"chalk": "^4.1.0",`
`@@ -47,6 +48,7 @@`
`47`	`48`	`"inquirer": "^8.0.0"`
`48`	`49`	`},`
`49`	`50`	`"devDependencies": {`
`50`		`- "@types/inquirer": "^8.0.0"`
	`51`	`+ "@types/inquirer": "^8.0.0",`
	`52`	`+ "commitizen": "^4.2.4"`
`51`	`53`	`}`
`52`	`54`	`}`