@adyen/eslint-plugin-bento 1.3.0 → 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,79 @@
+# Changelog
+
+## [2.0.0](https://github.com/Adyen/bento/compare/eslint-plugin-bento-v1.3.0...eslint-plugin-bento-v2.0.0) (2025-05-14)
+
+
+### ⚠ BREAKING CHANGES
+
+* **eslint:** migrated `@adyen/bento-eslint` to `eslint@9`
+
+### Miscellaneous Chores
+
+* **eslint:** migrated `@adyen/bento-eslint` to `eslint@9` ([d8d390e](https://github.com/Adyen/bento/commit/d8d390eed5272a7f1c4e6ed6d9bbb71dc8f4b9a6))
+
+## [1.3.0](https://github.com/Adyen/bento/compare/eslint-plugin-bento-v1.2.0...eslint-plugin-bento-v1.3.0) (2025-04-16)
+
+
+### Features
+
+* **eslint:** added javascript type support to ESLint rules package ([0420b72](https://github.com/Adyen/bento/commit/0420b727b491a2ba8179149d5585f8c58a701fc5))
+
+
+### Bug Fixes
+
+* **eslint:** moved `jscodeshift` as dependency to fix issue with dependencies ([fe41f4b](https://github.com/Adyen/bento/commit/fe41f4bc5d91f119ca37a47e29c6651ba35229de))
+
+
+### Miscellaneous Chores
+
+* added `vue-eslint-parser` as dev dep to Vue2 package to re-enable ESlint on VSCodium ([f6a5aea](https://github.com/Adyen/bento/commit/f6a5aeaf03292ff78f805a8f64653a6db6102f05))
+
+## [1.2.0](https://github.com/Adyen/bento/compare/eslint-plugin-bento-v1.1.0...eslint-plugin-bento-v1.2.0) (2025-04-09)
+
+
+### Features
+
+* **eslint:** added new cases to be covered by `currency` & `tag` slot deprecation rules ([b4e86a6](https://github.com/Adyen/bento/commit/b4e86a68cb34c9295248e95eb2002abfaf5d7805))
+
+
+### Bug Fixes
+
+* **eslint:** corrected export module from `componentSlotMigration` util ([3321662](https://github.com/Adyen/bento/commit/33216626557496d6cad80aeaecdcefb7a0cde122))
+
+## [1.1.0](https://github.com/Adyen/bento/compare/eslint-plugin-bento-v1.0.3...eslint-plugin-bento-v1.1.0) (2025-04-02)
+
+
+### Features
+
+* **eslint:** added rule to disable the usage of `default` slot in `bento-currency` ([1914017](https://github.com/Adyen/bento/commit/19140179c47de9eeba6a17b94962646c93815004))
+* **eslint:** added rule to disable the usage of `default` slot in `bento-tag` ([1914017](https://github.com/Adyen/bento/commit/19140179c47de9eeba6a17b94962646c93815004))
+
+## [1.0.3](https://github.com/Adyen/bento/compare/eslint-plugin-bento-v1.0.2...eslint-plugin-bento-v1.0.3) (2025-03-26)
+
+
+### Miscellaneous Chores
+
+* fixed all PNPM script parameters ([123269d](https://github.com/Adyen/bento/commit/123269d9cbaa791e0984074845c227c21125e864))
+
+## [1.0.2](https://github.com/Adyen/bento/compare/eslint-plugin-bento-v1.0.1...eslint-plugin-bento-v1.0.2) (2024-12-04)
+
+
+### Miscellaneous Chores
+
+* replaced `airbnb-base` with `eslint:recommended` `eslint` rules ([762ebf5](https://github.com/Adyen/bento/commit/762ebf549ca6f0baadb7a6c7b96bebe1084a57ee))
+* updated `vitest` to `2.1.4` ([b615334](https://github.com/Adyen/bento/commit/b6153346e284cc2230119c4b5ca25a2f6786d844))
+
+## [1.0.1](https://github.com/Adyen/bento/compare/eslint-plugin-bento-v1.0.0...eslint-plugin-bento-v1.0.1) (2024-11-13)
+
+
+### Bug Fixes
+
+* **eslint:** aligned `@adyen/eslint-plugin-bento` deps with main repo ([bf0c98e](https://github.com/Adyen/bento/commit/bf0c98e7144740b6f937cfd296114b09f1039f20))
+* **eslint:** prevented `vue-old-spacer-tokens` from overwriting all classes with `b-` ([74ff227](https://github.com/Adyen/bento/commit/74ff2272371ce85d0a486b88830ed280dfc099bd))
+
+## 1.0.0 (2024-11-06)
+
+
+### Features
+
+* **eslint:** added ESLint Bento rule set package ([0339bc3](https://github.com/Adyen/bento/commit/0339bc3db17a220d9b252bfe3d8a51e6561bfba8))

package/README.md

@@ -5,42 +5,77 @@ The Bento ESLint package helps improving the usage of Bento components and utili
 ## Installation
 
 ```bash
-npm install --save-dev eslint@8 vue-eslint-parser@7 @adyen/eslint-plugin-bento
+npm install --save-dev eslint@9 vue-eslint-parser@10 @adyen/eslint-plugin-bento@2
 ```
 
 <!-- prettier-ignore -->
 > Requirements
 >
-> ESLint v6.0.0 up to v8.0.0
-> Node.js v12.22.x, v14.17.x, v16.x and above
-> `vue-eslint-parser` v7.0.0
+> ESLint v9.0.0
+> Node.js v20.x and above
+> `vue-eslint-parser` v10.0.0
 
 ## Usage
 
-The `@adyen/bento` plugin hasn't been tested in ESLint9 nor with the flat config (i.e. `eslint.config.js`).
+### Flat config recommended (`eslint.config.js`)
 
-### Legacy Config (`.eslintrc`)
+All rules are set to `warn`
 
 ```javascript
-module.exports = {
-    extends: ['plugin:@adyen/bento/recommended'],
-    rules: {
-        // override/add rules settings here, such as:
-        // '@adyen/bento/spacer-tokens': 'error',
+const { defineConfig } = require('eslint/config');
+const parser = require('vue-eslint-parser');
+const bento = require('@adyen/eslint-plugin-bento');
+
+module.exports = defineConfig([
+    {
+        // Other configs
     },
-};
+    ...bento.configs['vue-recommended'],
+]);
 ```
 
-or without the recommended config:
+### Flat config strict
+
+All rules are set to `err`
+
+```javascript
+const { defineConfig } = require('eslint/config');
+const parser = require('vue-eslint-parser');
+const bento = require('@adyen/eslint-plugin-bento');
+
+module.exports = defineConfig([
+    {
+        // Other configs
+    },
+    ...bento.configs['vue-strict'],
+]);
+```
+
+### Custom
+
+Without the recommended configs:
 
 ```javascript
-module.exports = {
-    parser: 'vue-eslint-parser',
-    plugins: ['@adyen/bento'],
-    rules: {
-        '@adyen/bento/vue-old-spacer-tokens': 'warn',
+const { defineConfig } = require('eslint/config');
+const vueParser = require('vue-eslint-parser');
+const bento = require('@adyen/eslint-plugin-bento');
+
+module.exports = defineConfig([
+    {
+        languageOptions: {
+            parser: vueParser,
+        },
+        plugins: {
+            '@adyen/bento': bento,
+        },
+        rules: {
+            '@adyen/bento/vue-old-spacer-tokens': 'warn',
+            '@adyen/bento/deprecation-currency-default-slot': 'warn'
+            '@adyen/bento/deprecation-tag-default-slot': 'warn'
+        },
+        files: ['**/*.vue'],
     },
-};
+]);
 ```
 
 ## Rules
@@ -53,7 +88,7 @@ Disallow the use of ADL space utility classes in favor of Bento _spacer_ utility
 
 The recommended configuration contains pre-configured rules and their severity
 
--   `@adyen/bento/vue-old-spacer-tokens`: `warn`
+- `@adyen/bento/vue-old-spacer-tokens`: `warn`
 
 ### `@adyen/bento/deprecation-currency-default-slot`
 
@@ -63,7 +98,7 @@ Disallow the use of the `default` slot in `bento-currency` instances
 
 The recommended configuration contains pre-configured rules and their severity
 
--   `@adyen/bento/deprecation-currency-default-slot`: `warn`
+- `@adyen/bento/deprecation-currency-default-slot`: `warn`
 
 ### `@adyen/bento/deprecation-tag-default-slot`
 
@@ -73,4 +108,4 @@ Disallow the use of the `default` slot in `bento-tag` instances
 
 The recommended configuration contains pre-configured rules and their severity
 
--   `@adyen/bento/deprecation-tag-default-slot`: `warn`
+- `@adyen/bento/deprecation-tag-default-slot`: `warn`

package/configs/vue-recommended.js

@@ -0,0 +1,19 @@
+module.exports = [
+    {
+        name: '@bento/adyen/recommended',
+        files: ['*.vue', '**/*.vue'],
+        languageOptions: {
+            parser: require('vue-eslint-parser'),
+        },
+        plugins: {
+            get '@adyen/bento'() {
+                return require('../index');
+            },
+        },
+        rules: {
+            '@adyen/bento/deprecation-currency-default-slot': 'warn',
+            '@adyen/bento/deprecation-tag-default-slot': 'warn',
+            '@adyen/bento/vue-old-spacer-tokens': 'warn',
+        },
+    },
+];

package/configs/vue-strict.js

@@ -0,0 +1,19 @@
+module.exports = [
+    {
+        name: '@bento/adyen/strict',
+        files: ['*.vue', '**/*.vue'],
+        languageOptions: {
+            parser: require('vue-eslint-parser'),
+        },
+        plugins: {
+            get '@adyen/bento'() {
+                return require('../index');
+            },
+        },
+        rules: {
+            '@adyen/bento/deprecation-currency-default-slot': 'error',
+            '@adyen/bento/deprecation-tag-default-slot': 'error',
+            '@adyen/bento/vue-old-spacer-tokens': 'error',
+        },
+    },
+];

package/index.js

@@ -1,30 +1,20 @@
-const fs = require('fs');
-const deprecationCurrencyDefaultSlot = require('./rules/deprecation-currency-default-slot/deprecation-currency-default-slot');
-const deprecationTagDefaultSlot = require('./rules/deprecation-tag-default-slot/deprecation-tag-default-slot');
-const spacerTokens = require('./rules/vue-old-spacer-tokens/vue-old-spacer-tokens');
-
 // The package name and version must be in sync with 'package.json'
-const pkg = JSON.parse(fs.readFileSync('./package.json', 'utf8'));
+const pkg = require('./package.json');
 
-module.exports = {
+const plugin = {
     meta: {
         name: pkg.name,
         version: pkg.version,
     },
     configs: {
-        recommended: {
-            parser: 'vue-eslint-parser',
-            plugins: ['@adyen/bento'],
-            rules: {
-                '@adyen/bento/deprecation-currency-default-slot': 'warn',
-                '@adyen/bento/deprecation-tag-default-slot': 'warn',
-                '@adyen/bento/vue-old-spacer-tokens': 'warn',
-            },
-        },
+        'vue-recommended': require('./configs/vue-recommended'),
+        'vue-strict': require('./configs/vue-strict'),
     },
     rules: {
-        'deprecation-currency-default-slot': deprecationCurrencyDefaultSlot,
-        'deprecation-tag-default-slot': deprecationTagDefaultSlot,
-        'vue-old-spacer-tokens': spacerTokens,
+        'deprecation-currency-default-slot': require('./rules/deprecation-currency-default-slot/deprecation-currency-default-slot'),
+        'deprecation-tag-default-slot': require('./rules/deprecation-tag-default-slot/deprecation-tag-default-slot'),
+        'vue-old-spacer-tokens': require('./rules/vue-old-spacer-tokens/vue-old-spacer-tokens'),
     },
 };
+
+module.exports = plugin;

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@adyen/eslint-plugin-bento",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "description": "Adyen Bento ESLint rules",
   "main": "index.js",
   "files": [
+    "README.md",
+    "CHANGELOG.md",
+    "configs",
     "index.js",
     "rules/*",
     "utils/*",
@@ -22,21 +25,26 @@
     "jscodeshift": "17.1.2"
   },
   "devDependencies": {
+    "@eslint/js": "9.24.0",
+    "@types/eslint": "9.6.1",
     "@types/estree": "1.0.6",
     "@types/node": "20.17.24",
-    "@types/eslint": "8.56.12",
+    "@typescript-eslint/eslint-plugin": "8.26.0",
+    "@typescript-eslint/parser": "8.26.0",
+    "@vitest/eslint-plugin": "1.1.25",
     "@vitest/coverage-v8": "2.1.9",
-    "eslint": "8.57.1",
+    "eslint": "9.24.0",
+    "eslint-plugin-vue": "10.0.0",
+    "globals": "16.0.0",
     "vitest": "2.1.9",
-    "eslint-plugin-vue": "9.25.0",
-    "vue-eslint-parser": "9.3.2"
+    "vue-eslint-parser": "10.1.3"
   },
   "peerDependencies": {
-    "eslint": "^8.0",
+    "eslint": "^9.0",
     "vue-eslint-parser": "^9.0"
   },
   "scripts": {
-    "lint": "eslint -c ./.eslintrc.js ./ --exit-on-fatal-error",
+    "lint": "eslint -c ./eslint.config.js ./ --exit-on-fatal-error",
     "test": "vitest run --config ./vitest.config.ts",
     "test:coverage": "pnpm run test --coverage",
     "test:watch": "vitest watch"

package/rules/deprecation-currency-default-slot/__tests__/eslint.config.js

@@ -0,0 +1,18 @@
+const { defineConfig } = require('eslint/config');
+const parser = require('vue-eslint-parser');
+const adyenBento = require('@adyen/eslint-plugin-bento');
+
+module.exports = defineConfig([
+    {
+        languageOptions: {
+            parser: parser,
+        },
+        plugins: {
+            '@adyen/bento': adyenBento,
+        },
+        rules: {
+            '@adyen/bento/deprecation-currency-default-slot': 'warn',
+        },
+        files: ['**/*.vue'],
+    },
+]);

package/rules/deprecation-currency-default-slot/deprecation-currency-default-slot.integration.test.ts

@@ -7,7 +7,7 @@ const ESLINT = 'pnpm eslint';
 describe('@adyen/bento/deprecation-currency-default-slot', () => {
     it('should lint with warning', () => {
         // Load .eslintrc
-        const eslintrc = path.resolve(__dirname, '__tests__', '.eslintrc.js');
+        const eslintrc = path.resolve(__dirname, '__tests__', 'eslint.config.js');
         // Load the test file
         const vueFile = path.resolve(__dirname, '__tests__', 'deprecation-currency-default-slot.vue');
 

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

@@ -28,7 +28,7 @@ module.exports = {
 
     /** @param {RuleContext} context */
     create(context) {
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
 
         const template =
             sourceCode.parserServices.getTemplateBodyTokenStore &&

package/rules/deprecation-currency-default-slot/deprecation-currency-default-slot.test.ts

@@ -1,8 +1,11 @@
 import { RuleTester } from 'eslint';
+import vueParser from 'vue-eslint-parser';
 import deprecationCurrencyDefaultSlot from './deprecation-currency-default-slot';
 
 const ruleTester = new RuleTester({
-    parser: require.resolve('vue-eslint-parser'),
+    languageOptions: {
+        parser: vueParser,
+    },
 });
 
 describe('@adyen/bento/deprecation-currency-default-slot should suggest the usage of "label" property instead of "default" slot', () => {

package/rules/deprecation-tag-default-slot/__tests__/eslint.config.js

@@ -0,0 +1,18 @@
+const { defineConfig } = require('eslint/config');
+const parser = require('vue-eslint-parser');
+const adyenBento = require('@adyen/eslint-plugin-bento');
+
+module.exports = defineConfig([
+    {
+        languageOptions: {
+            parser: parser,
+        },
+        plugins: {
+            '@adyen/bento': adyenBento,
+        },
+        rules: {
+            '@adyen/bento/deprecation-tag-default-slot': 'warn',
+        },
+        files: ['**/*.vue'],
+    },
+]);

package/rules/deprecation-tag-default-slot/deprecation-tag-default-slot.integration.test.ts

@@ -7,7 +7,7 @@ const ESLINT = 'pnpm eslint';
 describe('@adyen/bento/deprecation-tag-default-slot', () => {
     it('should lint with warning', () => {
         // Load .eslintrc
-        const eslintrc = path.resolve(__dirname, '__tests__', '.eslintrc.js');
+        const eslintrc = path.resolve(__dirname, '__tests__', 'eslint.config.js');
         // Load the test file
         const vueFile = path.resolve(__dirname, '__tests__', 'deprecation-tag-default-slot.vue');
 

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

@@ -28,7 +28,7 @@ module.exports = {
 
     /** @param {RuleContext} context */
     create(context) {
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
         const template =
             sourceCode.parserServices.getTemplateBodyTokenStore &&
             sourceCode.parserServices.getTemplateBodyTokenStore();

package/rules/deprecation-tag-default-slot/deprecation-tag-default-slot.test.ts

@@ -1,8 +1,11 @@
 import { RuleTester } from 'eslint';
+import vueParser from 'vue-eslint-parser';
 import deprecationTagDefaultSlot from './deprecation-tag-default-slot';
 
 const ruleTester = new RuleTester({
-    parser: require.resolve('vue-eslint-parser'),
+    languageOptions: {
+        parser: vueParser,
+    },
 });
 
 describe('@adyen/bento/deprecation-tag-default-slot should suggest the usage of "label" property instead of "default" slot', () => {

package/rules/vue-old-spacer-tokens/__tests__/eslint.config.js

@@ -0,0 +1,18 @@
+const { defineConfig } = require('eslint/config');
+const parser = require('vue-eslint-parser');
+const adyenBento = require('@adyen/eslint-plugin-bento');
+
+module.exports = defineConfig([
+    {
+        languageOptions: {
+            parser: parser,
+        },
+        plugins: {
+            '@adyen/bento': adyenBento,
+        },
+        rules: {
+            '@adyen/bento/vue-old-spacer-tokens': 'warn',
+        },
+        files: ['**/*.vue'],
+    },
+]);

package/rules/vue-old-spacer-tokens/vue-old-spacer-tokens.integration.test.ts

@@ -6,8 +6,8 @@ const ESLINT = 'pnpm eslint';
 
 describe('@adyen/bento/vue-old-spacer-tokens', () => {
     it('should lint with warning', () => {
-        // Load .eslintrc
-        const eslintrc = path.resolve(__dirname, '__tests__', '.eslintrc.js');
+        // Load eslint.config
+        const eslintrc = path.resolve(__dirname, '__tests__', 'eslint.config.js');
         // Load the test file
         const vueFile = path.resolve(__dirname, '__tests__', 'vue-old-spacer-tokens.vue');
 

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

@@ -5,7 +5,7 @@
  * @typedef {import('estree').Node} Node
  */
 /**
- * @typedef {import('vue-eslint-parser/ast').VLiteral} VLiteral
+ * @typedef {import('vue-eslint-parser').AST.VLiteral} VLiteral
  */
 /**
  * @typedef {import('eslint-plugin-vue/lib/utils').RuleModule} RuleModule
@@ -59,7 +59,6 @@ module.exports = {
                             const regexPaddingMargin = /\bu-(padding|margin)\b/g;
                             if (regexPaddingMargin.test(cssClass)) {
                                 // Loop through the list of classes and replace them
-                                // eslint-disable-next-line no-restricted-syntax
                                 for (const [oldClass, newClass] of Object.entries(CLASS_MAP)) {
                                     // Check if the utility can be fixed/re-mapped
                                     // by checking if the digit has a Bento counterpart

package/rules/vue-old-spacer-tokens/vue-old-spacer-tokens.test.ts

@@ -1,8 +1,11 @@
 import { RuleTester } from 'eslint';
+import vueParser from 'vue-eslint-parser';
 import spacerTokens from './vue-old-spacer-tokens';
 
 const ruleTester = new RuleTester({
-    parser: require.resolve('vue-eslint-parser'),
+    languageOptions: {
+        parser: vueParser,
+    },
 });
 
 describe('@adyen/bento/vue-old-spacer-tokens should suggest a Bento alternative to ADL classes', () => {

package/utils/component-slot-migration.js

@@ -6,8 +6,8 @@ const j = require('jscodeshift');
  */
 
 /**
- * @typedef {import('vue-eslint-parser/ast').VText} VText
- * @typedef {import('vue-eslint-parser/ast').VExpressionContainer} VExpressionContainer
+ * @typedef {import('vue-eslint-parser').AST.VText} VText
+ * @typedef {import('vue-eslint-parser').AST.VExpressionContainer} VExpressionContainer
  */
 
 /**

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

@@ -1,8 +0,0 @@
-module.exports = {
-    env: { es2021: true },
-    parser: 'vue-eslint-parser',
-    plugins: ['@adyen/bento'],
-    rules: {
-        '@adyen/bento/deprecation-currency-default-slot': 'warn',
-    },
-};

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

@@ -1,8 +0,0 @@
-module.exports = {
-    env: { es2021: true },
-    parser: 'vue-eslint-parser',
-    plugins: ['@adyen/bento'],
-    rules: {
-        '@adyen/bento/deprecation-tag-default-slot': 'warn',
-    },
-};

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

@@ -1,8 +0,0 @@
-module.exports = {
-    env: { es2021: true },
-    parser: 'vue-eslint-parser',
-    plugins: ['@adyen/bento'],
-    rules: {
-        '@adyen/bento/vue-old-spacer-tokens': 'warn',
-    },
-};