docs(no-restricted-syntax): require access modifiers example

gajus · Jun 25, 2023 · 1008047 · 1008047
1 parent 42a97c8
commit 1008047
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/docs/rules/no-restricted-syntax.md b/docs/rules/no-restricted-syntax.md
@@ -373,5 +373,11 @@ class Test {
   abstract Test(): void;
 }
 // "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock:not(*:has(JsdocTag[tag=/returns/]))","context":"TSEmptyBodyFunctionExpression[returnType.typeAnnotation.type!=/TSVoidKeyword|TSUndefinedKeyword/]","message":"methods with non-void return types must have a @returns tag"}]}]
+
+/**
+ * @private
+ */
+function quux () {}
+// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock:not(JsdocBlock:has(JsdocTag[tag=/private|protected|public/]))","context":"any","message":"Access modifier tags must be present"}]}]
 ````
 
diff --git a/test/rules/assertions/noRestrictedSyntax.js b/test/rules/assertions/noRestrictedSyntax.js
@@ -1042,5 +1042,24 @@ export default {
       ],
       parser: require.resolve('@typescript-eslint/parser'),
     },
+    {
+      code: `
+        /**
+         * @private
+         */
+        function quux () {}
+      `,
+      options: [
+        {
+          contexts: [
+            {
+              comment: 'JsdocBlock:not(JsdocBlock:has(JsdocTag[tag=/private|protected|public/]))',
+              context: 'any',
+              message: 'Access modifier tags must be present',
+            },
+          ],
+        },
+      ],
+    },
   ],
 };