@adyen/eslint-plugin-bento 2.8.0 → 2.10.0

package/rules/deprecation-components-error-prop/README.md

@@ -0,0 +1,43 @@
+# deprecation-components-error-prop
+
+## Description
+
+The `error` prop in the following components is deprecated:
+
+- `bento-dropdown`
+- `bento-input-field`
+- `bento-input-field-phone-number`
+
+Please use `error-message` instead.
+
+## Rule Details
+
+This rule reports usages of the deprecated item.
+
+### ❌ Incorrect
+
+```html
+<bento-dropdown error="value" /> <bento-dropdown :error="value" />
+```
+
+```html
+<bento-input-field error="value" /> <bento-input-field :error="value" />
+```
+
+```html
+<bento-input-field-phone-number error="value" /> <bento-input-field-phone-number :error="value" />
+```
+
+### ✅ Correct
+
+```html
+<bento-dropdown error-message="value" />
+```
+
+```html
+<bento-input-field error-message="value" />
+```
+
+```html
+<bento-input-field-phone-number error-message="value" />
+```

package/rules/deprecation-components-error-prop/__tests__/deprecation-components-error-prop.vue

@@ -0,0 +1,17 @@
+<template>
+    <div>
+        <bento-dropdown error="value" />
+        <bento-dropdown :error="value" />
+        <bento-dropdown :error="value" />
+
+        <bento-input-field error="value" />
+        <bento-input-field :error="value" />
+        <bento-input-field :error="value" />
+
+        <bento-input-field-phone-number error="value" />
+        <bento-input-field-phone-number :error="value" />
+        <bento-input-field-phone-number :error="value" />
+    </div>
+</template>
+
+<script setup></script>

package/rules/deprecation-components-error-prop/__tests__/eslint.config.js

@@ -0,0 +1,26 @@
+// eslint.config.js
+const { defineConfig } = require('eslint/config');
+const vueParser = require('vue-eslint-parser');
+const tsParser = require('@typescript-eslint/parser');
+const adyenBento = require('@adyen/eslint-plugin-bento');
+
+module.exports = defineConfig([
+    {
+        languageOptions: {
+            ecmaVersion: 'latest',
+            sourceType: 'module',
+            parser: vueParser,
+            parserOptions: {
+                parser: tsParser,
+            },
+        },
+        plugins: {
+            '@adyen/bento': adyenBento,
+        },
+        rules: {
+            // Register the specific rule we are testing
+            '@adyen/bento/deprecation-components-error-prop': ['warn', { autofix: true }],
+        },
+        files: ['**/*.vue'],
+    },
+]);

package/rules/deprecation-components-error-prop/deprecation-components-error-prop.integration.test.ts

@@ -0,0 +1,37 @@
+import path from 'node:path';
+import { execFileSyncEslintVueFiles } from '../../utils/exec-file-sync-eslint-vue-files';
+
+describe('@adyen/bento/deprecation-components-error-prop', () => {
+    it('should lint with warning', () => {
+        // Load .eslintrc
+        const eslintrc = path.resolve(__dirname, '__tests__', 'eslint.config.js');
+        // Load the test file generated alongside this one
+        const vueFile = path.resolve(__dirname, '__tests__', 'deprecation-components-error-prop.vue');
+
+        // Execute the linter
+        const result = JSON.parse(execFileSyncEslintVueFiles(eslintrc, vueFile));
+
+        /* ------------------------------------------------ */
+        /* CASE 2: SINGLE REPLACEMENT                       */
+        /* ------------------------------------------------ */
+
+        // For props, we generate 3 examples (static, shorthand, longhand) FOR EACH component.
+        // Total = (Number of Components) * 3
+        const numberOfComponents = 3;
+        expect(result[0].warningCount).toBe(numberOfComponents * 3);
+
+        // Verify the message structure on the first error found.
+        // Since the rule is the same for all components, checking the first one confirms the message is correct.
+        expect(result[0].messages[0]).toMatchObject({
+            ruleId: '@adyen/bento/deprecation-components-error-prop',
+            severity: 1,
+
+            messageId: 'deprecation',
+            message: `The "error" prop is deprecated. Please use "error-message" instead.`,
+
+            fix: expect.objectContaining({
+                text: expect.stringContaining('error-message'),
+            }),
+        });
+    });
+});

package/rules/deprecation-components-error-prop/deprecation-components-error-prop.js

@@ -0,0 +1,79 @@
+/**
+ * @typedef {import('eslint').Rule.RuleContext} RuleContext
+ */
+/**
+ * @typedef {import('eslint-plugin-vue/lib/utils').RuleModule} RuleModule
+ */
+
+const VueUtils = require('eslint-plugin-vue/lib/utils');
+
+/** @type {RuleModule} */
+module.exports = {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description:
+                'Deprecates usage of error prop in bento-dropdown, bento-input-field, bento-input-field-phone-number',
+            category: 'Deprecations',
+            url: 'https://github.com/Adyen/bento/blob/main/packages/eslint/rules/deprecation-components-error-prop/README.md',
+            recommended: true,
+        },
+        messages: {
+            deprecation: `The "error" prop is deprecated. Please use "error-message" instead.`,
+        },
+        fixable: 'code',
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    autofix: {
+                        type: 'boolean',
+                        default: false,
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+    },
+
+    /** @param {RuleContext} context */
+    create(context) {
+        const options = context.options[0] || {};
+        const autofix = options.autofix === true;
+
+        /* ------------------------------------------------ */
+        /* CASE 2: PROP DEPRECATION (Multiple Components)   */
+        /* ------------------------------------------------ */
+        return VueUtils.defineTemplateBodyVisitor(context, {
+            // 1. STATIC: value="foo"
+            [`VElement:matches([name="bento-dropdown"], [name="BentoDropdown"], [name="bento-input-field"], [name="BentoInputField"], [name="bento-input-field-phone-number"], [name="BentoInputFieldPhoneNumber"]) > VStartTag > VAttribute[directive=false][key.name="error"]`](
+                node
+            ) {
+                context.report({
+                    node,
+                    messageId: 'deprecation',
+                    ...(autofix && {
+                        fix(fixer) {
+                            return fixer.replaceText(node.key, 'error-message');
+                        },
+                    }),
+                });
+            },
+
+            // 2. DYNAMIC: :value="foo" or v-bind:value="foo"
+            [`VElement:matches([name="bento-dropdown"], [name="BentoDropdown"], [name="bento-input-field"], [name="BentoInputField"], [name="bento-input-field-phone-number"], [name="BentoInputFieldPhoneNumber"]) > VStartTag > VAttribute[directive=true][key.name.name="bind"][key.argument.name="error"]`](
+                node
+            ) {
+                context.report({
+                    node,
+                    messageId: 'deprecation',
+                    ...(autofix && {
+                        fix(fixer) {
+                            return fixer.replaceText(node.key.argument, 'error-message');
+                        },
+                    }),
+                });
+            },
+        });
+    },
+};

package/rules/deprecation-components-error-prop/deprecation-components-error-prop.test.ts

@@ -0,0 +1,120 @@
+import { RuleTester } from 'eslint';
+import vueParser from 'vue-eslint-parser';
+import tsParser from '@typescript-eslint/parser';
+import deprecationComponentsErrorProp from './deprecation-components-error-prop';
+
+const ruleTester = new RuleTester({
+    languageOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+        parser: vueParser,
+        parserOptions: {
+            parser: tsParser,
+        },
+    },
+});
+
+describe('@adyen/bento/deprecation-components-error-prop', () => {
+    ruleTester.run('deprecation-components-error-prop', deprecationComponentsErrorProp, {
+        valid: [
+            {
+                name: 'Valid usage for bento-dropdown',
+                filename: 'test.vue',
+                code: `
+                <template>
+                    <bento-dropdown error-message="val" />
+                </template>
+                `,
+            },
+            {
+                name: 'Valid usage for bento-input-field',
+                filename: 'test.vue',
+                code: `
+                <template>
+                    <bento-input-field error-message="val" />
+                </template>
+                `,
+            },
+            {
+                name: 'Valid usage for bento-input-field-phone-number',
+                filename: 'test.vue',
+                code: `
+                <template>
+                    <bento-input-field-phone-number error-message="val" />
+                </template>
+                `,
+            },
+        ],
+        invalid: [
+            {
+                name: 'Invalid: autofix disabled (explicit false)',
+                filename: 'test.vue',
+                code: `<template><bento-dropdown error="val" /></template>`,
+                output: null,
+                options: [{ autofix: false }],
+                errors: [{ messageId: 'deprecation' }],
+            },
+            {
+                name: 'Invalid: autofix disabled (no options)',
+                filename: 'test.vue',
+                code: `<template><bento-dropdown :error="val" /></template>`,
+                output: null,
+                errors: [{ messageId: 'deprecation' }],
+            },
+            // bento-dropdown: Static
+            {
+                name: 'Invalid: Static prop on bento-dropdown',
+                filename: 'test.vue',
+                code: `<template><bento-dropdown error="val" /></template>`,
+                output: `<template><bento-dropdown error-message="val" /></template>`,
+                options: [{ autofix: true }],
+                errors: [{ messageId: 'deprecation' }],
+            },
+            // bento-dropdown: Shorthand
+            {
+                name: 'Invalid: Dynamic prop on bento-dropdown',
+                filename: 'test.vue',
+                code: `<template><bento-dropdown :error="val" /></template>`,
+                output: `<template><bento-dropdown :error-message="val" /></template>`,
+                options: [{ autofix: true }],
+                errors: [{ messageId: 'deprecation' }],
+            },
+            // bento-input-field: Static
+            {
+                name: 'Invalid: Static prop on bento-input-field',
+                filename: 'test.vue',
+                code: `<template><bento-input-field error="val" /></template>`,
+                output: `<template><bento-input-field error-message="val" /></template>`,
+                options: [{ autofix: true }],
+                errors: [{ messageId: 'deprecation' }],
+            },
+            // bento-input-field: Shorthand
+            {
+                name: 'Invalid: Dynamic prop on bento-input-field',
+                filename: 'test.vue',
+                code: `<template><bento-input-field :error="val" /></template>`,
+                output: `<template><bento-input-field :error-message="val" /></template>`,
+                options: [{ autofix: true }],
+                errors: [{ messageId: 'deprecation' }],
+            },
+            // bento-input-field-phone-number: Static
+            {
+                name: 'Invalid: Static prop on bento-input-field-phone-number',
+                filename: 'test.vue',
+                code: `<template><bento-input-field-phone-number error="val" /></template>`,
+                output: `<template><bento-input-field-phone-number error-message="val" /></template>`,
+                options: [{ autofix: true }],
+                errors: [{ messageId: 'deprecation' }],
+            },
+            // bento-input-field-phone-number: Shorthand
+            {
+                name: 'Invalid: Dynamic prop on bento-input-field-phone-number',
+                filename: 'test.vue',
+                code: `<template><bento-input-field-phone-number :error="val" /></template>`,
+                output: `<template><bento-input-field-phone-number :error-message="val" /></template>`,
+                options: [{ autofix: true }],
+                errors: [{ messageId: 'deprecation' }],
+            },
+        ],
+    });
+});

