eslint-plugin-crisp 1.5.0 → 1.5.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-crisp",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "description": "Custom ESLint Rules for Crisp",
   "author": "Crisp IM SAS",
   "main": "index.js",

package/recommended-vue.js

@@ -236,6 +236,7 @@ export default function configRecommendedVue(pluginCrisp) {
                   "private",
                   "protected",
                   "public",
+                  "internal",
 
                   "class",
 

package/recommended.js

@@ -216,6 +216,7 @@ export default function configRecommended(pluginCrisp) {
                   "private",
                   "protected",
                   "public",
+                  "internal",
 
                   "class",
                   "classdesc",

package/rules/jsdoc-align-params.js

@@ -1,4 +1,5 @@
 const SCOPE_REGEX = /^\s*\*\s*@(public|private|protected)/;
+const INTERNAL_REGEX = /^\s*\*\s*@internal/;
 const GENERATOR_REGEX = /^\s*\*\s*@generator/;
 const CLASS_REGEX = /^\s*\*\s*@class\b/;
 const CLASSDESC_REGEX = /^\s*\*\s*@classdesc\s*(.*)/;
@@ -15,6 +16,7 @@ function parseJSDoc(jsdoc) {
   let classDescription = "";
   let description = "";
   let scope = "";
+  let internal = false;
   let generator = false;
 
   for (let i = 1; i < lines.length; i++) {
@@ -33,6 +35,7 @@ function parseJSDoc(jsdoc) {
     // If the line matches any of the other regexes, break out of the loop
     if (
       line.match(SCOPE_REGEX) ||
+      line.match(INTERNAL_REGEX) ||
       line.match(PARAM_REGEX) ||
       line.match(RETURN_REGEX) ||
       line.match(YIELD_REGEX)
@@ -88,13 +91,19 @@ function parseJSDoc(jsdoc) {
       scope = scopeMatch[1];
     }
 
+    if (line.match(INTERNAL_REGEX)) {
+      internal = true;
+    }
+
     const generatorMatch = line.match(GENERATOR_REGEX);
     if (generatorMatch) {
       generator = true;
     }
   }
 
-  return { description, scope, params, returnLine, yieldLine, generator };
+  return {
+    description, scope, internal, params, returnLine, yieldLine, generator
+  };
 }
 
 function formatJSDoc(parsedJSDoc, indentation=0) {
@@ -123,6 +132,10 @@ function formatJSDoc(parsedJSDoc, indentation=0) {
     jsdoc += indent + "* @" + parsedJSDoc.scope + "\n";
   }
 
+  if (parsedJSDoc.internal) {
+    jsdoc += indent + "* @internal\n";
+  }
+
   if (parsedJSDoc.generator) {
     jsdoc += indent + "* @generator\n";
   }

package/rules/jsdoc-enforce-access.js

@@ -1,11 +1,11 @@
 // Pre-compiled regex for access modifier check
-const ACCESS_MODIFIER_PATTERN = /@(public|protected|private)/;
+const ACCESS_MODIFIER_PATTERN = /@(public|protected|private|internal)/;
 
 export default {
   meta: {
     type: "problem",
     docs: {
-      description: "Enforce usage of @public, @private, or @protected in JSDoc",
+      description: "Enforce usage of an access modifier in JSDoc",
       category: "Possible Errors",
       recommended: true,
     },
@@ -24,7 +24,7 @@ export default {
           if (!ACCESS_MODIFIER_PATTERN.test(lastComment.value)) {
             context.report({
               node,
-              message: "JSDoc comment should contain @public, @protected or @private",
+              message: "JSDoc comment should contain @public, @protected, @private or @internal",
             });
           }
         }