eslint-plugin-crisp 1.5.13 → 1.6.1

package/tests/rules/import-group-comment.test.js

@@ -0,0 +1,88 @@
+import rule from "../../rules/import-group-comment.js";
+import createRuleTester from "../rule-tester.js";
+
+const ruleTester = createRuleTester();
+
+ruleTester.run("import-group-comment", rule, {
+  valid: [
+    {
+      filename: "/project/src/example.js",
+      code: "// NPM\nimport lodash from \"lodash\";"
+    },
+    {
+      filename: "/project/src/components/example.js",
+      code: "// PROJECT: COMPONENTS\nimport Button from \"./Button.js\";"
+    },
+    {
+      filename: "/project/src/example.js",
+      code: "// PROJECT: HELPERS\n// @ts-ignore\nimport helper from \"@/helpers/helper.js\";"
+    },
+    {
+      filename: "/project/src/example.js",
+      options: [{ "^virtual:": "GENERATED" }],
+      code: "// PROJECT: GENERATED\nimport value from \"virtual:value\";"
+    },
+    {
+      filename: "/project/src/Component.vue",
+      code: "// TYPES\n/** @typedef {string} Identifier */"
+    },
+    {
+      code: "// PROJECT: MAIN\nimport value from \"./value.js\";"
+    },
+    {
+      code: "// NPM\nimport value from \"package\";",
+      options: [{ "[": "INVALID" }]
+    }
+  ],
+
+  invalid: [
+    {
+      filename: "/project/src/example.js",
+      code: "// PROJECT: HELPERS\nimport lodash from \"lodash\";",
+      errors: [
+        {
+          message: "Import \"lodash\" should be in the \"NPM\" group."
+        }
+      ]
+    },
+    {
+      filename: "/project/src/example.js",
+      code: "// NPM\n\nimport lodash from \"lodash\";",
+      output: "// NPM\nimport lodash from \"lodash\";",
+      errors: [
+        {
+          message: "Import group comment must be immediately followed by an import (no blank line)."
+        }
+      ]
+    },
+    {
+      filename: "/project/src/example.js",
+      options: [{ "^virtual:": "GENERATED" }],
+      code: "// NPM\nimport value from \"virtual:value\";",
+      errors: [
+        {
+          message: "Import \"virtual:value\" should be in the \"PROJECT: GENERATED\" group."
+        }
+      ]
+    },
+    {
+      filename: "/project/src/Component.vue",
+      code: "/** @typedef {string} Identifier */",
+      errors: [
+        {
+          message: "Type comments group must be preceded by a '// TYPES' comment"
+        }
+      ]
+    },
+    {
+      filename: "/project/src/Component.vue",
+      code: "// TYPES\n\n/** @typedef {string} Identifier */",
+      output: "// TYPES\n/** @typedef {string} Identifier */",
+      errors: [
+        {
+          message: "Type group comment must be immediately followed by a type comment (no blank line)."
+        }
+      ]
+    }
+  ]
+});

package/tests/rules/import-group-order.test.js

@@ -0,0 +1,58 @@
+import rule from "../../rules/import-group-order.js";
+import createRuleTester from "../rule-tester.js";
+
+const ruleTester = createRuleTester();
+
+ruleTester.run("import-group-order", rule, {
+  valid: [
+    {
+      code: [
+        "// NPM",
+        "import lodash from \"lodash\";",
+        "// PROJECT: COMPONENTS",
+        "import Button from \"@/components/Button.js\";",
+        "// PROJECT: HELPERS",
+        "import helper from \"@/helpers/helper.js\";",
+        "// TYPES",
+        "import \"./types.js\";"
+      ].join("\n")
+    },
+    {
+      code: "// PROJECT: UNKNOWN\nimport value from \"./value.js\";"
+    },
+    {
+      code: "import first from \"first\";\nimport second from \"second\";"
+    }
+  ],
+
+  invalid: [
+    {
+      code: [
+        "// PROJECT: HELPERS",
+        "import helper from \"@/helpers/helper.js\";",
+        "// NPM",
+        "import lodash from \"lodash\";"
+      ].join("\n"),
+      errors: [
+        {
+          message: "Import group 'NPM' should be before 'PROJECT: HELPERS' group."
+        }
+      ]
+    },
+    {
+      code: [
+        "// NPM",
+        "import lodash from \"lodash\";",
+        "// TYPES",
+        "import \"./types.js\";",
+        "// PROJECT: COMPONENTS",
+        "import Button from \"@/components/Button.js\";"
+      ].join("\n"),
+      errors: [
+        {
+          message: "Import group 'PROJECT: COMPONENTS' should be after 'NPM' group."
+        }
+      ]
+    }
+  ]
+});

