@cuiqg/eslint-config 2.5.7 → 2.5.9

package/src/configs/vue.js

@@ -0,0 +1,143 @@
+import { GLOB_VUE } from '../globs'
+import { interopDefault } from '../utils'
+
+export async function vue() {
+  const files = [GLOB_VUE]
+
+  const [pluginVue, parserVue] = await Promise.all([
+    interopDefault(import('eslint-plugin-vue')),
+    interopDefault(import('vue-eslint-parser'))
+  ])
+
+  return [
+    {
+      files,
+      languageOptions: {
+        globals: {
+          computed: 'readonly',
+          defineEmits: 'readonly',
+          defineExpose: 'readonly',
+          defineModel: 'readonly',
+          defineOptions: 'readonly',
+          defineProps: 'readonly',
+          defineSlots: 'readonly',
+          onActivated: 'readonly',
+          onDeactivated: 'readonly',
+          onMounted: 'readonly',
+          onUnmounted: 'readonly',
+          reactive: 'readonly',
+          ref: 'readonly',
+          toRef: 'readonly',
+          toRefs: 'readonly',
+          useAttrs: 'readonly',
+          useSlots: 'readonly',
+          watch: 'readonly',
+          watchEffect: 'readonly'
+        },
+        parser: parserVue,
+        parserOptions: {
+          ecmaFeatures: {
+            jsx: true
+          },
+          extraFileExtensions: ['.vue'],
+          parser: null,
+          sourceType: 'module'
+        }
+      },
+      name: 'cuiqg/vue',
+      plugins: {
+        vue: pluginVue
+      },
+      processor: pluginVue.processors['.vue'],
+      rules: {
+        ...(pluginVue.configs['flat/recommended']
+          .map(c => c.rules)
+          .reduce((acc, c) => ({ ...acc, ...c }), {})),
+
+        'node/prefer-global/process': 'off',
+        'vue/array-bracket-spacing': ['error', 'never'],
+        'vue/arrow-spacing': ['error', { after: true, before: true }],
+        'vue/block-order': [
+          'error',
+          {
+            order: ['script', 'template', 'style']
+          }
+        ],
+        'vue/block-spacing': ['error', 'always'],
+        'vue/block-tag-newline': [
+          'error',
+          {
+            multiline: 'always',
+            singleline: 'always'
+          }
+        ],
+        'vue/brace-style': ['error', 'stroustrup', { allowSingleLine: true }],
+        'vue/comma-dangle': ['error', 'always-multiline'],
+        'vue/comma-spacing': ['error', { after: true, before: false }],
+        'vue/comma-style': ['error', 'last'],
+        'vue/custom-event-name-casing': ['error', 'camelCase'],
+        'vue/define-macros-order': [
+          'error',
+          {
+            order: ['defineOptions', 'defineProps', 'defineEmits', 'defineSlots']
+          }
+        ],
+        'vue/dot-location': ['error', 'property'],
+        'vue/dot-notation': ['error', { allowKeywords: true }],
+        'vue/eqeqeq': ['error', 'smart'],
+        'vue/html-comment-content-spacing': [
+          'error',
+          'always',
+          {
+            exceptions: ['-']
+          }
+        ],
+        'vue/html-indent': ['error', 2],
+        'vue/html-quotes': ['error', 'double'],
+        'vue/key-spacing': ['error', { afterColon: true, beforeColon: false }],
+        'vue/keyword-spacing': ['error', { after: true, before: true }],
+        'vue/max-attributes-per-line': 'off',
+        'vue/multi-word-component-names': 'off',
+        'vue/no-dupe-keys': 'off',
+        'vue/no-empty-pattern': 'error',
+        'vue/no-irregular-whitespace': 'error',
+        'vue/no-loss-of-precision': 'error',
+        'vue/no-restricted-syntax': [
+          'error',
+          'DebuggerStatement',
+          'LabeledStatement',
+          'WithStatement'
+        ],
+        'vue/no-restricted-v-bind': ['error', '/^v-/'],
+        'vue/no-setup-props-reactivity-loss': 'off',
+        'vue/no-sparse-arrays': 'error',
+        'vue/no-unused-refs': 'error',
+        'vue/no-useless-v-bind': 'error',
+        'vue/no-v-html': 'off',
+        'vue/object-curly-newline': 'off',
+        'vue/object-curly-spacing': ['error', 'always'],
+        'vue/object-property-newline': ['error', { allowAllPropertiesOnSameLine: true }],
+        'vue/object-shorthand': [
+          'error',
+          'always',
+          {
+            avoidQuotes: true,
+            ignoreConstructors: false
+          }
+        ],
+        'vue/operator-linebreak': ['error', 'before'],
+        'vue/padding-line-between-blocks': ['error', 'always'],
+        'vue/prefer-separate-static-class': 'error',
+        'vue/prefer-template': 'error',
+        'vue/prop-name-casing': ['error', 'camelCase'],
+        'vue/quote-props': ['error', 'consistent-as-needed'],
+        'vue/require-default-prop': 'off',
+        'vue/require-prop-types': 'off',
+        'vue/space-in-parens': ['error', 'never'],
+        'vue/space-infix-ops': 'error',
+        'vue/space-unary-ops': ['error', { nonwords: false, words: true }],
+        'vue/template-curly-spacing': 'error'
+      }
+    }
+  ]
+}

package/src/env.js

@@ -0,0 +1,27 @@
+import process from 'node:process'
+import { isPackageExists } from 'local-pkg'
+
+export const isInGitHookOrLintStaged = () => {
+  return !!(
+    process.env.GIT_PARAMS
+    || process.env.VSCODE_GIT_COMMAND
+    || process.env.npm_lifecycle_script?.startsWith('lint-staged')
+  )
+}
+
+export const isInEditor = () => {
+  if (process.env.CI) return false
+  if (isInGitHookOrLintStaged()) return false
+  return !!(
+    process.env.VSCODE_PID
+    || process.env.VSCODE_CWD
+    || process.env.JETBRAINS_IDE
+    || process.env.VIM
+    || process.env.NVIM
+  )
+}
+
+export const hasVue = () =>
+  ['vue', 'nuxt', 'vitepress', '@slidev/cli'].some(i => isPackageExists(i))
+export const hasTypeScript = () => isPackageExists('typescript')
+export const hasUnoCss = () => isPackageExists('unocss')

package/src/globs.js

@@ -0,0 +1,70 @@
+export const GLOB_SRC_EXT = '?([cm])[jt]s?(x)'
+export const GLOB_SRC = `**/*.${GLOB_SRC_EXT}`
+
+export const GLOB_TS = `**/*.?([cm])ts`
+export const GLOB_TSX = `**/*.?([cm])tsx`
+
+export const GLOB_JS = `**/*.?([cm])js`
+export const GLOB_JSX = `**/*.?([cm])jsx`
+
+export const GLOB_STYLE = '**/*.{c,le,sc}ss'
+export const GLOB_CSS = '**/*.css'
+export const GLOB_SCSS = '**/*.scss'
+export const GLOB_LESS = '**/*.less'
+export const GLOB_STYLUS = '**/*.styl'
+export const GLOB_POSTCSS = '**/*.{p,post}css'
+
+export const GLOB_JSON = '**/*.json'
+export const GLOB_JSON5 = '**/*.json5'
+export const GLOB_JSONC = '**/*.jsonc'
+
+export const GLOB_MARKDOWN = '**/*.md'
+export const GLOB_VUE = '**/*.vue'
+export const GLOB_YAML = '**/*.y?(a)ml'
+export const GLOB_TOML = '**/*.toml'
+export const GLOB_XML = '**/*.xml'
+export const GLOB_SVG = '**/*.svg'
+export const GLOB_HTML = '**/*.htm?(l)'
+
+export const GLOB_EXCLUDE = [
+  '**/node_modules',
+  '**/dist',
+  '**/package-lock.json',
+  '**/yarn.lock',
+  '**/pnpm-lock.yaml',
+  '**/bun.lockb',
+
+  '**/output',
+  '**/coverage',
+  '**/temp',
+  '**/.temp',
+  '**/tmp',
+  '**/.tmp',
+  '**/.history',
+  '**/.vitepress/cache',
+  '**/.nuxt',
+  '**/.next',
+  '**/.svelte-kit',
+  '**/.vercel',
+  '**/.changeset',
+  '**/.idea',
+  '**/.DS_Store',
+  '**/Thumbs.db',
+  '**/ehthumbs.db',
+  '**/Desktop.ini',
+  '**/$RECYCLE.BIN',
+  '**/.cache',
+  '**/.output',
+  '**/.vite-inspect',
+  '**/.yarn',
+  '**/vite.config.*.timestamp-*',
+
+  '**/CHANGELOG*.md',
+  '**/*.min.*',
+  '**/LICENSE*',
+  '**/__snapshots__',
+  '**/auto-import?(s).d.ts',
+  '**/components.d.ts',
+  '**/typed-router.d.ts',
+  '**/.eslint-config-inspector'
+]

package/src/index.js

@@ -0,0 +1,8 @@
+import { cuiqg } from './presets'
+
+export * from './configs'
+export * from './env'
+export * from './globs'
+export * from './presets'
+
+export default cuiqg

package/src/presets.js

@@ -0,0 +1,70 @@
+import { FlatConfigComposer } from 'eslint-flat-config-utils'
+
+import {
+  compat,
+  ignores,
+  javascript,
+  jsdoc,
+  macros,
+  packageJson,
+  prettier,
+  stylistic,
+  unocss,
+  vue,
+  unicorn
+} from './configs'
+
+import { hasUnoCss, hasVue } from './env'
+
+export const defaultPluginRenaming = {
+  '@stylistic': 'style'
+}
+
+/**
+ *
+ * @param {object} options - 设置选项
+ * @param {...any} userConfigs - 用户配置
+ * @returns {Promise<any[]>} 合并后的配置
+ */
+export function cuiqg(
+  options = {},
+  ...userConfigs
+) {
+  const {
+    prettier: enablePrettier = false,
+    unocss: enableUnocss = hasUnoCss(),
+    vue: enableVue = hasVue()
+  } = options
+
+  const configs = []
+
+  configs.push(
+    compat(),
+    ignores(),
+    javascript(),
+    jsdoc(),
+    stylistic(),
+    packageJson(),
+    unicorn()
+  )
+
+  if (enableVue) {
+    configs.push(vue(), macros())
+  }
+
+  if (enableUnocss) {
+    configs.push(unocss())
+  }
+
+  if (enablePrettier) {
+    configs.push(prettier())
+  }
+
+  let composer = new FlatConfigComposer()
+
+  composer = composer
+    .append(...configs, ...userConfigs)
+    .renamePlugins(defaultPluginRenaming)
+
+  return composer
+}

package/src/utils.js

@@ -0,0 +1,24 @@
+export async function interopDefault(
+  module
+) {
+  try {
+    let resolved = await module
+    return resolved?.default || resolved
+  }
+  catch (error) {
+    throw new Error(`Cannot import module: ${String(error)}`)
+  }
+}
+
+export function renameRules(rules, map) {
+  return Object.fromEntries(
+    Object.entries(rules).map(([key, value]) => {
+      for (const [from, to] of Object.entries(map)) {
+        if (key.startsWith(`${from}/`)) {
+          return [to + key.slice(from.length), value]
+        }
+      }
+      return [key, value]
+    })
+  )
+}

package/tsdown.config.js

@@ -0,0 +1,9 @@
+import { defineConfig } from 'tsdown'
+
+export default defineConfig({
+  entry: 'src/index.js',
+  clean: true,
+  shims: true,
+  format: ['esm'],
+  exports: true
+})

package/vercel.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://openapi.vercel.sh/vercel.json",
+  "framework": null,
+  "buildCommand": "npm run build:inspect",
+  "outputDirectory": ".eslint-config-inspector",
+  "installCommand": "npm install"
+}