feat!: rename setting class-attr-name

levchak0910 · Mar 30, 2024 · 0299a42 · 0299a42
1 parent 540cd19
commit 0299a42
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -42,14 +42,14 @@ Example **.eslintrc.js**:
 ```js
 module.exports = {
   plugins: ['@vkcn'],
-  settings: { "vkcn/class-attr-name": /custom-reg-exp/ }, // optional
+  settings: { "@vkcn/class-attr-name": /custom-reg-exp/ }, // optional
   rules: {
     '@vkcn/<rule-name>': 'error'
   }
 }
 ```
 
-By using `settings: { "vkcn/class-attr-name": /custom-reg-exp/ }` it is possible to run rules throughout any attribute/directive which matches regexp. By default only `class` is checked.
+By using `settings: { "@vkcn/class-attr-name": /custom-reg-exp/ }` it is possible to run rules throughout any attribute/directive which matches regexp. By default only `class` is checked.
 
 _Please note!_ When using a custom regexp - `class` **must be included** into it
 

diff --git a/lib/utils/class-attr.ts b/lib/utils/class-attr.ts
@@ -2,7 +2,7 @@ import type { RuleContext } from "../types";
 import type { VAttribute, VDirective } from "vue-eslint-parser/ast";
 
 export function getClassAttrNameRegexp(context: RuleContext): RegExp {
-  const customClassAttrName = context.settings?.["vkcn/class-attr-name"];
+  const customClassAttrName = context.settings?.["@vkcn/class-attr-name"];
 
   const customClassAttrNameRegexp =
     customClassAttrName instanceof RegExp ? customClassAttrName : /^class$/;

diff --git a/tests/lib/rules/no-dynamic-class-names.ts b/tests/lib/rules/no-dynamic-class-names.ts
@@ -10,7 +10,7 @@ const tester = new RuleTester({
     ecmaVersion: 2019,
     sourceType: "module",
   },
-  settings: { "vkcn/class-attr-name": /(.+-)?class$/ },
+  settings: { "@vkcn/class-attr-name": /(.+-)?class$/ },
 });
 
 type RuleOptions = {

diff --git a/tests/lib/rules/no-undefined-class-names.ts b/tests/lib/rules/no-undefined-class-names.ts
@@ -66,7 +66,7 @@ tester.run("no-undefined-class-names", rule as any, {
     {
       name: "custom attribute names",
       filename: "app.vue",
-      settings: { "vkcn/class-attr-name": /^(bar|baz)$/ },
+      settings: { "@vkcn/class-attr-name": /^(bar|baz)$/ },
       code: html`
         <template>
           <div bar="app--foo" :baz="'app--foo'"></div>
@@ -443,7 +443,7 @@ tester.run("no-undefined-class-names", rule as any, {
     {
       name: "undefined with custom attribute names",
       filename: "app.vue",
-      settings: { "vkcn/class-attr-name": /^(bar|baz)$/ },
+      settings: { "@vkcn/class-attr-name": /^(bar|baz)$/ },
       code: html`
         <template>
           <div bar="app--foobar" :baz="'app--foobaz'"></div>