package/tests/rules/jsdoc-align-params.test.js

@@ -0,0 +1,32 @@
+import rule from "../../rules/jsdoc-align-params.js";
+import createRuleTester, { withoutFixes } from "../rule-tester.js";
+
+const ruleTester = createRuleTester();
+
+ruleTester.run("jsdoc-align-params", withoutFixes(rule), {
+  valid: [
+    "/**\n * Fetch a value.\n * @public\n * @param  {string} value\n * @return {string} Result.\n */\nfunction fetchValue(value) { return value; }",
+    "/**\n * Produce values.\n * @protected\n * @internal\n * @generator\n * @param  {number} count\n * @yields {number} Next value.\n */\nfunction* values(count) { yield count; }",
+    "/** A compact comment. */\nconst value = 1;",
+    "/**\n * Missing scope is ignored.\n * @param {string} value\n */\nfunction ignored(value) { return value; }"
+  ],
+
+  invalid: [
+    {
+      code: "/**\n * Fetch a value.\n * @public\n * @param {string} value\n * @return {string} Result.\n */\nfunction fetchValue(value) { return value; }",
+      errors: [
+        {
+          message: "JSDoc alignment issue"
+        }
+      ]
+    },
+    {
+      code: "/**\n * Produce values.\n * @private\n * @generator\n * @param {number} count\n * @yields {number} Next value.\n */\nfunction* values(count) { yield count; }",
+      errors: [
+        {
+          message: "JSDoc alignment issue"
+        }
+      ]
+    }
+  ]
+});

package/tests/rules/jsdoc-check-indentation.test.js

@@ -0,0 +1,45 @@
+import rule from "../../rules/jsdoc-check-indentation.js";
+import createRuleTester from "../rule-tester.js";
+
+const ruleTester = createRuleTester();
+
+ruleTester.run("jsdoc-check-indentation", rule, {
+  valid: [
+    "/**\n * A description.\n * @returns {boolean} The result.\n */\nfunction check() { return true; }",
+    "/**\n * ```js\n *  const indented = true;\n * ```\n */\nfunction example() {}",
+    "/**\n * @example\n *  const indented = true;\n */\nfunction example() {}",
+    {
+      code: "/**\n * @custom\n *  deliberately indented\n */\nfunction example() {}",
+      options: [
+        {
+          excludeTags: ["custom"]
+        }
+      ]
+    },
+    "/**\n * A continued line \\\n *   remains part of the description.\n */\nfunction example() {}"
+  ],
+
+  invalid: [
+    {
+      code: "/**\n *  Unexpected indentation.\n */\nfunction example() {}",
+      errors: [
+        {
+          message: "There must be no indentation."
+        }
+      ]
+    },
+    {
+      code: "/**\n * @example\n *  const indented = true;\n */\nfunction example() {}",
+      options: [
+        {
+          excludeTags: []
+        }
+      ],
+      errors: [
+        {
+          message: "There must be no indentation."
+        }
+      ]
+    }
+  ]
+});

package/tests/rules/jsdoc-check-optional-params.test.js

@@ -0,0 +1,40 @@
+import rule from "../../rules/jsdoc-check-optional-params.js";
+import createRuleTester from "../rule-tester.js";
+
+const ruleTester = createRuleTester();
+
+ruleTester.run("jsdoc-check-optional-params", rule, {
+  valid: [
+    "/** @param {string} value */\nfunction required(value) {}",
+    "/** @param {string} [value] */\nfunction optional(value = \"default\") {}",
+    "/** @param {number} [count=1] */\nconst optional = function(count = 1) {};",
+    "function undocumented(value) {}"
+  ],
+
+  invalid: [
+    {
+      code: "/** @param {string} value */\nfunction optional(value = \"default\") {}",
+      errors: [
+        {
+          message: "Optional parameters in JSDoc should be surrounded by brackets"
+        }
+      ]
+    },
+    {
+      code: "/** @param {string} [value] */\nfunction required(value) {}",
+      errors: [
+        {
+          message: "Non-optional parameters in JSDoc should not be surrounded by brackets"
+        }
+      ]
+    },
+    {
+      code: "/** @param {Object} options */\nfunction configure({ enabled }) {}",
+      errors: [
+        {
+          message: "No matching JSDoc param found"
+        }
+      ]
+    }
+  ]
+});