package/rules/deprecation-components-has-error-prop/README.md

@@ -0,0 +1,34 @@
+# deprecation-components-has-error-prop
+
+## Description
+
+The `hasError` prop in the following components is deprecated:
+
+- `bento-checkbox-group`
+- `bento-radio-group`
+
+Please use `errorMessage` instead.
+
+## Rule Details
+
+This rule reports usages of the deprecated item.
+
+### ❌ Incorrect
+
+```html
+<bento-checkbox-group has-error="value" /> <bento-checkbox-group :has-error="value" />
+```
+
+```html
+<bento-radio-group has-error="value" /> <bento-radio-group :has-error="value" />
+```
+
+### ✅ Correct
+
+```html
+<bento-checkbox-group errorMessage="value" />
+```
+
+```html
+<bento-radio-group errorMessage="value" />
+```

package/rules/deprecation-components-has-error-prop/__tests__/deprecation-components-has-error-prop.vue

@@ -0,0 +1,13 @@
+<template>
+    <div>
+        <bento-checkbox-group has-error="value" />
+        <bento-checkbox-group :has-error="value" />
+        <bento-checkbox-group :has-error="value" />
+
+        <bento-radio-group has-error="value" />
+        <bento-radio-group :has-error="value" />
+        <bento-radio-group :has-error="value" />
+    </div>
+</template>
+
+<script setup></script>

package/rules/deprecation-components-has-error-prop/__tests__/eslint.config.js

@@ -0,0 +1,26 @@
+// eslint.config.js
+const { defineConfig } = require('eslint/config');
+const vueParser = require('vue-eslint-parser');
+const tsParser = require('@typescript-eslint/parser');
+const adyenBento = require('@adyen/eslint-plugin-bento');
+
+module.exports = defineConfig([
+    {
+        languageOptions: {
+            ecmaVersion: 'latest',
+            sourceType: 'module',
+            parser: vueParser,
+            parserOptions: {
+                parser: tsParser,
+            },
+        },
+        plugins: {
+            '@adyen/bento': adyenBento,
+        },
+        rules: {
+            // Register the specific rule we are testing
+            '@adyen/bento/deprecation-components-has-error-prop': 'warn',
+        },
+        files: ['**/*.vue'],
+    },
+]);

package/rules/deprecation-components-has-error-prop/deprecation-components-has-error-prop.integration.test.ts

