feat(vue): add option for vue/multi-word-component-names

xsjcTony · Dec 1, 2023 · 19838e6 · 19838e6
1 parent 6fb204a
commit 19838e6
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 4 deletions.
diff --git a/src/configs/vue.ts b/src/configs/vue.ts
@@ -118,8 +118,12 @@ const vueTypeScriptRules: FlatConfigItem['rules'] = {
 }
 
 
-const vueDefaultOverrideRules: FlatConfigItem['rules'] = {
+const vueDefaultOverrideRules = (ruleOptions: NonNullable<VueOptions['ruleOptions']>): FlatConfigItem['rules'] => ({
   // Priority A: Essential
+  'vue/multi-word-component-names': [
+    'error',
+    { ignores: ruleOptions.multiWordComponentNames?.ignores }
+  ],
   'vue/no-arrow-functions-in-watch': 'off',
   'vue/no-reserved-component-names': [
     'error',
@@ -167,7 +171,7 @@ const vueDefaultOverrideRules: FlatConfigItem['rules'] = {
 
   // Priority C: Recommended
   'vue/order-in-components': 'off'
-}
+})
 
 
 const vueStylisticRules: FlatConfigItem['rules'] = {
@@ -339,7 +343,8 @@ export const vue = async (options: VueOptions = {}): Promise<FlatConfigItem[]> =
     files = [GLOB_VUE],
     typescript = false,
     accessibility = {},
-    overrides
+    overrides,
+    ruleOptions = {}
   } = options
 
 
@@ -386,7 +391,7 @@ export const vue = async (options: VueOptions = {}): Promise<FlatConfigItem[]> =
       rules: {
         ...vueRules(pluginVue, options),
         ...typescript && vueTypeScriptRules,
-        ...vueDefaultOverrideRules,
+        ...vueDefaultOverrideRules(ruleOptions),
         ...vueStylisticRules,
         ...!!accessibility && vueAccessibilityRules(accessibility),
         ...overrides?.vue,

diff --git a/src/types.ts b/src/types.ts
@@ -245,6 +245,20 @@ export interface OptionsVue extends OptionsHasTypeScript, OptionsFiles {
    * This will be combined with `globalComponents`.
    */
   extraGlobalComponentsWithRegex?: string[]
+
+  /**
+   * Optional settings for rules.
+   */
+  ruleOptions?: {
+    /**
+     * For `vue/multi-word-component-names` rule.
+     *
+     * @see https://eslint.vuejs.org/rules/multi-word-component-names.html
+     */
+    multiWordComponentNames?: {
+      ignores?: string[]
+    }
+  }
 }