package/tests/rules/jsdoc-description-length.test.js

@@ -0,0 +1,60 @@
+import rule from "../../rules/jsdoc-description-length.js";
+import createRuleTester from "../rule-tester.js";
+
+const ruleTester = createRuleTester();
+
+ruleTester.run("jsdoc-description-length", rule, {
+  valid: [
+    "/**\n * A single-line description.\n */\nfunction example() {}",
+    "/**\n * A description that continues \\\n *   on the next line.\n * @returns {boolean} The result.\n */\nfunction example() { return true; }",
+    {
+      code: "/**\n * First line \\\n *   second line \\\n *   third line.\n */\nfunction example() {}",
+      options: [
+        {
+          maxLines: 3
+        }
+      ]
+    },
+    "/********************\n * Section header\n ********************/\nconst value = true;"
+  ],
+
+  invalid: [
+    {
+      code: "/**\n * First line \\\n *   second line \\\n *   third line.\n */\nfunction example() {}",
+      errors: [
+        {
+          message: "JSDoc description must not exceed 2 line(s)."
+        }
+      ]
+    },
+    {
+      code: "/**\n * First line\n *   second line.\n */\nfunction example() {}",
+      errors: [
+        {
+          message: "Multi-line JSDoc description must end with '\\' before each continuation."
+        }
+      ]
+    },
+    {
+      code: "/**\n * First line \\\n * second line.\n */\nfunction example() {}",
+      errors: [
+        {
+          message: "Continuation lines in JSDoc description must be indented with 3 spaces after '*'."
+        }
+      ]
+    },
+    {
+      code: "/**\n * First line \\\n *   second line.\n */\nfunction example() {}",
+      options: [
+        {
+          maxLines: 1
+        }
+      ],
+      errors: [
+        {
+          message: "JSDoc description must not exceed 1 line(s)."
+        }
+      ]
+    }
+  ]
+});

package/tests/rules/jsdoc-description-multiline.test.js

@@ -0,0 +1,34 @@
+import rule from "../../rules/jsdoc-description-multiline.js";
+import createRuleTester from "../rule-tester.js";
+
+const ruleTester = createRuleTester();
+
+ruleTester.run("jsdoc-description-multiline", rule, {
+  valid: [
+    "/**\n * A multiline description.\n */\nfunction example() {}",
+    "/** */\nfunction empty() {}",
+    "/** @public */\nfunction tagged() {}",
+    "/**\n * @returns {boolean} The result.\n */\nfunction tagged() { return true; }"
+  ],
+
+  invalid: [
+    {
+      code: "/** A compact description. */\nfunction example() {}",
+      output: "/**\n * A compact description.\n */\nfunction example() {}",
+      errors: [
+        {
+          message: "Function JSDoc descriptions must use multiline formatting."
+        }
+      ]
+    },
+    {
+      code: "function outer() {\n  /** An indented description. */\n  function inner() {}\n}",
+      output: "function outer() {\n  /**\n   * An indented description.\n   */\n  function inner() {}\n}",
+      errors: [
+        {
+          message: "Function JSDoc descriptions must use multiline formatting."
+        }
+      ]
+    }
+  ]
+});

package/tests/rules/jsdoc-enforce-access.test.js

