@db-ux/core-eslint-plugin 4.4.2-eslint-plugin-28ea614 → 4.5.0

package/CHANGELOG.md

@@ -1 +1,7 @@
-# @db-ux/eslint-plugin
+# @db-ux/core-eslint-plugin
+
+## 4.5.0
+
+### Patch Changes
+
+- feat: add eslint-plugin `@db-ux/core-eslint-plugin` - [see commit 68b97f1](https://github.com/db-ux-design-system/core-web/commit/68b97f1c349397b5b695cde9504f0d851403a6f5)

package/README.md

@@ -1,11 +1,29 @@
-# @db-ux/eslint-plugin
+# @db-ux/core-eslint-plugin
 
 ESLint plugin to validate correct usage of DB UX Design System components across React, Vue, and Angular.
 
 ## Installation
 
 ```shell
-npm install eslint @db-ux/eslint-plugin --save-dev
+npm install eslint @db-ux/core-eslint-plugin --save-dev
+```
+
+**For Vue projects**, also install `vue-eslint-parser`:
+
+```shell
+npm install vue-eslint-parser --save-dev
+```
+
+**For Angular projects**, also install `@angular-eslint/template-parser`:
+
+```shell
+npm install @angular-eslint/template-parser --save-dev
+```
+
+**For React/TypeScript projects**, also install `@typescript-eslint/parser`:
+
+```shell
+npm install @typescript-eslint/parser --save-dev
 ```
 
 ## Usage
@@ -15,10 +33,57 @@ Add to your ESLint config:
 **ESLint 9+ (flat config):**
 
 ```js
-import dbUx from "@db-ux/eslint-plugin";
+// eslint.config.js
+import dbUx from "@db-ux/core-eslint-plugin";
+
+export default [
+	{
+		plugins: {
+			"db-ux": dbUx
+		},
+		rules: dbUx.configs.recommended.rules
+	}
+];
+```
+
+**For Vue projects**, configure the Vue parser:
+
+```js
+import dbUx from "@db-ux/core-eslint-plugin";
+import vueParser from "vue-eslint-parser";
+import tsParser from "@typescript-eslint/parser";
+
+export default [
+	{
+		files: ["**/*.vue"],
+		languageOptions: {
+			parser: vueParser,
+			parserOptions: {
+				parser: tsParser,
+				ecmaVersion: "latest",
+				sourceType: "module"
+			}
+		},
+		plugins: {
+			"db-ux": dbUx
+		},
+		rules: dbUx.configs.recommended.rules
+	}
+];
+```
+
+**For Angular projects**, configure the Angular template parser:
+
+```js
+import dbUx from "@db-ux/core-eslint-plugin";
+import angularTemplateParser from "@angular-eslint/template-parser";
 
 export default [
 	{
+		files: ["**/*.html"],
+		languageOptions: {
+			parser: angularTemplateParser
+		},
 		plugins: {
 			"db-ux": dbUx
 		},
@@ -30,7 +95,7 @@ export default [
 **Or enable rules individually:**
 
 ```js
-import dbUx from "@db-ux/eslint-plugin";
+import dbUx from "@db-ux/core-eslint-plugin";
 
 export default [
 	{
@@ -44,6 +109,31 @@ export default [
 ];
 ```
 
+**For React/TypeScript projects**, configure the TypeScript parser:
+
+```js
+import dbUx from "@db-ux/core-eslint-plugin";
+import tsParser from "@typescript-eslint/parser";
+
+export default [
+	{
+		files: ["**/*.ts", "**/*.tsx"],
+		languageOptions: {
+			parser: tsParser,
+			parserOptions: {
+				ecmaVersion: "latest",
+				sourceType: "module",
+				ecmaFeatures: { jsx: true }
+			}
+		},
+		plugins: {
+			"db-ux": dbUx
+		},
+		rules: dbUx.configs.recommended.rules
+	}
+];
+```
+
 ## Rules
 
 ### `button-no-text-requires-tooltip`

package/build/index.d.ts

@@ -4,94 +4,353 @@ declare const plugin: {
         version: string;
     };
     rules: {
-        'button-no-text-requires-tooltip': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"missingIcon" | "missingTooltip", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'button-no-text-requires-tooltip': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                fixable: "code";
+                messages: {
+                    missingIcon: string;
+                    missingTooltip: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'button-type-required': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"missingType", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'button-type-required': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                fixable: "code";
+                messages: {
+                    missingType: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'button-single-icon-attribute': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"multipleIcons", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'button-single-icon-attribute': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                messages: {
+                    multipleIcons: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'form-label-required': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"missingLabel", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'form-label-required': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                messages: {
+                    missingLabel: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'form-validation-message-required': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"missingInvalidMessage", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'form-validation-message-required': {
+            meta: {
+                type: "suggestion";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                messages: {
+                    missingInvalidMessage: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'prefer-icon-attribute': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"preferAttribute", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'prefer-icon-attribute': {
+            meta: {
+                type: "suggestion";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                fixable: "code";
+                messages: {
+                    preferAttribute: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'text-or-children-required': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"missingContent", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'text-or-children-required': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                messages: {
+                    missingContent: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'no-interactive-tooltip-content': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"noInteractive", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'no-interactive-tooltip-content': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                messages: {
+                    noInteractive: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'tooltip-requires-interactive-parent': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"requiresInteractive", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'tooltip-requires-interactive-parent': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                messages: {
+                    requiresInteractive: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'no-nested-accordion': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"noNested", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'no-nested-accordion': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                messages: {
+                    noNested: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'badge-corner-placement-rules': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"textTooLong" | "missingLabel", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'accordion-item-headline-required': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                messages: {
+                    headlineRequired: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'badge-no-inline-in-interactive': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"noInline", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'badge-corner-placement-rules': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                fixable: "code";
+                messages: {
+                    textTooLong: string;
+                    missingLabel: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'link-external-security': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"missingTargetBlank" | "missingReferrerPolicy" | "missingContentExternal", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'badge-no-inline-in-interactive': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                fixable: "code";
+                messages: {
+                    noInline: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'select-requires-options': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"missingOptions", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'link-external-security': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                fixable: "code";
+                messages: {
+                    missingTargetBlank: string;
+                    missingReferrerPolicy: string;
+                    missingContentExternal: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
+        };
+        'select-requires-options': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                messages: {
+                    missingOptions: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'custom-select-tags-remove-text-required': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"missingRemoveTagsTexts", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'custom-select-tags-remove-text-required': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                messages: {
+                    missingRemoveTagsTexts: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'close-button-text-required': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"missingCloseButtonText", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'close-button-text-required': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                messages: {
+                    missingCloseButtonText: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'header-burger-menu-label-required': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"missingBurgerMenuLabel", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'header-burger-menu-label-required': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                messages: {
+                    missingBurgerMenuLabel: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'navigation-item-back-button-text-required': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"missingBackButtonText", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'navigation-item-back-button-text-required': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                messages: {
+                    missingBackButtonText: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'tag-removable-remove-button-required': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"missingRemoveButton", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'tag-removable-remove-button-required': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                messages: {
+                    missingRemoveButton: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'input-type-required': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"missingType", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'input-type-required': {
+            meta: {
+                type: "suggestion";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                fixable: "code";
+                messages: {
+                    missingType: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
-        'input-file-type-validation': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"missingAccept" | "invalidMultiple" | "invalidAccept", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener> & {
-            name: string;
+        'input-file-type-validation': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                messages: {
+                    missingAccept: string;
+                    invalidMultiple: string;
+                    invalidAccept: string;
+                };
+                schema: never[];
+            };
+            create(context: any): any;
         };
     };
     configs: {
         recommended: {
             rules: {
+                'db-ux/accordion-item-headline-required': string;
+                'db-ux/badge-corner-placement-rules': string;
+                'db-ux/badge-no-inline-in-interactive': string;
                 'db-ux/button-no-text-requires-tooltip': string;
-                'db-ux/button-type-required': string;
                 'db-ux/button-single-icon-attribute': string;
+                'db-ux/button-type-required': string;
+                'db-ux/close-button-text-required': string;
+                'db-ux/custom-select-tags-remove-text-required': string;
                 'db-ux/form-label-required': string;
                 'db-ux/form-validation-message-required': string;
-                'db-ux/prefer-icon-attribute': string;
-                'db-ux/text-or-children-required': string;
+                'db-ux/header-burger-menu-label-required': string;
+                'db-ux/input-file-type-validation': string;
+                'db-ux/input-type-required': string;
+                'db-ux/link-external-security': string;
+                'db-ux/navigation-item-back-button-text-required': string;
                 'db-ux/no-interactive-tooltip-content': string;
-                'db-ux/tooltip-requires-interactive-parent': string;
                 'db-ux/no-nested-accordion': string;
-                'db-ux/badge-corner-placement-rules': string;
-                'db-ux/badge-no-inline-in-interactive': string;
-                'db-ux/link-external-security': string;
+                'db-ux/prefer-icon-attribute': string;
                 'db-ux/select-requires-options': string;
-                'db-ux/custom-select-tags-remove-text-required': string;
-                'db-ux/close-button-text-required': string;
-                'db-ux/header-burger-menu-label-required': string;
-                'db-ux/navigation-item-back-button-text-required': string;
                 'db-ux/tag-removable-remove-button-required': string;
-                'db-ux/input-type-required': string;
-                'db-ux/input-file-type-validation': string;
+                'db-ux/text-or-children-required': string;
+                'db-ux/tooltip-requires-interactive-parent': string;
             };
         };
     };

package/build/index.js

@@ -1,3 +1,5 @@
+import packageJson from '../package.json' with { type: 'json' };
+import accordionItemHeadlineRequired from './rules/accordion/accordion-item-headline-required.js';
 import noNestedAccordion from './rules/accordion/no-nested-accordion.js';
 import badgeCornerPlacementRules from './rules/badge/badge-corner-placement-rules.js';
 import badgeNoInlineInInteractive from './rules/badge/badge-no-inline-in-interactive.js';
@@ -21,33 +23,34 @@ import noInteractiveTooltipContent from './rules/tooltip/no-interactive-tooltip-
 import tooltipRequiresInteractiveParent from './rules/tooltip/tooltip-requires-interactive-parent.js';
 const recommended = {
     rules: {
+        'db-ux/accordion-item-headline-required': 'error',
+        'db-ux/badge-corner-placement-rules': 'error',
+        'db-ux/badge-no-inline-in-interactive': 'error',
         'db-ux/button-no-text-requires-tooltip': 'error',
-        'db-ux/button-type-required': 'error',
         'db-ux/button-single-icon-attribute': 'error',
+        'db-ux/button-type-required': 'error',
+        'db-ux/close-button-text-required': 'error',
+        'db-ux/custom-select-tags-remove-text-required': 'error',
         'db-ux/form-label-required': 'error',
-        'db-ux/form-validation-message-required': 'error',
-        'db-ux/prefer-icon-attribute': 'warn',
-        'db-ux/text-or-children-required': 'error',
+        'db-ux/form-validation-message-required': 'warn',
+        'db-ux/header-burger-menu-label-required': 'error',
+        'db-ux/input-file-type-validation': 'error',
+        'db-ux/input-type-required': 'warn',
+        'db-ux/link-external-security': 'warn',
+        'db-ux/navigation-item-back-button-text-required': 'error',
         'db-ux/no-interactive-tooltip-content': 'error',
-        'db-ux/tooltip-requires-interactive-parent': 'error',
         'db-ux/no-nested-accordion': 'error',
-        'db-ux/badge-corner-placement-rules': 'error',
-        'db-ux/badge-no-inline-in-interactive': 'error',
-        'db-ux/link-external-security': 'warn',
+        'db-ux/prefer-icon-attribute': 'warn',
         'db-ux/select-requires-options': 'error',
-        'db-ux/custom-select-tags-remove-text-required': 'error',
-        'db-ux/close-button-text-required': 'error',
-        'db-ux/header-burger-menu-label-required': 'error',
-        'db-ux/navigation-item-back-button-text-required': 'error',
         'db-ux/tag-removable-remove-button-required': 'error',
-        'db-ux/input-type-required': 'warn',
-        'db-ux/input-file-type-validation': 'error'
+        'db-ux/text-or-children-required': 'error',
+        'db-ux/tooltip-requires-interactive-parent': 'error'
     }
 };
 const plugin = {
     meta: {
-        name: '@db-ux/eslint-plugin',
-        version: '0.0.1'
+        name: '@db-ux/core-eslint-plugin',
+        version: packageJson.version
     },
     rules: {
         'button-no-text-requires-tooltip': buttonNoTextRequiresTooltip,
@@ -60,6 +63,7 @@ const plugin = {
         'no-interactive-tooltip-content': noInteractiveTooltipContent,
         'tooltip-requires-interactive-parent': tooltipRequiresInteractiveParent,
         'no-nested-accordion': noNestedAccordion,
+        'accordion-item-headline-required': accordionItemHeadlineRequired,
         'badge-corner-placement-rules': badgeCornerPlacementRules,
         'badge-no-inline-in-interactive': badgeNoInlineInInteractive,
         'link-external-security': linkExternalSecurity,

package/build/rules/accordion/accordion-item-headline-required.d.ts

@@ -0,0 +1,15 @@
+declare const _default: {
+    meta: {
+        type: "problem";
+        docs: {
+            description: string;
+            url: string;
+        };
+        messages: {
+            headlineRequired: string;
+        };
+        schema: never[];
+    };
+    create(context: any): any;
+};
+export default _default;