feat: allow passing arguments as title (#187)

* feat: allow passing arguments as title * docs * chore: downgrade node types * Revert "chore: downgrade node types" This reverts commit fdc4954.
veritem · May 22, 2023 · 6d6e797 · 6d6e797
1 parent ea17f67
commit 6d6e797
Show file tree

Hide file tree

Showing 4 changed files with 86 additions and 18 deletions.
diff --git a/docs/rules/valid-title.md b/docs/rules/valid-title.md
@@ -19,7 +19,8 @@ This rule has an object option:
   "vitest/valid-title": [
 	"error",
    { 
-	"ignoreTypeOfDescribeName": false, 
+	"ignoreTypeOfDescribeName": false,
+  "allowArguments": false,
 	"disallowedWords": ["skip", "only"],
 	"mustNotMatch": ["^\\s+$", "^\\s*\\d+\\s*$"],
 	"mustMatch": ["^\\s*\\w+\\s*$"]
@@ -52,6 +53,22 @@ describe('1', () => {
 })
 ```
 
+### `allowArguments`
+
+If `true`, the rule ignores the arguments of `describe` function.
+
+Examples of **correct** code for this rule with the `{ "allowArguments": false }` option:
+
+```js
+describe('name', () => {})
+```
+
+Examples of **correct** code for this rule with the `{ "allowArguments": true }` option:
+
+```js
+describe(foo, () => {})
+```
+
 ### `disallowedWords`
 
 An array of words that are not allowed in the test title.

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/rules/valid-title.test.ts b/src/rules/valid-title.test.ts
@@ -99,6 +99,51 @@ describe(RULE_NAME, () => {
 		})
 	})
 
+	it(`${RULE_NAME} - support passing an argument as title`, () => {
+		ruleTester.run(RULE_NAME, rule, {
+			valid: [
+				{
+					code: 'it(foo, () => {});',
+					options: [
+						{
+							allowArguments: true
+						}
+					]
+				},
+				{
+					code: 'describe(bar, () => {});',
+					options: [
+						{
+							allowArguments: true
+						}
+					]
+				},
+				{
+					code: 'test(baz, () => {});',
+					options: [
+						{
+							allowArguments: true
+						}
+					]
+				}
+			],
+			invalid: [
+				{
+					code: 'test(bar, () => {});',
+					options: [{ allowArguments: false }],
+					errors: [
+						{
+							messageId: 'titleMustBeString',
+							data: { word: 'correct' },
+							column: 6,
+							line: 1
+						}
+					]
+				}
+			]
+		})
+	})
+
 	it(`${RULE_NAME} - mustMatch & mustNotMatch options`, () => {
 		ruleTester.run(RULE_NAME, rule, {
 			valid: [

diff --git a/src/rules/valid-title.ts b/src/rules/valid-title.ts
@@ -39,6 +39,7 @@ const MatcherAndMessageSchema: JSONSchema.JSONSchema7 = {
 
 type Options = {
 	ignoreTypeOfDescribeName?: boolean;
+	allowArguments?: boolean;
 	disallowedWords?: string[];
 	mustNotMatch?:
 	| Partial<Record<MatcherGroups, string | MatcherAndMessage>>
@@ -119,6 +120,10 @@ export default createEslintRule<Options, MESSAGE_IDS>({
 						type: 'boolean',
 						default: false
 					},
+					allowArguments: {
+						type: 'boolean',
+						default: false
+					},
 					disallowedWords: {
 						type: 'array',
 						items: { type: 'string' }
@@ -144,10 +149,11 @@ export default createEslintRule<Options, MESSAGE_IDS>({
 		],
 		fixable: 'code'
 	},
-	defaultOptions: [{ ignoreTypeOfDescribeName: false, disallowedWords: [] }],
+	defaultOptions: [{ ignoreTypeOfDescribeName: false, allowArguments: false, disallowedWords: [] }],
 	create(context, [
 		{
 			ignoreTypeOfDescribeName,
+			allowArguments,
 			disallowedWords = [],
 			mustNotMatch,
 			mustMatch
@@ -166,7 +172,7 @@ export default createEslintRule<Options, MESSAGE_IDS>({
 
 				const [argument] = node.arguments
 
-				if (!argument) return
+				if (!argument || (allowArguments && argument.type === AST_NODE_TYPES.Identifier)) return
 
 				if (!isStringNode(argument)) {
 					if (argument.type === AST_NODE_TYPES.BinaryExpression &&