eslint-plugin-crisp 1.0.68 → 1.0.70

package/README.md

@@ -32,100 +32,101 @@ Add the plugin in your ESLint config object, then extend the desired configurati
 This is the list of plugins and rules used by ESLint Plugin Crisp, and what they do.
 
 Each item has emojis denoting:
-* ⚪️: enabled in `plugin:crisp/recommended`
+* 🟠: enabled in `plugin:crisp/recommended`
 * 🟢: enabled in `plugin:crisp/recommended-vue`
 
 ### Configurations
 - [eslint:recommended](https://github.com/eslint/eslint) (🟢): Core ESLint rules
-- [plugin:jsdoc/recommended](https://github.com/gajus/eslint-plugin-jsdoc) (⚪️🟢): JSDoc linting rules
+- [plugin:jsdoc/recommended](https://github.com/gajus/eslint-plugin-jsdoc) (🟠🟢): JSDoc linting rules
 - [plugin:vue/vue3-recommended](https://github.com/vuejs/eslint-plugin-vue) (🟢): Vue.js 3 linting rules
 - [plugin:vue-pug/vue3-recommended](https://github.com/gajus/eslint-plugin-jsdoc) (🟢): Pug templates support for Vue.js linting rules
 
 ### Plugins
-- [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) (⚪️🟢): JSDoc linting rules for ESLint
+- [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) (🟠🟢): JSDoc linting rules for ESLint
 
 ### Rules
 
 #### General JS rules
-- [arrow-parens](https://eslint.org/docs/latest/rules/arrow-parens) (⚪️🟢): Requires parentheses around arrow function arguments
-- [brace-style](https://eslint.org/docs/latest/rules/brace-style) (⚪️🟢): Enforces one true brace style for blocks
-- [comma-dangle](https://eslint.org/docs/latest/rules/comma-dangle) (⚪️🟢): Disallows trailing commas
-- [comma-style](https://eslint.org/docs/latest/rules/comma-style) (⚪️🟢): Requires a comma after and on the same line
-- [curly](https://eslint.org/docs/latest/rules/curly) (⚪️🟢): Ensures block statements are always wrapped in curly braces
+- [arrow-parens](https://eslint.org/docs/latest/rules/arrow-parens) (🟠🟢): Requires parentheses around arrow function arguments
+- [brace-style](https://eslint.org/docs/latest/rules/brace-style) (🟠🟢): Enforces one true brace style for blocks
+- [comma-dangle](https://eslint.org/docs/latest/rules/comma-dangle) (🟠🟢): Disallows trailing commas
+- [comma-style](https://eslint.org/docs/latest/rules/comma-style) (🟠🟢): Requires a comma after and on the same line
+- [curly](https://eslint.org/docs/latest/rules/curly) (🟠🟢): Ensures block statements are always wrapped in curly braces
 - [computed-property-spacing](https://eslint.org/docs/latest/rules/computed-property-spacing) (🟢): Disallows spaces inside computed property brackets
-- [default-param-last](https://eslint.org/docs/latest/rules/default-param-last) (⚪️🟢): Enforces default parameters to be last
-- [default-case-last](https://eslint.org/docs/latest/rules/default-case-last) (⚪️🟢): Enforces default clauses in switch statements to be last
-- [dot-notation](https://eslint.org/docs/latest/rules/dot-notation) (⚪️🟢): Enforces dot notation instead of square-bracket notation
-- [eqeqeq](https://eslint.org/docs/latest/rules/eqeqeq) (⚪️🟢): Requires the use of `===` and `!==`
-- [eol-last](https://eslint.org/docs/latest/rules/eol-last) (⚪️🟢): Requires newline at the end of files
-- [indent](https://eslint.org/docs/latest/rules/indent) (⚪️🟢): Enforces 2-space indentation, and specific indentation levels for some nodes
-- [for-direction](https://eslint.org/docs/latest/rules/for-direction) (⚪️🟢): Prevents for-loops to have stop condition that can never be reached
+- [default-param-last](https://eslint.org/docs/latest/rules/default-param-last) (🟠🟢): Enforces default parameters to be last
+- [default-case-last](https://eslint.org/docs/latest/rules/default-case-last) (🟠🟢): Enforces default clauses in switch statements to be last
+- [dot-notation](https://eslint.org/docs/latest/rules/dot-notation) (🟠🟢): Enforces dot notation instead of square-bracket notation
+- [eqeqeq](https://eslint.org/docs/latest/rules/eqeqeq) (🟠🟢): Requires the use of `===` and `!==`
+- [eol-last](https://eslint.org/docs/latest/rules/eol-last) (🟠🟢): Requires newline at the end of files
+- [indent](https://eslint.org/docs/latest/rules/indent) (🟠🟢): Enforces 2-space indentation, and specific indentation levels for some nodes
+- [for-direction](https://eslint.org/docs/latest/rules/for-direction) (🟠🟢): Prevents for-loops to have stop condition that can never be reached
 - [key-spacing](https://eslint.org/docs/latest/rules/key-spacing) (🟢): Enforces consistent spacing in object literal properties (no space between the key and the colon, one space between the colon and the value)
-- [linebreak-style](https://eslint.org/docs/latest/rules/linebreak-style) (⚪️🟢): Enforces Unix-style line endings
-- [max-len](https://eslint.org/docs/latest/rules/max-len) (⚪️): Enforces a maximum line length of 80 characters
+- [linebreak-style](https://eslint.org/docs/latest/rules/linebreak-style) (🟠🟢): Enforces Unix-style line endings
+- [max-len](https://eslint.org/docs/latest/rules/max-len) (🟠): Enforces a maximum line length of 80 characters
 - [newline-per-chained-call](https://eslint.org/docs/latest/rules/newline-per-chained-call) (🟢): Requires a newline after each call in a method chain
-- [no-console](https://eslint.org/docs/latest/rules/no-console) (⚪️🟢): Disallows the use of `console`
-- [no-debugger](https://eslint.org/docs/latest/rules/no-debugger) (⚪️🟢): Disallows the use of `debugger`
-- [no-eval](https://eslint.org/docs/latest/rules/no-eval) (⚪️🟢): Disallows the use of `eval`
-- [no-magic-numbers](https://eslint.org/docs/latest/rules/no-magic-numbers) (⚪️): Disallows magic numbers (except the ones in the context of array indexes and in default value assignments)
-- [no-multi-str](https://eslint.org/docs/latest/rules/no-multi-str) (⚪️🟢): Disallows multiline strings
+- [no-console](https://eslint.org/docs/latest/rules/no-console) (🟠🟢): Disallows the use of `console`
+- [no-debugger](https://eslint.org/docs/latest/rules/no-debugger) (🟠🟢): Disallows the use of `debugger`
+- [no-eval](https://eslint.org/docs/latest/rules/no-eval) (🟠🟢): Disallows the use of `eval`
+- [no-magic-numbers](https://eslint.org/docs/latest/rules/no-magic-numbers) (🟠): Disallows magic numbers (except the ones in the context of array indexes and in default value assignments)
+- [no-multi-str](https://eslint.org/docs/latest/rules/no-multi-str) (🟠🟢): Disallows multiline strings
 - [no-multiple-empty-lines](https://eslint.org/docs/latest/rules/no-multiple-empty-lines) (🟢): Allows a maximum of 1 consecutive empty lines
-- [no-mixed-spaces-and-tabs](https://eslint.org/docs/latest/rules/no-mixed-spaces-and-tabs) (⚪️🟢): Disallows mixed spaces and tabs for indentation
+- [no-mixed-spaces-and-tabs](https://eslint.org/docs/latest/rules/no-mixed-spaces-and-tabs) (🟠🟢): Disallows mixed spaces and tabs for indentation
 - [no-restricted-syntax](https://eslint.org/docs/latest/rules/no-restricted-syntax) (🟢): Enforces `switch` `case`'s content to be enclosed in braces
-- [no-tabs](https://eslint.org/docs/latest/rules/no-tabs) (⚪️🟢): Disallows tabs
-- [no-trailing-spaces](https://eslint.org/docs/latest/rules/no-trailing-spaces) (⚪️🟢): Disallows trailing whitespace at the end of lines
-- [no-unused-vars](https://eslint.org/docs/latest/rules/no-unused-vars) (⚪️🟢): Disallows unused variables
-- [no-unsafe-optional-chaining](https://eslint.org/docs/latest/rules/no-unsafe-optional-chaining) (⚪️🟢): Disallows use of optional chaining in contexts where the `undefined` value is not allowed
-- [object-curly-newline](https://eslint.org/docs/latest/rules/object-curly-newline) (⚪️🟢): Requires line breaks after opening and before closing braces
-- [object-curly-spacing](https://eslint.org/docs/latest/rules/object-curly-spacing) (⚪️🟢): Requires spacing inside of braces
-- [padded-blocks](https://eslint.org/docs/latest/rules/padded-blocks) (⚪️🟢): Disallows empty lines at the beginning and ending of blocks
-- [padding-line-between-statements](https://eslint.org/docs/latest/rules/padding-line-between-statements) (⚪️🟢): Requires padding lines between various statements
+- [no-tabs](https://eslint.org/docs/latest/rules/no-tabs) (🟠🟢): Disallows tabs
+- [no-trailing-spaces](https://eslint.org/docs/latest/rules/no-trailing-spaces) (🟠🟢): Disallows trailing whitespace at the end of lines
+- [no-unused-vars](https://eslint.org/docs/latest/rules/no-unused-vars) (🟠🟢): Disallows unused variables
+- [no-unsafe-optional-chaining](https://eslint.org/docs/latest/rules/no-unsafe-optional-chaining) (🟠🟢): Disallows use of optional chaining in contexts where the `undefined` value is not allowed
+- [object-curly-newline](https://eslint.org/docs/latest/rules/object-curly-newline) (🟠🟢): Requires line breaks after opening and before closing braces
+- [object-curly-spacing](https://eslint.org/docs/latest/rules/object-curly-spacing) (🟠🟢): Requires spacing inside of braces
+- [padded-blocks](https://eslint.org/docs/latest/rules/padded-blocks) (🟠🟢): Disallows empty lines at the beginning and ending of blocks
+- [padding-line-between-statements](https://eslint.org/docs/latest/rules/padding-line-between-statements) (🟠🟢): Requires padding lines between various statements
 - [prefer-arrow-callback](https://eslint.org/docs/latest/rules/prefer-arrow-callback) (🟢): Requires using arrow functions for callbacks
-- [quotes](https://eslint.org/docs/latest/rules/quotes) (⚪️🟢): Enforces the consistent use of double quotes (while allowing single quotes in order to avoid escape, and backticks for template literals)
-- [quote-props](https://eslint.org/docs/latest/rules/quote-props) (⚪️🟢): Disallows quotes around object literal property names that are not strictly required
-- [semi](https://eslint.org/docs/latest/rules/semi) (⚪️🟢): Requires semicolons at the end of statements
-- [semi-style](https://eslint.org/docs/latest/rules/semi-style) (⚪️🟢): Enforces that semicolons are at the end of statements
+- [quotes](https://eslint.org/docs/latest/rules/quotes) (🟠🟢): Enforces the consistent use of double quotes (while allowing single quotes in order to avoid escape, and backticks for template literals)
+- [quote-props](https://eslint.org/docs/latest/rules/quote-props) (🟠🟢): Disallows quotes around object literal property names that are not strictly required
+- [semi](https://eslint.org/docs/latest/rules/semi) (🟠🟢): Requires semicolons at the end of statements
+- [semi-style](https://eslint.org/docs/latest/rules/semi-style) (🟠🟢): Enforces that semicolons are at the end of statements
 - [semi-spacing](https://eslint.org/docs/latest/rules/semi-spacing) (🟢): Disallows space before semicolons, enforces spaces after
-- [space-before-blocks](https://eslint.org/docs/latest/rules/space-before-blocks) (⚪️🟢): Enforces consistent spacing before blocks
-- [space-in-parens](https://eslint.org/docs/latest/rules/space-in-parens) (⚪️🟢): Enforces zero spaces inside of parentheses
+- [space-before-blocks](https://eslint.org/docs/latest/rules/space-before-blocks) (🟠🟢): Enforces consistent spacing before blocks
+- [space-in-parens](https://eslint.org/docs/latest/rules/space-in-parens) (🟠🟢): Enforces zero spaces inside of parentheses
 
 #### Crisp JS rules
-- [crisp/align-consecutive-class-assignements](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/align-consecutive-class-assignements.js) (⚪️): Enforces alignment of consecutive assignment statements in a class constructor
-- [crisp/align-one-var](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/align-one-var.js) (⚪️): Enforces alignment of variables in 'one-var' statements
-- [crisp/align-requires](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/align-requires.js) (⚪️): Enforces alignment of require statements
-- [crisp/const](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/const.js) (⚪️): Enforces that `const` variables start with `__` or are all uppercase
-- [crisp/constructor-variables](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/constructor-variables.js) (⚪️): Ensures all class properties in the constructor start with `_`
-- [crisp/enforce-optional](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/enforce-optional.js) (⚪️🟢): Enforces use of optional chaining
-- [crisp/header-check](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/header-check.js) (⚪️🟢): Enforces files to start with Crisp header
-- [crisp/header-comments-check](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/header-comments-check.js) (⚪️🟢):
-- [crisp/methods-naming](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/methods-naming.js) (⚪️🟢): Enforces different comment blocks before different groups (imports, exports, constants and instances)
-- [crisp/methods-ordering](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/methods-ordering.js) (⚪️🟢): Ensures methods order according to their access: `public` then `protected` then `private`
-- [crisp/multiline-comment-end-backslash](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/multiline-comment-end-backslash.js) (⚪️🟢): Enforces multiline comments to end with a backslash
-- [crisp/newline-after-switch-case](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/newline-after-switch-case.js) (⚪️🟢): Requires newline between switch cases
-- [crisp/no-async](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/no-async.js) (⚪️🟢): Disallows the use of `async/syntax`, in favor of `Promise`
-- [crisp/no-short-parameters](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/no-short-parameters.js) (⚪️🟢): Disallow parameter names shorter than 3 characters
-- [crisp/no-space-in-optional-arguments](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/no-space-in-optional-arguments.js) (⚪️): Disallows space before or after `=` in optional parameters
+- [crisp/align-consecutive-class-assignements](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/align-consecutive-class-assignements.js) (🟠): Enforces alignment of consecutive assignment statements in a class constructor
+- [crisp/align-one-var](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/align-one-var.js) (🟠): Enforces alignment of variables in 'one-var' statements
+- [crisp/align-requires](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/align-requires.js) (🟠): Enforces alignment of require statements
+- [crisp/const](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/const.js) (🟠): Enforces that `const` variables start with `__` or are all uppercase
+- [crisp/constructor-variables](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/constructor-variables.js) (🟠): Ensures all class properties in the constructor start with `_`
+- [crisp/enforce-optional](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/enforce-optional.js) (🟠🟢): Enforces use of optional chaining
+- [crisp/header-check](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/header-check.js) (🟠🟢): Enforces files to start with Crisp header
+- [crisp/header-comments-check](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/header-comments-check.js) (🟠🟢): Enforces different comment blocks before different groups (imports, constants, instances and exports)
+- [crisp/import-group-comment](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/import-group-comment.js) (🟢): Ensures `import` statements are preceded by a comment stating their type
+- [crisp/methods-naming](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/methods-naming.js) (🟠🟢): Ensures methods are named according to their access (`public`, `private`, `protected`)
+- [crisp/methods-ordering](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/methods-ordering.js) (🟠🟢): Ensures methods order according to their access: `public` then `protected` then `private`
+- [crisp/multiline-comment-end-backslash](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/multiline-comment-end-backslash.js) (🟠🟢): Enforces multiline comments to end with a backslash
+- [crisp/newline-after-switch-case](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/newline-after-switch-case.js) (🟠🟢): Requires newline between switch cases
+- [crisp/no-async](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/no-async.js) (🟠🟢): Disallows the use of `async/syntax`, in favor of `Promise`
+- [crisp/no-short-parameters](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/no-short-parameters.js) (🟠🟢): Disallow parameter names shorter than 3 characters
+- [crisp/no-space-in-optional-arguments](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/no-space-in-optional-arguments.js) (🟠): Disallows space before or after `=` in optional parameters
 - [crisp/no-useless-template-literals](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/no-useless-template-literals.js) (🟢): Disallows unnecessary use of template literals
-- [crisp/no-var-in-blocks](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/no-var-in-blocks.js) (⚪️🟢): Disallows `var` declarations inside function, method, or class block
-- [crisp/one-space-after-operator](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/one-space-after-operator.js) (⚪️🟢): Enforces at least one space before and one space after `=` and `:` operators
-- [crisp/regex-in-constructor](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/regex-in-constructor.js) (⚪️🟢): Ensures regular expressions are defined in the class constructor
-- [crisp/ternary-parenthesis](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/ternary-parenthesis.js) (⚪️🟢): Enforces parentheses around conditions with operators in ternary expressions
-- [crisp/two-lines-between-class-members](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/two-lines-between-class-members.js) (⚪️): Requires exactly two line breaks between class methods
-- [crisp/variable-names](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/variable-names.js) (⚪️🟢): Requires variables defined within a method to start with `_`
+- [crisp/no-var-in-blocks](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/no-var-in-blocks.js) (🟠🟢): Disallows `var` declarations inside function, method, or class block
+- [crisp/one-space-after-operator](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/one-space-after-operator.js) (🟠🟢): Enforces at least one space before and one space after `=` and `:` operators
+- [crisp/regex-in-constructor](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/regex-in-constructor.js) (🟠🟢): Ensures regular expressions are defined in the class constructor
+- [crisp/ternary-parenthesis](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/ternary-parenthesis.js) (🟠🟢): Enforces parentheses around conditions with operators in ternary expressions
+- [crisp/two-lines-between-class-members](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/two-lines-between-class-members.js) (🟠): Requires exactly two line breaks between class methods
+- [crisp/variable-names](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/variable-names.js) (🟠🟢): Requires variables defined within a method to start with `_`
 
 #### General JSDoc rules
-- [jsdoc/no-undefined-types](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-undefined-types.md) (⚪️): Rule is **disabled** to allow some undefined types
+- [jsdoc/no-undefined-types](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-undefined-types.md) (🟠): Rule is **disabled** to allow some undefined types
 - [jsdoc/require-description](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description.md) (🟢): Requires all functions to have a description in their JSDoc
-- [jsdoc/require-param-description](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-description.md) (⚪️🟢): Rule is **disabled** as we don't write any description for `@param` tags
-- [jsdoc/require-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-jsdoc.md) (⚪️🟢): Enforces JSDoc comments on functions and classes
-- [jsdoc/sort-tags](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/sort-tags.md) (⚪️🟢): Enforces specific order for tags
+- [jsdoc/require-param-description](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-description.md) (🟠🟢): Rule is **disabled** as we don't write any description for `@param` tags
+- [jsdoc/require-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-jsdoc.md) (🟠🟢): Enforces JSDoc comments on functions and classes
+- [jsdoc/sort-tags](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/sort-tags.md) (🟠🟢): Enforces specific order for tags
 
 #### Crisp JSDoc rules
-- [crisp/jsdoc-align-params](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/jsdoc-align-params.js) (⚪️🟢): Enforces various alignments
-- [crisp/jsdoc-check-indentation](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/jsdoc-check-indentation.js) (⚪️🟢): Enforces consistent indentation
+- [crisp/jsdoc-align-params](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/jsdoc-align-params.js) (🟠🟢): Enforces various alignments
+- [crisp/jsdoc-check-indentation](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/jsdoc-check-indentation.js) (🟠🟢): Enforces consistent indentation
 - [crisp/jsdoc-check-optional-params](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/jsdoc-check-optional-params.js) (🟢): Requires optional parameters to be surrounded by brackets
 - [crisp/jsdoc-enforce-access](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/jsdoc-enforce-access.js) (🟢): Requires one of `@public`, `@private`, or `@protected` for functions
-- [crisp/jsdoc-enforce-classdesc](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/jsdoc-enforce-classdesc.js) (⚪️🟢): Ensures JSDoc for class headers to include a non-empty `@classdesc`
+- [crisp/jsdoc-enforce-classdesc](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/jsdoc-enforce-classdesc.js) (🟠🟢): Ensures JSDoc for class headers to include a non-empty `@classdesc`
 
 #### General Vue rules
 - [vue/attributes-order](https://eslint.vuejs.org/rules/attributes-order) (🟢): Enforces order of attributes

package/index.js

@@ -11,6 +11,7 @@ module.exports = {
     "enforce-optional": require("./rules/enforce-optional"),
     "header-check": require("./rules/header-check"),
     "header-comments-check": require("./rules/header-comments-check"),
+    "import-group-comment": require("./rules/import-group-comment"),
     "jsdoc-align-params": require("./rules/jsdoc-align-params"),
     "jsdoc-check-indentation": require("./rules/jsdoc-check-indentation"),
     "jsdoc-check-optional-params": require("./rules/jsdoc-check-optional-params"),
@@ -19,6 +20,7 @@ module.exports = {
     "methods-naming": require("./rules/methods-naming"),
     "methods-ordering": require("./rules/methods-ordering"),
     "multiline-comment-end-backslash": require("./rules/multiline-comment-end-backslash"),
+    "newline-after-switch-case": require("./rules/newline-after-switch-case"),
     "no-async": require("./rules/no-async"),
     "no-var-in-blocks": require("./rules/no-var-in-blocks"),
     "no-space-in-optional-arguments": require("./rules/no-space-in-optional-arguments"),

package/package.json

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

package/recommended-vue.js

@@ -140,6 +140,7 @@ module.exports = {
     "crisp/enforce-optional": "error",
     "crisp/header-check": "error",
     "crisp/header-comments-check": "error",
+    "crisp/import-group-comment": "error",
     "crisp/methods-naming": "error",
     "crisp/methods-ordering": "error",
     "crisp/multiline-comment-end-backslash": "error",

package/rules/import-group-comment.js

@@ -0,0 +1,108 @@
+module.exports = {
+  meta: {
+    type: "suggestion",
+    docs: {
+      description: "Enforce import statements to be grouped and preceded by a comment",
+      category: "Best Practices",
+      recommended: false,
+    },
+    fixable: null,  // This rule is not auto-fixable
+  },
+
+  create(context) {
+    let currentGroupComment = null;
+
+    // Extract the directory name from the file path
+    function getDirectoryName(filePath) {
+      const pathParts = filePath.split('/');
+      return pathParts[pathParts.length - 2].toUpperCase(); // Directory name
+    }
+
+    function extractGroupFromPath(path, filePath) {
+      // Relative path import?
+      if (path.startsWith("./")) {
+        return getDirectoryName(filePath);
+      }
+
+      // Alias path import?
+      if (path.startsWith("@/")) {
+        const parts = path.split("/");
+
+        if (parts.length === 2) {
+          return "MAIN";
+        }
+
+        return parts[1].toUpperCase();
+      }
+
+      return "NPM";
+    }
+
+    function generateExpectedComment(group) {
+      if (group === "NPM") {
+        return group;
+      }
+
+      return `PROJECT: ${group}`;
+    }
+
+    function isGroupComment(comment) {
+      return (
+        comment.type === "Line" &&
+        (
+          comment.value.trim().startsWith("PROJECT:") ||
+          comment.value.trim().startsWith("NPM")
+        )
+      );
+    }
+
+    function isIgnoreComment(comment) {
+      // Skip some comments
+      return (
+        comment.type === "Line" &&
+        comment.value.trim().startsWith("@ts-ignore")
+      );
+    }
+
+    function updateCurrentGroupComment(node) {
+      const comments = context.getSourceCode().getCommentsBefore(node);
+
+      if (comments.length > 0) {
+        for (let i = comments.length - 1; i >= 0; i--) {
+          if (isIgnoreComment(comments[i])) {
+            continue;
+          }
+
+          if (isGroupComment(comments[i])) {
+            currentGroupComment = comments[i];
+
+            break;
+          }
+        }
+      }
+    }
+
+    function checkImportGroup(node) {
+      const importPath = node.source.value;
+      const filePath = context.getFilename();
+
+      // Get group from import path
+      const expectedGroup = extractGroupFromPath(importPath, filePath);
+      const expectedComment = generateExpectedComment(expectedGroup);
+
+      // Get comment for current group
+      updateCurrentGroupComment(node);
+
+      if (!currentGroupComment || !currentGroupComment.value.toUpperCase().includes(expectedComment.toUpperCase())) {
+        context.report({
+          node,
+          message: `Import "${importPath}" should be in the "${expectedComment}" group.`,
+        });
+      }
+    }
+
+    return {
+      ImportDeclaration: checkImportGroup,
+    };
+  }
+};

package/rules/methods-naming.js

@@ -21,16 +21,16 @@ module.exports = {
         if (jsDocComment) {
           const isPrivate = node.key.name.startsWith("__");
           const isProtected = node.key.name.startsWith("_") && !node.key.name.startsWith("__");
-          const isPublic = jsDocComment.value.includes("@public");
+          const isPublicJsDoc = jsDocComment.value.includes("@public");
           const isProtectedJsDoc = jsDocComment.value.includes("@protected");
           const isPrivateJsDoc = jsDocComment.value.includes("@private");
 
-          if (isPrivate && isPublic) {
+          if (isPrivate && isPublicJsDoc) {
             context.report({
               node: node,
               message: "Methods starting with '__' should not be marked with '@public'."
             });
-          } else if (isProtected && isPublic) {
+          } else if (isProtected && isPublicJsDoc) {
             context.report({
               node: node,
               message: "Methods starting with '_' should not be marked with '@public'."