@@ -0,0 +1,66 @@
+import rule from "../../rules/jsdoc-enforce-access.js";
+import createRuleTester from "../rule-tester.js";
+
+const ruleTester = createRuleTester();
+
+ruleTester.run("jsdoc-enforce-access", rule, {
+  valid: [
+    "/** @public */\nfunction publicFunction() {}",
+    "class Example {\n  /** @protected */\n  method() {}\n}",
+    "const object = {\n  /** @private */\n  method: () => {}\n};",
+    "/** @internal */\nconst internal = function() {};",
+    "/** @public */\n// Additional context.\nfunction documented() {}",
+    "function undocumented() {}"
+  ],
+
+  invalid: [
+    {
+      code: "/** A function. */\nfunction example() {}",
+      errors: [
+        {
+          message: "JSDoc comment should contain @public, @protected, @private or @internal"
+        }
+      ]
+    },
+    {
+      code: "class Example {\n  /** A method. */\n  method() {}\n}",
+      errors: [
+        {
+          message: "JSDoc comment should contain @public, @protected, @private or @internal"
+        }
+      ]
+    },
+    {
+      code: "const object = {\n  /** A property method. */\n  method: () => {}\n};",
+      errors: [
+        {
+          message: "JSDoc comment should contain @public, @protected, @private or @internal"
+        }
+      ]
+    },
+    {
+      code: "const expression = /** A function expression. */ function() {};",
+      errors: [
+        {
+          message: "JSDoc comment should contain @public, @protected, @private or @internal"
+        }
+      ]
+    },
+    {
+      code: "/** @publicity */\nfunction example() {}",
+      errors: [
+        {
+          message: "JSDoc comment should contain @public, @protected, @private or @internal"
+        }
+      ]
+    },
+    {
+      code: "/** A function. */\n// Additional context.\nfunction example() {}",
+      errors: [
+        {
+          message: "JSDoc comment should contain @public, @protected, @private or @internal"
+        }
+      ]
+    }
+  ]
+});

package/tests/rules/jsdoc-enforce-classdesc.test.js

@@ -0,0 +1,39 @@
+import rule from "../../rules/jsdoc-enforce-classdesc.js";
+import createRuleTester from "../rule-tester.js";
+
+const ruleTester = createRuleTester();
+
+ruleTester.run("jsdoc-enforce-classdesc", rule, {
+  valid: [
+    "/**\n * @classdesc Represents an example.\n */\nclass Example {}",
+    "class Undocumented {}",
+    "/** A factory function. */\nfunction createExample() {}"
+  ],
+
+  invalid: [
+    {
+      code: "/** Represents an example. */\nclass Example {}",
+      errors: [
+        {
+          message: "JSDoc class header should include @classdesc"
+        }
+      ]
+    },
+    {
+      code: "/**\n * @classdesc\n */\nclass Example {}",
+      errors: [
+        {
+          message: "The @classdesc tag in JSDoc class header should have a non-empty description"
+        }
+      ]
+    },
+    {
+      code: "/**\n * @classdesc   \n */\nclass Example {}",
+      errors: [
+        {
+          message: "The @classdesc tag in JSDoc class header should have a non-empty description"
+        }
+      ]
+    }
+  ]
+});

package/tests/rules/jsdoc-no-param-return.test.js

@@ -0,0 +1,47 @@
+import rule from "../../rules/jsdoc-no-param-return.js";
+import createRuleTester, { withoutFixes } from "../rule-tester.js";
+
+const ruleTester = createRuleTester();
+
+ruleTester.run("jsdoc-no-param-return", withoutFixes(rule), {
+  valid: [
+    "/**\n * Describe a function without signature tags.\n * @public\n */\nfunction example(value) { return value; }",
+    "/**\n * @property {string} value A property.\n * @type {Object}\n */\nconst object = {};",
+    "// @param is ordinary line-comment text.\nfunction example(value) {}"
+  ],
+
+  invalid: [
+    {
+      code: "/**\n * @param {string} value A value.\n */\nfunction example(value) {}",
+      errors: [
+        {
+          message: "@param and @return tags are not permitted in JSDoc, rely on the TypeScript signature instead."
+        }
+      ]
+    },
+    {
+      code: "/**\n * @arg {string} value A value.\n * @argument {number} count A count.\n */\nfunction example(value, count) {}",
+      errors: [
+        {
+          message: "@param and @return tags are not permitted in JSDoc, rely on the TypeScript signature instead."
+        }
+      ]
+    },
+    {
+      code: "/**\n * @return {string} A value.\n * @returns {string} Another value.\n */\nfunction example() { return \"value\"; }",
+      errors: [
+        {
+          message: "@param and @return tags are not permitted in JSDoc, rely on the TypeScript signature instead."
+        }
+      ]
+    },
+    {
+      code: "/**\n * @yield {number} A value.\n * @yields {number} Another value.\n */\nfunction* example() { yield 1; }",
+      errors: [
+        {
+          message: "@param and @return tags are not permitted in JSDoc, rely on the TypeScript signature instead."
+        }
+      ]
+    }
+  ]
+});

