Add test file

nuxt · Apr 20, 2024 · 5b4eca1 · 5b4eca1
1 parent 0f404f8
commit 5b4eca1
Show file tree

Hide file tree

Showing 4 changed files with 80 additions and 1 deletion.
diff --git a/packages/eslint-plugin/package.json b/packages/eslint-plugin/package.json
@@ -33,5 +33,8 @@
   "dependencies": {
     "@typescript-eslint/types": "^7.7.0",
     "@typescript-eslint/utils": "^7.7.0"
+  },
+  "devDependencies": {
+    "@typescript-eslint/rule-tester": "^7.7.0"
   }
 }
diff --git a/packages/eslint-plugin/src/rules/require-jsdoc-since/index.ts b/packages/eslint-plugin/src/rules/require-jsdoc-since/index.ts
@@ -28,7 +28,7 @@ export const rule = createRule<MessageIds, Options>({
         const declarationType = exportNode.declaration?.type
         if (declarationType === 'TSInterfaceDeclaration' || declarationType === 'TSTypeAliasDeclaration') return
 
-        // TODO: Check if it's an override, and the function above has a valid JSDoc
+        // TODO: Check if it's an overload, and the function above has a valid JSDoc
 
         // Check if the exported node has a leading comment
         const leadingComments = context.sourceCode.getCommentsBefore(exportNode)

diff --git a/packages/eslint-plugin/tests/require-since.test.ts b/packages/eslint-plugin/tests/require-since.test.ts
@@ -0,0 +1,52 @@
+import { RuleTester } from '@typescript-eslint/rule-tester'
+import { rule } from '../src/rules/require-jsdoc-since'
+
+const ruleTester = new RuleTester({
+  parser: '@typescript-eslint/parser',
+})
+
+ruleTester.run('require-since', rule, {
+  valid: [
+    {
+      code: `
+        /** @since 1.0.0 */
+        function foo() {}
+    `,
+    },
+    {
+      code: `
+        /**
+         * @since 1.0.0
+        */
+        function foo() {}
+    `,
+    // TODO: Check overloads
+    },
+    {
+      code: `
+        /**
+         * This is a comment.
+         * @param {string} foo - This is a foo.
+         * @since 1.0.0
+         */
+        function foo(bar) {}
+        `,
+    },
+  ],
+  invalid: [
+    {
+      code: `
+        /**
+         * This is a comment.
+         * @param {string} foo - This is a foo.
+         */
+        function foo(bar) {}
+        `,
+      errors: [{ messageId: 'missing' }],
+    },
+    {
+      code: `function foo() {}`,
+      errors: [{ messageId: 'missing' }],
+    },
+  ],
+})
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml