feat: allow customize indent and quotes

Author: coderwyd

README.md

@@ -242,7 +242,24 @@ Certain rules would only be enabled in specific files, for example, `ts/*` rules
 import coderwyd from '@coderwyd/eslint-config'
 
 export default coderwyd(
-  { vue: true, typescript: true },
+  {
+    // Enable stylistic formatting rules
+    // stylistic: true,
+
+    // Or customize the stylistic rules
+    stylistic: {
+      indent: 2, // 4, or 'tab'
+      quotes: 'single', // or 'double'
+    },
+
+    // TypeScript and Vue are auto-detected, you can also explicitly enable them:
+    typescript: true,
+    vue: true,
+
+    // Disable jsonc and yaml support
+    jsonc: false,
+    yaml: false,
+  },
   {
     // Remember to specify the file glob here, otherwise it might cause the vue plugin to handle non-vue files
     files: ['**/*.vue'],

src/configs/stylistic.ts

@@ -1,7 +1,12 @@
-import type { FlatESLintConfigItem } from '../types'
+import type { FlatESLintConfigItem, StylisticConfig } from '../types'
 import { pluginAntfu, pluginStylistic } from '../plugins'
 
-export function stylistic(): FlatESLintConfigItem[] {
+export function stylistic(options: StylisticConfig = {}): FlatESLintConfigItem[] {
+  const {
+    indent = 2,
+    quotes = 'single',
+  } = options
+
   return [
     {
       name: 'coderwyd:stylistic',
@@ -26,7 +31,7 @@ export function stylistic(): FlatESLintConfigItem[] {
         'style/computed-property-spacing': ['error', 'never', { enforceForClassMembers: true }],
         'style/dot-location': ['error', 'property'],
         'style/eol-last': 'error',
-        'style/indent': ['error', 2, {
+        'style/indent': ['error', indent, {
           ArrayExpression: 1,
           CallExpression: { arguments: 1 },
           FunctionDeclaration: { body: 1, parameters: 1 },
@@ -85,15 +90,15 @@ export function stylistic(): FlatESLintConfigItem[] {
         'style/no-mixed-spaces-and-tabs': 'error',
         'style/no-multi-spaces': 'error',
         'style/no-multiple-empty-lines': ['error', { max: 1, maxBOF: 0, maxEOF: 0 }],
-        'style/no-tabs': 'error',
+        'style/no-tabs': indent === 'tab' ? 'off' : 'error',
         'style/no-trailing-spaces': 'error',
         'style/no-whitespace-before-property': 'error',
         'style/object-curly-spacing': ['error', 'always'],
         'style/object-property-newline': ['error', { allowMultiplePropertiesPerLine: true }],
         'style/operator-linebreak': ['error', 'before'],
         'style/padded-blocks': ['error', { blocks: 'never', classes: 'never', switches: 'never' }],
         'style/quote-props': ['error', 'consistent-as-needed'],
-        'style/quotes': ['error', 'single', { allowTemplateLiterals: true, avoidEscape: true }],
+        'style/quotes': ['error', quotes, { allowTemplateLiterals: true, avoidEscape: true }],
         'style/rest-spread-spacing': ['error', 'never'],
         'style/semi': ['error', 'never'],
         'style/semi-spacing': ['error', { after: true, before: false }],

src/configs/typescript.ts

@@ -81,8 +81,6 @@ export function typescript(
         'antfu/generic-spacing': 'error',
         'antfu/named-tuple-spacing': 'error',
         'antfu/no-cjs-exports': 'error',
-        'antfu/no-const-enum': 'error',
-        'antfu/no-ts-export-equal': 'error',
 
         'no-dupe-class-members': OFF,
         'no-invalid-this': OFF,
@@ -122,6 +120,7 @@ export function typescript(
       rules: {
         'eslint-comments/no-unlimited-disable': OFF,
         'import/no-duplicates': OFF,
+        'no-restricted-syntax': OFF,
         'unused-imports/no-unused-vars': OFF,
       },
     },

src/configs/vue.ts

@@ -37,6 +37,11 @@ export function vue(options: OptionsHasTypeScript & OptionsOverrides & OptionsSt
     overrides = {},
     stylistic = true,
   } = options
+
+  const {
+    indent = 2,
+  } = typeof stylistic === 'boolean' ? {} : stylistic
+
   return [
     {
       name: 'coderwyd:vue:setup',
@@ -76,6 +81,8 @@ export function vue(options: OptionsHasTypeScript & OptionsOverrides & OptionsSt
         'vue/dot-location': ['error', 'property'],
         'vue/dot-notation': ['error', { allowKeywords: true }],
         'vue/eqeqeq': ['error', 'smart'],
+        'vue/html-indent': ['error', indent],
+        'vue/html-quotes': ['error', 'double'],
         'vue/max-attributes-per-line': OFF,
         'vue/multi-word-component-names': OFF,
         'vue/no-dupe-keys': OFF,

src/configs/yaml.ts

@@ -9,6 +9,11 @@ export function yaml(options: OptionsOverrides & OptionsStylistic = {}): FlatESL
     stylistic = true,
   } = options
 
+  const {
+    indent = 2,
+    quotes = 'single',
+  } = typeof stylistic === 'boolean' ? {} : stylistic
+
   return [
     {
       name: 'coderwyd:yaml:setup',
@@ -42,10 +47,10 @@ export function yaml(options: OptionsOverrides & OptionsStylistic = {}): FlatESL
               'yaml/flow-mapping-curly-spacing': 'error',
               'yaml/flow-sequence-bracket-newline': 'error',
               'yaml/flow-sequence-bracket-spacing': 'error',
-              'yaml/indent': ['error', 2],
+              'yaml/indent': ['error', indent],
               'yaml/key-spacing': 'error',
-              'yaml/no-tab-indent': 'error',
-              'yaml/quotes': ['error', { avoidEscape: false, prefer: 'single' }],
+              'yaml/no-tab-indent': indent === 'tab' ? 'off' : 'error',
+              'yaml/quotes': ['error', { avoidEscape: false, prefer: quotes }],
               'yaml/spaced-comment': 'error',
             }
           : {},

src/factory.ts

@@ -107,8 +107,13 @@ export function coderwyd(options: OptionsConfig & FlatESLintConfigItem = {}, ...
     }))
   }
 
-  if (enableStylistic)
-    configs.push(stylistic())
+  if (enableStylistic) {
+    configs.push(stylistic(
+      typeof enableStylistic === 'boolean'
+        ? {}
+        : enableStylistic,
+    ))
+  }
 
   if (options.test ?? true)
     configs.push(test({ isInEditor, overrides: overrides.test }))

src/types.ts

@@ -99,7 +99,12 @@ export interface OptionsHasTypeScript {
 }
 
 export interface OptionsStylistic {
-  stylistic?: boolean
+  stylistic?: boolean | StylisticConfig
+}
+
+export interface StylisticConfig {
+  indent?: number | 'tab'
+  quotes?: 'single' | 'double'
 }
 
 export interface OptionsOverrides {
@@ -184,7 +189,7 @@ export interface OptionsConfig extends OptionsComponentExts {
    *
    * @default true
    */
-  stylistic?: boolean
+  stylistic?: boolean | StylisticConfig
 
   /**
    * Control to disable some rules in editors.