@adyen/eslint-plugin-bento 2.6.4 → 2.7.0

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

@@ -0,0 +1,160 @@
+# deprecation-components-value-prop
+
+## Description
+
+The `value` prop in the following components is deprecated:
+
+- `bento-date-picker`
+- `bento-date-range-picker`
+- `bento-dropdown`
+- `bento-dropdown-avatar`
+- `bento-dropdown-country`
+- `bento-dropdown-currency`
+- `bento-dropdown-payment-method`
+- `bento-dropdown-tag`
+- `bento-file-uploader`
+- `bento-input-field`
+- `bento-input-field-password`
+- `bento-input-field-phone-number`
+- `bento-checkbox-group`
+- `bento-radio-group`
+- `bento-selection-card-group`
+- `bento-textarea`
+
+Please use `model-value` instead.
+
+## Rule Details
+
+This rule reports usages of the deprecated item.
+
+### ❌ Incorrect
+
+```html
+<bento-date-picker value="value" /> <bento-date-picker :value="value" />
+```
+
+```html
+<bento-date-range-picker value="value" /> <bento-date-range-picker :value="value" />
+```
+
+```html
+<bento-dropdown value="value" /> <bento-dropdown :value="value" />
+```
+
+```html
+<bento-dropdown-avatar value="value" /> <bento-dropdown-avatar :value="value" />
+```
+
+```html
+<bento-dropdown-country value="value" /> <bento-dropdown-country :value="value" />
+```
+
+```html
+<bento-dropdown-currency value="value" /> <bento-dropdown-currency :value="value" />
+```
+
+```html
+<bento-dropdown-payment-method value="value" /> <bento-dropdown-payment-method :value="value" />
+```
+
+```html
+<bento-dropdown-tag value="value" /> <bento-dropdown-tag :value="value" />
+```
+
+```html
+<bento-file-uploader value="value" /> <bento-file-uploader :value="value" />
+```
+
+```html
+<bento-input-field value="value" /> <bento-input-field :value="value" />
+```
+
+```html
+<bento-input-field-password value="value" /> <bento-input-field-password :value="value" />
+```
+
+```html
+<bento-input-field-phone-number value="value" /> <bento-input-field-phone-number :value="value" />
+```
+
+```html
+<bento-checkbox-group value="value" /> <bento-checkbox-group :value="value" />
+```
+
+```html
+<bento-radio-group value="value" /> <bento-radio-group :value="value" />
+```
+
+```html
+<bento-selection-card-group value="value" /> <bento-selection-card-group :value="value" />
+```
+
+```html
+<bento-textarea value="value" /> <bento-textarea :value="value" />
+```
+
+### ✅ Correct
+
+```html
+<bento-date-picker model-value="value" />
+```
+
+```html
+<bento-date-range-picker model-value="value" />
+```
+
+```html
+<bento-dropdown model-value="value" />
+```
+
+```html
+<bento-dropdown-avatar model-value="value" />
+```
+
+```html
+<bento-dropdown-country model-value="value" />
+```
+
+```html
+<bento-dropdown-currency model-value="value" />
+```
+
+```html
+<bento-dropdown-payment-method model-value="value" />
+```
+
+```html
+<bento-dropdown-tag model-value="value" />
+```
+
+```html
+<bento-file-uploader model-value="value" />
+```
+
+```html
+<bento-input-field model-value="value" />
+```
+
+```html
+<bento-input-field-password model-value="value" />
+```
+
+```html
+<bento-input-field-phone-number model-value="value" />
+```
+
+```html
+<bento-checkbox-group model-value="value" />
+```
+
+```html
+<bento-radio-group model-value="value" />
+```
+
+```html
+<bento-selection-card-group model-value="value" />
+```
+
+```html
+<bento-textarea model-value="value" />
+```

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

@@ -0,0 +1,69 @@
+<template>
+    <div>
+        <bento-date-picker value="value" />
+        <bento-date-picker :value="value" />
+        <bento-date-picker :value="value" />
+
+        <bento-date-range-picker value="value" />
+        <bento-date-range-picker :value="value" />
+        <bento-date-range-picker :value="value" />
+
+        <bento-dropdown value="value" />
+        <bento-dropdown :value="value" />
+        <bento-dropdown :value="value" />
+
+        <bento-dropdown-avatar value="value" />
+        <bento-dropdown-avatar :value="value" />
+        <bento-dropdown-avatar :value="value" />
+
+        <bento-dropdown-country value="value" />
+        <bento-dropdown-country :value="value" />
+        <bento-dropdown-country :value="value" />
+
+        <bento-dropdown-currency value="value" />
+        <bento-dropdown-currency :value="value" />
+        <bento-dropdown-currency :value="value" />
+
+        <bento-dropdown-payment-method value="value" />
+        <bento-dropdown-payment-method :value="value" />
+        <bento-dropdown-payment-method :value="value" />
+
+        <bento-dropdown-tag value="value" />
+        <bento-dropdown-tag :value="value" />
+        <bento-dropdown-tag :value="value" />
+
+        <bento-file-uploader value="value" />
+        <bento-file-uploader :value="value" />
+        <bento-file-uploader :value="value" />
+
+        <bento-input-field value="value" />
+        <bento-input-field :value="value" />
+        <bento-input-field :value="value" />
+
+        <bento-input-field-password value="value" />
+        <bento-input-field-password :value="value" />
+        <bento-input-field-password :value="value" />
+
+        <bento-input-field-phone-number value="value" />
+        <bento-input-field-phone-number :value="value" />
+        <bento-input-field-phone-number :value="value" />
+
+        <bento-checkbox-group value="value" />
+        <bento-checkbox-group :value="value" />
+        <bento-checkbox-group :value="value" />
+
+        <bento-radio-group value="value" />
+        <bento-radio-group :value="value" />
+        <bento-radio-group :value="value" />
+
+        <bento-selection-card-group value="value" />
+        <bento-selection-card-group :value="value" />
+        <bento-selection-card-group :value="value" />
+
+        <bento-textarea value="value" />
+        <bento-textarea :value="value" />
+        <bento-textarea :value="value" />
+    </div>
+</template>
+
+<script setup></script>

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

