eslint-plugin-crisp 1.6.4 → 1.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-crisp",
-  "version": "1.6.4",
+  "version": "1.7.0",
   "description": "Custom ESLint Rules for Crisp",
   "author": "Crisp IM SAS",
   "main": "index.js",
@@ -17,20 +17,20 @@
     "test": "node --test"
   },
   "dependencies": {
-    "@eslint/js": "9.39.5",
+    "@eslint/js": "10.0.1",
     "doctrine": "3.0.0",
-    "eslint-plugin-jsdoc": "50.8.0",
+    "eslint-plugin-jsdoc": "65.4.0",
     "lodash-es": "4.18.1",
     "typescript": "5.9.3",
     "typescript-eslint": "8.72.0"
   },
   "devDependencies": {
-    "eslint": "9.39.5",
+    "eslint": "10.13.0",
     "vue-eslint-parser": "10.4.1",
     "vue-eslint-parser-template-tokenizer-pug": "1.0.0"
   },
   "peerDependencies": {
-    "eslint": "^9.39.5",
+    "eslint": "^10.13.0",
     "eslint-plugin-vue": "^10.11.1",
     "eslint-plugin-vue-pug": "1.0.0-alpha.6",
     "globals": "15.15.0"

package/rules/align-comments.js

@@ -11,7 +11,7 @@ export default {
   },
 
   create(context) {
-    const sourceCode = context.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode;
     const processedComments = new Set();
 
     function checkNode(node) {

package/rules/align-consecutive-class-assignements.js

@@ -11,7 +11,7 @@ export default {
   },
 
   create: function (context) {
-    let sourceCode = context.getSourceCode();
+    let sourceCode = context.sourceCode;
     let currentBlock = [];
     let maxColumn = 0;
 

package/rules/align-one-var.js

@@ -8,7 +8,7 @@ export default {
     },
   },
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode;
 
     return {
       VariableDeclaration(node) {

package/rules/arrow-block-newline.js

@@ -15,7 +15,7 @@ export default {
   },
 
   create(context) {
-    const sourceCode = context.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode;
 
     return {
       ArrowFunctionExpression(node) {

package/rules/consecutive-line-comments.js

@@ -64,7 +64,7 @@ export default {
   },
 
   create(context) {
-    const sourceCode = context.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode;
 
     function isStandalone(comment) {
       const lineText = sourceCode.lines[comment.loc.start.line - 1] || "";

package/rules/const.js

@@ -50,7 +50,7 @@ export default {
   create(context) {
     const options = context.options[0] || {};
     const exceptions = options.exceptions || [];
-    const sourceCode = context.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode;
 
     const isTopLevelCallArgument = (identifier) => {
       let scope = sourceCode.getScope(identifier);

package/rules/constructor-variables.js

@@ -25,7 +25,7 @@ export default {
 
   create(context) {
     const options = context.options[0] || {};
-    const filename = context.filename || context.getFilename();
+    const filename = context.filename;
     const filenameExceptions = options.filenameExceptions || [];
     const variableExceptions = options.variableExceptions || [];
 

package/rules/enforce-optional.js

@@ -14,7 +14,7 @@ export default {
   },
 
   create(context) {
-    const sourceCode = context.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode;
 
     const patterns = [
       // Search for `foo && foo.` or `foo && foo[`

package/rules/header-check.js

@@ -27,8 +27,8 @@ export default {
     return {
       Program(node) {
         const options = context.options[0] || {};
-        const fileName = context.getFilename();
-        const sourceCode = context.sourceCode || context.getSourceCode();
+        const fileName = context.filename;
+        const sourceCode = context.sourceCode;
 
         let fileContent = sourceCode.getText().trim();
 

package/rules/header-comments-check.js

@@ -113,7 +113,7 @@ export default {
   },
 
   create(context) {
-    const filename = context.filename || context.getFilename();
+    const filename = context.filename;
 
     if (!filename.endsWith(".js") && !filename.endsWith(".ts")) {
       return {};
@@ -122,7 +122,7 @@ export default {
     let lastNode = null;
     let groupStart = null;
 
-    const sourceCode = context.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode;
     const allBlockComments = sourceCode.getAllComments()
       .filter(c => c.type === "Block")
       .sort((a, b) => a.range[0] - b.range[0]);

package/rules/import-group-comment.js

@@ -71,7 +71,7 @@ export default {
   },
 
   create(context) {
-    const sourceCode = context.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode;
     const customGroups = context.options[0] || {};  // Get custom groups from options
 
     // Pre-compile custom regexes once instead of on every import
@@ -171,7 +171,7 @@ export default {
 
     function checkImportGroup(node) {
       const importPath = node.source.value;
-      const filePath = context.getFilename();
+      const filePath = context.filename;
 
       // Get group from import path
       const expectedGroup = extractGroupFromPath(importPath, filePath);
@@ -201,7 +201,7 @@ export default {
     const typeComments = allComments.filter(c => isTypeComment(c));
 
     function checkTypeCommentsGroup() {
-      const filename = context.getFilename();
+      const filename = context.filename;
 
       // Only check for // TYPES in .vue files (block header is checked by header-comments-check rule for .js/.ts)
       if (!filename.endsWith(".vue")) {

package/rules/import-group-order.js

@@ -71,7 +71,7 @@ export default {
     }
 
     function updateAndCheckGroup(node) {
-      const comments = context.getSourceCode().getCommentsBefore(node);
+      const comments = context.sourceCode.getCommentsBefore(node);
       for (let i = comments.length - 1; i >= 0; i--) {
         const comment = comments[i];
         if (isGroupComment(comment)) {

package/rules/jsdoc-align-params.js

@@ -182,7 +182,7 @@ export default {
   create: function(context) {
     return {
       Program: function(node) {
-        const comments = context.getSourceCode().getAllComments(node);
+        const comments = context.sourceCode.getAllComments(node);
 
         comments
           .filter(comment => comment.type === "Block" && comment.value.startsWith("*"))

package/rules/jsdoc-check-indentation.js

@@ -43,7 +43,7 @@ const maskLineContinuations = (str) => {
   });
 }
 
-export default iterateJsdoc.default(({
+export default iterateJsdoc(({
   sourceCode,
   jsdocNode,
   report,

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

@@ -1,4 +1,5 @@
 import doctrine from "doctrine";
+import getJSDocComment from "./utils/get-jsdoc-comment.js";
 
 export default {
   meta: {
@@ -11,9 +12,11 @@ export default {
   },
 
   create(context) {
+    const sourceCode = context.sourceCode;
+
     function checkOptionalParams(node) {
       // Get JSDoc comments
-      const jsDocComment = context.getSourceCode().getJSDocComment(node);
+      const jsDocComment = getJSDocComment(sourceCode, node);
 
       if (!jsDocComment) {
         return;

package/rules/jsdoc-description-length.js

@@ -23,7 +23,7 @@ export default {
   create(context) {
     const options = context.options[0] || {};
     const maxLines = options.maxLines || 2;
-    const sourceCode = context.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode;
 
     function checkComment(comment) {
       if (comment.type !== "Block" || !comment.value.startsWith("*")) {

package/rules/jsdoc-description-multiline.js

@@ -1,6 +1,6 @@
 import iterateJsdoc from "eslint-plugin-jsdoc/iterateJsdoc.js";
 
-export default iterateJsdoc.default(({
+export default iterateJsdoc(({
   context,
   indent,
   jsdocNode,

package/rules/jsdoc-enforce-access.js

@@ -12,7 +12,7 @@ export default {
   },
 
   create: function(context) {
-    const sourceCode = context.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode;
 
     function checkNodeForJSDoc(node) {
       const comments = sourceCode.getCommentsBefore(node);

package/rules/jsdoc-enforce-classdesc.js

@@ -1,3 +1,5 @@
+import getJSDocComment from "./utils/get-jsdoc-comment.js";
+
 export default {
   meta: {
     type: "suggestion",
@@ -9,9 +11,11 @@ export default {
   },
 
   create(context) {
+    const sourceCode = context.sourceCode;
+
     return {
       ClassDeclaration(node) {
-        const jsdoc = context.getSourceCode().getJSDocComment(node);
+        const jsdoc = getJSDocComment(sourceCode, node);
 
         if (jsdoc) {
           const hasClassdesc = /@classdesc/.test(jsdoc.value);

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

@@ -18,7 +18,7 @@ export default {
   },
 
   create(context) {
-    const sourceCode = context.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode;
 
     function checkComment(comment) {
       if (comment.type !== "Block" || !comment.value.startsWith("*")) {

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

@@ -131,7 +131,7 @@ const validateDescription = (
   });
 };
 
-export default iterateJsdoc.default(({
+export default iterateJsdoc(({
   sourceCode,
   context,
   jsdoc,

package/rules/logger-arguments.js

@@ -112,7 +112,7 @@ export default {
   },
 
   create(context) {
-    const sourceCode = context.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode;
 
     return {
       CallExpression(node) {

package/rules/methods-naming.js

@@ -12,7 +12,7 @@ export default {
   create: function(context) {
     return {
       MethodDefinition: function(node) {
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
         const commentsBefore = sourceCode.getCommentsBefore(node);
 
         const jsDocComment = commentsBefore.find(comment =>

package/rules/methods-ordering.js

@@ -6,7 +6,7 @@ const SECTION_COMMENT_PATTERN = /--> (.*) <--/;
 export default {
   create(context) {
     let methodOrder = []; // Keep track of method order
-    const sourceCode = context.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode;
 
     return {
       MethodDefinition(node) {

package/rules/multiline-comment-end-backslash.js

@@ -12,7 +12,7 @@ export default {
   create(context) {
     return {
       Program() {
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
         const comments = sourceCode.getAllComments();
 
         let groupComments = [];

package/rules/newline-after-switch-case.js

@@ -6,7 +6,9 @@ function getTokensWithNewlineBetween(sourceCode, startNode, endNode) {
 
   do {
     previous = next;
-    next = sourceCode.getTokenOrCommentAfter(next);
+    next = sourceCode.getTokenAfter(next, {
+      includeComments: true
+    });
 
     if (next.loc.start.line > previous.loc.end.line + 1) {
       return [previous, next];
@@ -24,7 +26,7 @@ export default {
 
   create: function newlineBetweenSwitchCase(context) {
     let currentCodePath = null;
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode;
 
     return {
       onCodePathStart(codePath) {

package/rules/no-extra-line-within-function.js

@@ -9,7 +9,7 @@ export default {
     fixable: "whitespace",
   },
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode;
 
     function checkFunctionBody(node) {
       const bodyNode = node.body;

package/rules/no-space-in-optional-arguments.js

@@ -4,7 +4,7 @@ export default {
       "FunctionDeclaration, FunctionExpression, ArrowFunctionExpression, MethodDefinition": function(node) {
         (node.params || []).forEach(param => {
           if (param.type === "AssignmentPattern") {
-            const sourceCode = context.sourceCode || context.getSourceCode();
+            const sourceCode = context.sourceCode;
             const operatorToken = sourceCode.getFirstTokenBetween(param.left, param.right, token => token.value === "=");
 
             if (

package/rules/one-space-after-operator.js

@@ -23,7 +23,7 @@ export default {
     ]
   },
   create(context) {
-    const sourceCode = context.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode;
     const config = context.options[0] || {};
     const checkColon = config.checkColon !== false;
 

package/rules/regex-in-constructor.js

@@ -11,7 +11,7 @@ export default {
   create(context) {
     return {
       'MethodDefinition[kind!="constructor"] > FunctionExpression > BlockStatement': function(node) {
-        const regexes = context.getSourceCode().getTokens(node).filter(token => token.type === "RegularExpression");
+        const regexes = context.sourceCode.getTokens(node).filter(token => token.type === "RegularExpression");
 
         if (regexes.length > 0) {
           context.report({

package/rules/ternary-parenthesis.js

@@ -13,7 +13,7 @@ export default {
     return {
       ConditionalExpression(node) {
         if (node.test.type === "BinaryExpression" || node.test.type === "LogicalExpression") {
-          const sourceCode = context.getSourceCode();
+          const sourceCode = context.sourceCode;
           const beforeOperatorToken = sourceCode.getTokenBefore(node.test);
           const afterOperatorToken = sourceCode.getTokenAfter(node.test);
 

package/rules/two-lines-between-class-members.js

@@ -10,7 +10,7 @@ export default {
   create(context) {
     return {
       MethodDefinition(node) {
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
         const lines = sourceCode.lines;
 
         const parent = node.parent;

package/rules/utils/get-jsdoc-comment.js

@@ -0,0 +1,72 @@
+function findJSDocComment(sourceCode, node) {
+  const comments = sourceCode.getCommentsBefore(node);
+  const comment = comments.at(-1);
+
+  if (
+    !comment ||
+    comment.type !== "Block" ||
+    !comment.value.startsWith("*") ||
+    node.loc.start.line - comment.loc.end.line > 1
+  ) {
+    return null;
+  }
+
+  const tokenBefore = sourceCode.getTokenBefore(node, {
+    includeComments: true
+  });
+
+  return tokenBefore === comment ? comment : null;
+}
+
+export default function getJSDocComment(sourceCode, node) {
+  let parent = node.parent;
+
+  switch (node.type) {
+    case "ClassDeclaration":
+    case "FunctionDeclaration":
+      if (
+        parent?.type === "ExportDefaultDeclaration" ||
+        parent?.type === "ExportNamedDeclaration"
+      ) {
+        return findJSDocComment(sourceCode, parent);
+      }
+
+      return findJSDocComment(sourceCode, node);
+
+    case "ClassExpression":
+      return findJSDocComment(sourceCode, parent.parent);
+
+    case "ArrowFunctionExpression":
+    case "FunctionExpression":
+      if (
+        parent.type !== "CallExpression" &&
+        parent.type !== "NewExpression"
+      ) {
+        while (
+          !sourceCode.getCommentsBefore(parent).length &&
+          !/Function/u.test(parent.type) &&
+          parent.type !== "MethodDefinition" &&
+          parent.type !== "Property"
+        ) {
+          parent = parent.parent;
+
+          if (!parent) {
+            break;
+          }
+        }
+
+        if (
+          parent &&
+          parent.type !== "FunctionDeclaration" &&
+          parent.type !== "Program"
+        ) {
+          return findJSDocComment(sourceCode, parent);
+        }
+      }
+
+      return findJSDocComment(sourceCode, node);
+
+    default:
+      return null;
+  }
+}

package/rules/vue-attribute-comma.js

@@ -15,7 +15,7 @@ export default {
   create(context) {
     return utils.default.defineTemplateBodyVisitor(context, {
       "VAttribute"(node) {
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
         const attributeText = sourceCode.getText(node);
         const attributeEndIndex = node.range[1];
         const nextChar = sourceCode.getText().slice(attributeEndIndex, attributeEndIndex + 1);

package/rules/vue-class-attribute-last.js

@@ -43,7 +43,7 @@ export default {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode;
 
     // Reports attributes declared after the class attribute they should precede
     function reportAttributesAfter(attributes, classIndex, className, isMisplaced) {

package/rules/vue-class-shorthand-max-len.js

@@ -38,7 +38,7 @@ export default {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode;
     const maxLength = context.options[0]?.max ?? DEFAULT_MAX_LENGTH;
 
     return utils.default.defineTemplateBodyVisitor(context, {

package/rules/vue-computed-order.js

@@ -29,7 +29,7 @@ export default {
               message: "Computed properties should be in alphabetical order.",
 
               fix(fixer) {
-                const sourceCode = context.getSourceCode();
+                const sourceCode = context.sourceCode;
                 const propertyText = sourceCode.getText(property);
                 const nextPropertyText = sourceCode.getText(nextProperty);
 

package/rules/vue-data-comment.js

@@ -22,7 +22,7 @@ export default {
           return;
         }
 
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
         const comments = sourceCode.getCommentsInside(node);
 
         if (comments.length === 0) {

package/rules/vue-define-component.js

@@ -11,7 +11,7 @@ export default {
   },
 
   create(context) {
-    const fileName = (context.filename || context.getFilename()).replace(/\\/g, "/");
+    const fileName = context.filename.replace(/\\/g, "/");
 
     if (fileName.endsWith("/index.js") || !isVueComponentOrMixin(fileName)) {
       return {};
@@ -68,7 +68,7 @@ function buildFixes(fixer, context, exportNode) {
     return null;
   }
 
-  const sourceCode = context.sourceCode || context.getSourceCode();
+  const sourceCode = context.sourceCode;
   const importFix = buildDefineComponentImportFix(fixer, sourceCode);
 
   if (importFix === false) {

package/rules/vue-emits-order.js

@@ -23,7 +23,7 @@ export default {
               message: "Emits should be in alphabetical order.",
 
               fix(fixer) {
-                const sourceCode = context.getSourceCode();
+                const sourceCode = context.sourceCode;
                 const elementText = sourceCode.getText(element);
                 const nextElementText = sourceCode.getText(nextElement);
 

package/rules/vue-header-check.js

@@ -15,7 +15,7 @@ export default {
   create(context) {
     return {
       Program(node) {
-        const fileName = context.physicalFilename || context.filename || context.getFilename();
+        const fileName = context.physicalFilename || context.filename;
 
         // Determine the file extension
         const fileExtension = path.extname(fileName);

package/rules/vue-html-indent.js

@@ -12,7 +12,7 @@ export default {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode()
+    const sourceCode = context.sourceCode
     const template = (
       sourceCode.parserServices.getTemplateBodyTokenStore &&
       sourceCode.parserServices.getTemplateBodyTokenStore()

package/rules/vue-html-quotes.js

@@ -26,7 +26,7 @@ export default {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode()
+    const sourceCode = context.sourceCode
     const double = context.options[0] !== "single"
     const avoidEscape =
       context.options[1] && context.options[1].avoidEscape === true

package/rules/vue-methods-separator.js

@@ -22,7 +22,7 @@ export default {
           return;
         }
 
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
         const comments = sourceCode.getCommentsInside(node);
 
         const hasSeparator = comments.some((comment) => {

package/rules/vue-no-component-class-shorthand.js

@@ -24,7 +24,7 @@ export default {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode;
 
     return utils.default.defineTemplateBodyVisitor(context, {
       VElement(node) {

package/rules/vue-no-name-option.js

@@ -11,7 +11,7 @@ export default {
   },
 
   create(context) {
-    const fileName = (context.filename || context.getFilename()).replace(/\\/g, "/");
+    const fileName = context.filename.replace(/\\/g, "/");
 
     if (!fileName.endsWith(".vue")) {
       return {};
@@ -87,7 +87,7 @@ function isNameProperty(property) {
 
 // Removes a property and its adjacent comma
 function removeProperty(fixer, context, options, property) {
-  const sourceCode = context.sourceCode || context.getSourceCode();
+  const sourceCode = context.sourceCode;
   const nextToken = sourceCode.getTokenAfter(property);
 
   if (nextToken?.value === ",") {

package/rules/vue-pinia-action-single-parameter.js

@@ -15,7 +15,7 @@ export default {
   },
 
   create(context) {
-    const sourceCode = context.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode;
     const defineStoreImports = collectDefineStoreImports(sourceCode.ast);
 
     return {

package/rules/vue-props-declaration-line-break.js

@@ -11,7 +11,7 @@ export default {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode;
 
     function checkPropDefinition(propNode) {
       const typeProperty = propNode.properties.find(p => p.key.name === "type");

package/rules/vue-props-declaration-multiline.js

@@ -25,7 +25,7 @@ export default {
                 message: "Props should be declared in multiple lines.",
 
                 fix(fixer) {
-                  const sourceCode = context.getSourceCode();
+                  const sourceCode = context.sourceCode;
                   const propText = sourceCode.getText(propDefinition);
 
                   // Construct the multi-line version of the prop

package/rules/vue-props-declaration-order.js

@@ -23,7 +23,7 @@ export default {
               message: "Props should be in alphabetical order.",
 
               fix(fixer) {
-                const sourceCode = context.getSourceCode();
+                const sourceCode = context.sourceCode;
                 const propertyText = sourceCode.getText(property);
                 const nextPropertyText = sourceCode.getText(nextProperty);
 

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

@@ -6,8 +6,11 @@ const ruleTester = createRuleTester();
 ruleTester.run("jsdoc-check-optional-params", rule, {
   valid: [
     "/** @param {string} value */\nfunction required(value) {}",
+    "/** @param {string} value */\nexport function required(value) {}",
     "/** @param {string} [value] */\nfunction optional(value = \"default\") {}",
     "/** @param {number} [count=1] */\nconst optional = function(count = 1) {};",
+    "/* @param {string} value */\nfunction optional(value = \"default\") {}",
+    "/** @param {string} value */\nconst unrelated = true;\nfunction optional(value = \"default\") {}",
     "function undocumented(value) {}"
   ],
 
@@ -20,6 +23,14 @@ ruleTester.run("jsdoc-check-optional-params", rule, {
         }
       ]
     },
+    {
+      code: "/** @param {string} value */\nexport function optional(value = \"default\") {}",
+      errors: [
+        {
+          message: "Optional parameters in JSDoc should be surrounded by brackets"
+        }
+      ]
+    },
     {
       code: "/** @param {string} [value] */\nfunction required(value) {}",
       errors: [

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

@@ -6,7 +6,10 @@ const ruleTester = createRuleTester();
 ruleTester.run("jsdoc-enforce-classdesc", rule, {
   valid: [
     "/**\n * @classdesc Represents an example.\n */\nclass Example {}",
+    "/**\n * @classdesc Represents an example.\n */\nexport default class Example {}",
     "class Undocumented {}",
+    "/* Represents an example. */\nclass Example {}",
+    "/** Represents an unrelated value. */\nconst value = 1;\nclass Example {}",
     "/** A factory function. */\nfunction createExample() {}"
   ],
 
@@ -19,6 +22,14 @@ ruleTester.run("jsdoc-enforce-classdesc", rule, {
         }
       ]
     },
+    {
+      code: "/** Represents an example. */\nexport class Example {}",
+      errors: [
+        {
+          message: "JSDoc class header should include @classdesc"
+        }
+      ]
+    },
     {
       code: "/**\n * @classdesc\n */\nclass Example {}",
       errors: [