feat(prefer-lowercase-title): introduce lowercaseFirstCharacterOnly o…

…ption (#190)
veritem · May 23, 2023 · a234637 · a234637
1 parent d7c1266
commit a234637
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 8 deletions.
diff --git a/docs/rules/prefer-lowercase-title.md b/docs/rules/prefer-lowercase-title.md
@@ -11,7 +11,7 @@
 Examples of **incorrect** code for this rule:
 
 ```js
-test('IT WORKS', () => {
+test('It works', () => {
 	// ...
 })
 ```
@@ -52,6 +52,10 @@ test('it works', () => {
       "ignoreTopLevelDescribe":{
          "type":"boolean",
          "default":false
+      },
+      "lowercaseFirstCharacterOnly":{
+         "type":"boolean",
+         "default":true
       }
    },
    "additionalProperties":false

diff --git a/src/rules/prefer-lowercase-title.test.ts b/src/rules/prefer-lowercase-title.test.ts
@@ -41,6 +41,21 @@ describe(RULE_NAME, () => {
 							}
 						}
 					]
+				},
+				{
+					code: 'test(`SFC Compile`, function () {})',
+					output: 'test(`sfc compile`, function () {})',
+					errors: [
+						{
+							messageId: 'lowerCaseTitle',
+							data: {
+								method: TestCaseName.test
+							}
+						}
+					],
+					options: [{
+						lowercaseFirstCharacterOnly: false
+					}]
 				}
 			]
 		})

diff --git a/src/rules/prefer-lowercase-title.ts b/src/rules/prefer-lowercase-title.ts
@@ -41,6 +41,7 @@ export default createEslintRule<[
 		ignore: string[];
 		allowedPrefixes: string[];
 		ignoreTopLevelDescribe: boolean;
+		lowercaseFirstCharacterOnly: boolean;
 	}>
 ], MessageIds>({
 	name: RULE_NAME,
@@ -77,16 +78,20 @@ export default createEslintRule<[
 					ignoreTopLevelDescribe: {
 						type: 'boolean',
 						default: false
+					},
+					lowercaseFirstCharacterOnly: {
+						type: 'boolean',
+						default: true
 					}
 				},
 				additionalProperties: false
 			}
 		]
 	},
 	defaultOptions: [
-		{ ignore: [], allowedPrefixes: [], ignoreTopLevelDescribe: false }
+		{ ignore: [], allowedPrefixes: [], ignoreTopLevelDescribe: false, lowercaseFirstCharacterOnly: true }
 	],
-	create: (context, [{ ignore = [], allowedPrefixes = [], ignoreTopLevelDescribe = [] }]) => {
+	create: (context, [{ ignore = [], allowedPrefixes = [], ignoreTopLevelDescribe = false, lowercaseFirstCharacterOnly = false }]) => {
 		const ignores = populateIgnores(ignore)
 		let numberOfDescribeBlocks = 0
 
@@ -117,10 +122,11 @@ export default createEslintRule<[
 
 				const firstCharacter = description.charAt(0)
 
-				if (!firstCharacter ||
-					firstCharacter === firstCharacter.toLowerCase() ||
-					ignores.includes(vitestFnCall.name as IgnorableFunctionExpressions))
-					return
+				if (
+					ignores.includes(vitestFnCall.name as IgnorableFunctionExpressions) ||
+					(lowercaseFirstCharacterOnly && (!firstCharacter || firstCharacter === firstCharacter.toLowerCase())) ||
+					(!lowercaseFirstCharacterOnly && description === description.toLowerCase())
+				)	return
 
 				context.report({
 					messageId: 'lowerCaseTitle',
@@ -138,7 +144,9 @@ export default createEslintRule<[
 							firstArgument.range[1] - 1
 						]
 
-						const newDescription = description.substring(0, 1).toLowerCase() + description.substring(1)
+						const newDescription = lowercaseFirstCharacterOnly
+							? description.substring(0, 1).toLowerCase() + description.substring(1)
+							: description.toLowerCase()
 
 						return [fixer.replaceTextRange(rangeIgnoreQuotes, newDescription)]
 					}