@adyen/eslint-plugin-bento 1.2.0 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adyen/eslint-plugin-bento",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Adyen Bento ESLint rules",
   "main": "index.js",
   "files": [
@@ -18,11 +18,17 @@
     "url": "git@github.com:Adyen/bento.git"
   },
   "license": "MIT",
+  "dependencies": {
+    "jscodeshift": "17.1.2"
+  },
   "devDependencies": {
+    "@types/estree": "1.0.6",
+    "@types/node": "20.17.24",
+    "@types/eslint": "8.56.12",
     "@vitest/coverage-v8": "2.1.9",
     "eslint": "8.57.1",
-    "jscodeshift": "17.1.2",
     "vitest": "2.1.9",
+    "eslint-plugin-vue": "9.25.0",
     "vue-eslint-parser": "9.3.2"
   },
   "peerDependencies": {

package/rules/deprecation-currency-default-slot/deprecation-currency-default-slot.js

@@ -1,6 +1,15 @@
+/**
+ * @typedef {import('eslint').Rule.RuleContext} RuleContext
+ */
+
+/**
+ * @typedef {import('eslint-plugin-vue/lib/utils').RuleModule} RuleModule
+ */
+
 const VueUtils = require('eslint-plugin-vue/lib/utils');
 const { componentSlotMigration } = require('../../utils/component-slot-migration');
 
+/** @type {RuleModule} */
 module.exports = {
     meta: {
         type: 'suggestion',
@@ -16,8 +25,11 @@ module.exports = {
         fixable: 'code',
         schema: [], // No options are needed for this rule
     },
+
+    /** @param {RuleContext} context */
     create(context) {
         const sourceCode = context.getSourceCode();
+
         const template =
             sourceCode.parserServices.getTemplateBodyTokenStore &&
             sourceCode.parserServices.getTemplateBodyTokenStore();

package/rules/deprecation-tag-default-slot/deprecation-tag-default-slot.js

@@ -1,6 +1,15 @@
+/**
+ * @typedef {import('eslint').Rule.RuleContext} RuleContext
+ */
+
+/**
+ * @typedef {import('eslint-plugin-vue/lib/utils').RuleModule} RuleModule
+ */
+
 const VueUtils = require('eslint-plugin-vue/lib/utils');
 const { componentSlotMigration } = require('../../utils/component-slot-migration');
 
+/** @type {RuleModule} */
 module.exports = {
     meta: {
         type: 'suggestion',
@@ -16,6 +25,8 @@ module.exports = {
         fixable: 'code',
         schema: [], // No options are needed for this rule
     },
+
+    /** @param {RuleContext} context */
     create(context) {
         const sourceCode = context.getSourceCode();
         const template =

package/rules/vue-old-spacer-tokens/vue-old-spacer-tokens.js

@@ -1,3 +1,16 @@
+/**
+ * @typedef {import('eslint').Rule.RuleContext} RuleContext
+ */
+/**
+ * @typedef {import('estree').Node} Node
+ */
+/**
+ * @typedef {import('vue-eslint-parser/ast').VLiteral} VLiteral
+ */
+/**
+ * @typedef {import('eslint-plugin-vue/lib/utils').RuleModule} RuleModule
+ */
+
 const VueUtils = require('eslint-plugin-vue/lib/utils');
 
 // Mappings for the classes that can to be replaced
@@ -15,6 +28,7 @@ const CLASS_MAP = {
     '64': '140',
 };
 
+/** @type {RuleModule} */
 module.exports = {
     meta: {
         type: 'suggestion', // The type can be "problem", "suggestion", or "layout"
@@ -30,16 +44,17 @@ module.exports = {
         fixable: 'code',
         schema: [], // No options are needed for this rule
     },
+    /** @param {RuleContext} context */
     create(context) {
         return VueUtils.defineTemplateBodyVisitor(context, {
-            VLiteral: node => {
+            VLiteral: (/** @type {any} */ node) => {
                 if (typeof node.value === 'string') {
                     let hasReplacements = false;
-                    const classList = node.value;
+                    const classList = /** @type {VLiteral['value']} */ node.value;
 
                     const fixed = classList
                         .split(' ')
-                        .map(cssClass => {
+                        .map((/** @type {VLiteral['value']} */ cssClass) => {
                             // Check if the class list has "padding" or "margin" utilities
                             const regexPaddingMargin = /\bu-(padding|margin)\b/g;
                             if (regexPaddingMargin.test(cssClass)) {

package/utils/component-slot-migration.js

@@ -1,12 +1,28 @@
 const j = require('jscodeshift');
 
+/**
+ * @typedef {import('eslint').Rule.RuleContext} RuleContext
+ * @typedef {import('eslint').AST.Token} Token
+ */
+
+/**
+ * @typedef {import('vue-eslint-parser/ast').VText} VText
+ * @typedef {import('vue-eslint-parser/ast').VExpressionContainer} VExpressionContainer
+ */
+
+/**
+ * @typedef { { propertyName: string, context: RuleContext, template: any, alwaysExpression?: boolean } } ComponentSlotMigrationProps
+ * @typedef { (node: any) => void } ComponentSlotMigrationReturn
+ */
+
 module.exports = {
     /**
      * Generates a report with a fix to those VElements containing a deprecated default slot.
      *
      * It moves the content of the "default" slot into a prop with the "propertyName" value.
      *
-     * @param props Contains the name of the property by which it will be replace and the context
+     * @param {ComponentSlotMigrationProps} props Contains the name of the property by which it will be replace and the context
+     * @returns {ComponentSlotMigrationReturn}
      */
     componentSlotMigration({ propertyName, context, template, alwaysExpression = false }) {
         return node => {
@@ -17,6 +33,11 @@ module.exports = {
             // Turned true if one of the children is an expression
             let hasExpression = false;
 
+            /**
+             * @param {VText | VExpressionContainer } node
+             * @param {boolean} wrapStringLiteral
+             * @returns {string | undefined}
+             */
             function transformNodeToText(node, wrapStringLiteral = false) {
                 if (node.type === 'VText') {
                     return node.value;
@@ -31,6 +52,10 @@ module.exports = {
                 }
             }
 
+            /**
+             * @param { VText | VExpressionContainer } node
+             * @returns {boolean}
+             */
             function removeEmptyVTextNodes(node) {
                 if (node.type === 'VText') {
                     return !!node.value.trim().length;
@@ -40,9 +65,11 @@ module.exports = {
             }
 
             // Opening tag closing brace ">"
+            /** @type {Token} */
             const closingBrace = template.getLastToken(node.startTag);
 
             // Remove empty nodes
+            /** @type { Array<VText | VExpressionContainer> } */
             const filteredNodes = node.children.filter(removeEmptyVTextNodes);
 
             // Get all content and concat
@@ -52,7 +79,7 @@ module.exports = {
                 }
 
                 const content = node.children
-                    .map(node => transformNodeToText(node, true))
+                    .map((/** @type {VText | VExpressionContainer} */ node) => transformNodeToText(node, true))
                     .join('')
                     .trim();