@@ -0,0 +1,29 @@
+import path from 'node:path';
+import { execFileSyncEslintVueFiles } from '../../utils/exec-file-sync-eslint-vue-files';
+
+describe('@adyen/bento/deprecation-components-has-error-prop', () => {
+    it('should lint with warning', () => {
+        // Load .eslintrc
+        const eslintrc = path.resolve(__dirname, '__tests__', 'eslint.config.js');
+        // Load the test file generated alongside this one
+        const vueFile = path.resolve(__dirname, '__tests__', 'deprecation-components-has-error-prop.vue');
+
+        // Execute the linter
+        const result = JSON.parse(execFileSyncEslintVueFiles(eslintrc, vueFile));
+
+        // 3 examples (static, shorthand, longhand) FOR EACH component.
+        // Total = 2 components * 3 = 6
+        expect(result[0].warningCount).toBe(6);
+
+        expect(result[0].messages[0]).toMatchObject({
+            ruleId: '@adyen/bento/deprecation-components-has-error-prop',
+            severity: 1,
+
+            messageId: 'deprecation',
+            message: `The "has-error" prop is deprecated. Please use "error-message" instead.`,
+        });
+
+        // Without autofix option, no fix should be present
+        expect(result[0].messages[0].fix).toBeUndefined();
+    });
+});

package/rules/deprecation-components-has-error-prop/deprecation-components-has-error-prop.js

@@ -0,0 +1,77 @@
+/**
+ * @typedef {import('eslint').Rule.RuleContext} RuleContext
+ */
+/**
+ * @typedef {import('eslint-plugin-vue/lib/utils').RuleModule} RuleModule
+ */
+
+const VueUtils = require('eslint-plugin-vue/lib/utils');
+
+/** @type {RuleModule} */
+module.exports = {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'Deprecates usage of hasError prop in bento-checkbox-group, bento-radio-group',
+            category: 'Deprecations',
+            url: 'https://github.com/Adyen/bento/blob/main/packages/eslint/rules/deprecation-components-has-error-prop/README.md',
+            recommended: true,
+        },
+        messages: {
+            deprecation: `The "has-error" prop is deprecated. Please use "error-message" instead.`,
+        },
+        fixable: 'code',
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    autofix: {
+                        type: 'boolean',
+                        default: false,
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+    },
+
+    /** @param {RuleContext} context */
+    create(context) {
+        const options = context.options[0] || {};
+        const autofix = options.autofix === true;
+        /* ------------------------------------------------ */
+        /* CASE 2: PROP DEPRECATION (Multiple Components)   */
+        /* ------------------------------------------------ */
+        return VueUtils.defineTemplateBodyVisitor(context, {
+            // 1. STATIC: value="foo"
+            [`VElement:matches([name="bento-checkbox-group"], [name="BentoCheckboxGroup"], [name="bento-radio-group"], [name="BentoRadioGroup"]) > VStartTag > VAttribute[directive=false][key.name="has-error"]`](
+                node
+            ) {
+                context.report({
+                    node,
+                    messageId: 'deprecation',
+                    ...(autofix && {
+                        fix(fixer) {
+                            return fixer.replaceText(node.key, 'error-message');
+                        },
+                    }),
+                });
+            },
+
+            // 2. DYNAMIC: :value="foo" or v-bind:value="foo"
+            [`VElement:matches([name="bento-checkbox-group"], [name="BentoCheckboxGroup"], [name="bento-radio-group"], [name="BentoRadioGroup"]) > VStartTag > VAttribute[directive=true][key.name.name="bind"][key.argument.name="has-error"]`](
+                node
+            ) {
+                context.report({
+                    node,
+                    messageId: 'deprecation',
+                    ...(autofix && {
+                        fix(fixer) {
+                            return fixer.replaceText(node.key.argument, 'error-message');
+                        },
+                    }),
+                });
+            },
+        });
+    },
+};

package/rules/deprecation-components-has-error-prop/deprecation-components-has-error-prop.test.ts