@@ -0,0 +1,25 @@
+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-value-prop': 'warn',
+        },
+        files: ['**/*.vue'],
+    },
+]);

package/rules/deprecation-components-value-prop/deprecation-components-value-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-value-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-value-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 = 16;
+        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-value-prop',
+            severity: 1,
+
+            messageId: 'deprecation',
+            message: `The "value" prop is deprecated. Please use "model-value" instead.`,
+
+            fix: expect.objectContaining({
+                text: expect.stringContaining('model-value'),
+            }),
+        });
+    });
+});

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

@@ -0,0 +1,61 @@
+/**
+ * @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 value prop in bento-date-picker, bento-date-range-picker, bento-dropdown, bento-dropdown-avatar, bento-dropdown-country, bento-dropdown-currency, bento-dropdown-payment-method, bento-dropdown-tag, bento-file-uploader, bento-input-field, bento-input-field-password, bento-input-field-phone-number, bento-checkbox-group, bento-radio-group, bento-selection-card-group, bento-textarea',
+            category: 'Deprecations',
+            url: 'https://github.com/Adyen/bento/blob/main/packages/eslint/rules/deprecation-components-value-prop/README.md',
+            recommended: true,
+        },
+        messages: {
+            deprecation: `The "value" prop is deprecated. Please use "model-value" instead.`,
+        },
+        fixable: 'code',
+        schema: [],
+    },
+
+    /** @param {RuleContext} context */
+    create(context) {
+        /* ------------------------------------------------ */
+        /* CASE 2: PROP DEPRECATION (Multiple Components)   */
+        /* ------------------------------------------------ */
+        return VueUtils.defineTemplateBodyVisitor(context, {
+            // 1. STATIC: value="foo"
+            [`VElement:matches([name="bento-date-picker"], [name="BentoDatePicker"], [name="bento-date-range-picker"], [name="BentoDateRangePicker"], [name="bento-dropdown"], [name="BentoDropdown"], [name="bento-dropdown-avatar"], [name="BentoDropdownAvatar"], [name="bento-dropdown-country"], [name="BentoDropdownCountry"], [name="bento-dropdown-currency"], [name="BentoDropdownCurrency"], [name="bento-dropdown-payment-method"], [name="BentoDropdownPaymentMethod"], [name="bento-dropdown-tag"], [name="BentoDropdownTag"], [name="bento-file-uploader"], [name="BentoFileUploader"], [name="bento-input-field"], [name="BentoInputField"], [name="bento-input-field-password"], [name="BentoInputFieldPassword"], [name="bento-input-field-phone-number"], [name="BentoInputFieldPhoneNumber"], [name="bento-checkbox-group"], [name="BentoCheckboxGroup"], [name="bento-radio-group"], [name="BentoRadioGroup"], [name="bento-selection-card-group"], [name="BentoSelectionCardGroup"], [name="bento-textarea"], [name="BentoTextarea"]) > VStartTag > VAttribute[directive=false][key.name="value"]`](
+                node
+            ) {
+                context.report({
+                    node,
+                    messageId: 'deprecation',
+                    fix(fixer) {
+                        return fixer.replaceText(node.key, 'model-value');
+                    },
+                });
+            },
+
+            // 2. DYNAMIC: :value="foo" or v-bind:value="foo"
+            [`VElement:matches([name="bento-date-picker"], [name="BentoDatePicker"], [name="bento-date-range-picker"], [name="BentoDateRangePicker"], [name="bento-dropdown"], [name="BentoDropdown"], [name="bento-dropdown-avatar"], [name="BentoDropdownAvatar"], [name="bento-dropdown-country"], [name="BentoDropdownCountry"], [name="bento-dropdown-currency"], [name="BentoDropdownCurrency"], [name="bento-dropdown-payment-method"], [name="BentoDropdownPaymentMethod"], [name="bento-dropdown-tag"], [name="BentoDropdownTag"], [name="bento-file-uploader"], [name="BentoFileUploader"], [name="bento-input-field"], [name="BentoInputField"], [name="bento-input-field-password"], [name="BentoInputFieldPassword"], [name="bento-input-field-phone-number"], [name="BentoInputFieldPhoneNumber"], [name="bento-checkbox-group"], [name="BentoCheckboxGroup"], [name="bento-radio-group"], [name="BentoRadioGroup"], [name="bento-selection-card-group"], [name="BentoSelectionCardGroup"], [name="bento-textarea"], [name="BentoTextarea"]) > VStartTag > VAttribute[directive=true][key.name.name="bind"][key.argument.name="value"]`](
+                node
+            ) {
+                context.report({
+                    node,
+                    messageId: 'deprecation',
+                    fix(fixer) {
+                        return fixer.replaceText(node.key.argument, 'model-value');
+                    },
+                });
+            },
+        });
+    },
+};