package/tests/rules/jsdoc-require-description-uppercase.test.js

@@ -0,0 +1,52 @@
+import rule from "../../rules/jsdoc-require-description-uppercase.js";
+import createRuleTester from "../rule-tester.js";
+
+const ruleTester = createRuleTester();
+
+ruleTester.run("jsdoc-require-description-uppercase", rule, {
+  valid: [
+    "/**\n * Starts with an uppercase character.\n */\nfunction example() {}",
+    "/**\n * # heading ignored\n * Description below the heading.\n */\nfunction example() {}",
+    "/**\n * | column | value |\n * | --- | --- |\n */\nconst table = true;",
+    "/**\n * @param {string} value Uppercase parameter description.\n * @returns {boolean} Uppercase return description.\n * @throws {Error} Uppercase error description.\n */\nfunction example(value) { return Boolean(value); }"
+  ],
+
+  invalid: [
+    {
+      code: "/**\n * lowercase description.\n */\nfunction example() {}",
+      output: "/**\n * Lowercase description.\n */\nfunction example() {}",
+      errors: [
+        {
+          message: "Sentences should start with an uppercase character."
+        }
+      ]
+    },
+    {
+      code: "/**\n * @param {string} value lowercase parameter description.\n */\nfunction example(value) {}",
+      output: "/**\n * @param {string} value Lowercase parameter description.\n */\nfunction example(value) {}",
+      errors: [
+        {
+          message: "Sentences should start with an uppercase character."
+        }
+      ]
+    },
+    {
+      code: "/**\n * @returns {boolean} lowercase return description.\n */\nfunction example() { return true; }",
+      output: "/**\n * @returns {boolean} Lowercase return description.\n */\nfunction example() { return true; }",
+      errors: [
+        {
+          message: "Sentences should start with an uppercase character."
+        }
+      ]
+    },
+    {
+      code: "/**\n * @classdesc lowercase class description.\n */\nclass Example {}",
+      output: "/**\n * @classdesc Lowercase class description.\n */\nclass Example {}",
+      errors: [
+        {
+          message: "Sentences should start with an uppercase character."
+        }
+      ]
+    }
+  ]
+});

package/tests/rules/methods-naming.test.js

@@ -0,0 +1,70 @@
+import rule from "../../rules/methods-naming.js";
+import createRuleTester from "../rule-tester.js";
+
+const ruleTester = createRuleTester();
+
+ruleTester.run("methods-naming", rule, {
+  valid: [
+    {
+      code: `class Service {
+        /** @public */
+        start() {}
+
+        /** @protected */
+        _refresh() {}
+
+        /** @private */
+        __reset() {}
+      }`
+    },
+    {
+      code: `class Service {
+        undocumented() {}
+
+        /** A method without a visibility tag. */
+        documented() {}
+      }`
+    },
+    {
+      code: `class Service {
+        /** @private */
+        ["computed"]() {}
+      }`
+    }
+  ],
+
+  invalid: [
+    {
+      code: "class Service {\n  /** @public */\n  __reset() {}\n}",
+      errors: [
+        {
+          message: "Methods starting with '__' should not be marked with '@public'."
+        }
+      ]
+    },
+    {
+      code: "class Service {\n  /** @public */\n  _refresh() {}\n}",
+      errors: [
+        {
+          message: "Methods starting with '_' should not be marked with '@public'."
+        }
+      ]
+    },
+    {
+      code: "class Service {\n  /** @private */\n  reset() {}\n}",
+      errors: [
+        {
+          message: "Methods not starting with '__' should not be marked with '@private'."
+        }
+      ]
+    },
+    {
+      code: "class Service {\n  /** @protected */\n  refresh() {}\n}",
+      errors: [
+        {
+          message: "Methods not starting with '_' should not be marked with '@protected'."
+        }
+      ]
+    }
+  ]
+});