@@ -0,0 +1,133 @@
+import { RuleTester } from 'eslint';
+import vueParser from 'vue-eslint-parser';
+import tsParser from '@typescript-eslint/parser';
+import deprecationComponentsHasErrorProp from './deprecation-components-has-error-prop';
+
+const ruleTester = new RuleTester({
+    languageOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+        parser: vueParser,
+        parserOptions: {
+            parser: tsParser,
+        },
+    },
+});
+
+describe('@adyen/bento/deprecation-components-has-error-prop', () => {
+    ruleTester.run('deprecation-components-has-error-prop', deprecationComponentsHasErrorProp, {
+        valid: [
+            {
+                name: 'Valid usage for bento-checkbox-group',
+                filename: 'test.vue',
+                code: `
+                <template>
+                    <bento-checkbox-group errorMessage="val" />
+                </template>
+                `,
+            },
+            {
+                name: 'Valid usage for bento-radio-group',
+                filename: 'test.vue',
+                code: `
+                <template>
+                    <bento-radio-group errorMessage="val" />
+                </template>
+                `,
+            },
+        ],
+        invalid: [
+            // bento-checkbox-group: Static
+            {
+                name: 'Invalid: Static prop on bento-checkbox-group',
+                filename: 'test.vue',
+                code: `<template><bento-checkbox-group has-error="val" /></template>`,
+                errors: [{ messageId: 'deprecation' }],
+            },
+            // bento-checkbox-group: Shorthand
+            {
+                name: 'Invalid: Dynamic prop on bento-checkbox-group',
+                filename: 'test.vue',
+                code: `<template><bento-checkbox-group :has-error="val" /></template>`,
+                errors: [{ messageId: 'deprecation' }],
+            },
+            // bento-radio-group: Static
+            {
+                name: 'Invalid: Static prop on bento-radio-group',
+                filename: 'test.vue',
+                code: `<template><bento-radio-group has-error="val" /></template>`,
+                errors: [{ messageId: 'deprecation' }],
+            },
+            // bento-radio-group: Shorthand
+            {
+                name: 'Invalid: Dynamic prop on bento-radio-group',
+                filename: 'test.vue',
+                code: `<template><bento-radio-group :has-error="val" /></template>`,
+                errors: [{ messageId: 'deprecation' }],
+            },
+        ],
+    });
+
+    /* ------------------------------------------------ */
+    /* AUTOFIX TESTS                                    */
+    /* ------------------------------------------------ */
+    ruleTester.run('deprecation-components-has-error-prop (autofix enabled)', deprecationComponentsHasErrorProp, {
+        valid: [
+            {
+                name: 'Valid: error-message prop on bento-checkbox-group (autofix enabled)',
+                filename: 'test.vue',
+                options: [{ autofix: true }],
+                code: `<template><bento-checkbox-group error-message="val" /></template>`,
+            },
+        ],
+        invalid: [
+            {
+                name: 'Autofix: static prop on bento-checkbox-group',
+                filename: 'test.vue',
+                options: [{ autofix: true }],
+                code: `<template><bento-checkbox-group has-error="val" /></template>`,
+                output: `<template><bento-checkbox-group error-message="val" /></template>`,
+                errors: [{ messageId: 'deprecation' }],
+            },
+            {
+                name: 'Autofix: dynamic prop on bento-checkbox-group',
+                filename: 'test.vue',
+                options: [{ autofix: true }],
+                code: `<template><bento-checkbox-group :has-error="val" /></template>`,
+                output: `<template><bento-checkbox-group :error-message="val" /></template>`,
+                errors: [{ messageId: 'deprecation' }],
+            },
+            {
+                name: 'Autofix: static prop on bento-radio-group',
+                filename: 'test.vue',
+                options: [{ autofix: true }],
+                code: `<template><bento-radio-group has-error="val" /></template>`,
+                output: `<template><bento-radio-group error-message="val" /></template>`,
+                errors: [{ messageId: 'deprecation' }],
+            },
+            {
+                name: 'Autofix: dynamic prop on bento-radio-group',
+                filename: 'test.vue',
+                options: [{ autofix: true }],
+                code: `<template><bento-radio-group :has-error="val" /></template>`,
+                output: `<template><bento-radio-group :error-message="val" /></template>`,
+                errors: [{ messageId: 'deprecation' }],
+            },
+            {
+                name: 'Autofix: v-bind longhand on bento-radio-group',
+                filename: 'test.vue',
+                options: [{ autofix: true }],
+                code: `<template><bento-radio-group v-bind:has-error="val" /></template>`,
+                output: `<template><bento-radio-group v-bind:error-message="val" /></template>`,
+                errors: [{ messageId: 'deprecation' }],
+            },
+            {
+                name: 'Autofix: does not fix when autofix is false',
+                filename: 'test.vue',
+                options: [{ autofix: false }],
+                code: `<template><bento-checkbox-group has-error="val" /></template>`,
+                errors: [{ messageId: 'deprecation' }],
+            },
+        ],
+    });
+});

package/rules/deprecation-components-input-emit/__tests__/eslint.config.js

@@ -18,7 +18,7 @@ module.exports = defineConfig([
         },
         rules: {
             // Register the specific rule we are testing
-            '@adyen/bento/deprecation-components-input-emit': 'warn',
+            '@adyen/bento/deprecation-components-input-emit': ['warn', { autofix: true }],
         },
         files: ['**/*.vue'],
     },