docs(require-jsdoc); add decorator example per gajus#662

brettz9 · Jan 3, 2021 · a4d48ba · a4d48ba
1 parent 19f68a0
commit a4d48ba
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -10281,6 +10281,13 @@ export interface Foo {
 }
 // Options: [{"contexts":["TSPropertySignature","TSMethodSignature"],"publicOnly":true}]
 // Message: Missing JSDoc comment.
+
+export class User {
+  @Input()
+  public name: string;
+}
+// Options: [{"contexts":["ClassProperty:has(Decorator[expression.callee.name=\"Input\"])"]}]
+// Message: Missing JSDoc comment.
 ````
 
 The following patterns are not considered problems:

diff --git a/test/rules/assertions/requireJsdoc.js b/test/rules/assertions/requireJsdoc.js
@@ -2694,6 +2694,35 @@ export default {
         sourceType: 'module',
       },
     },
+    {
+      code: `
+      export class User {
+        @Input()
+        public name: string;
+      }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Missing JSDoc comment.',
+        },
+      ],
+      options: [{
+        contexts: [
+          'ClassProperty:has(Decorator[expression.callee.name="Input"])',
+        ],
+      }],
+      output: `
+      export class User {
+        /**
+         *
+         */
+        @Input()
+        public name: string;
+      }
+      `,
+      parser: require.resolve('@typescript-eslint/parser'),
+    },
   ],
   valid: [{
     code: `