@lntvow/eslint-config 8.5.0 → 9.1.2

package/src/factory.ts

@@ -0,0 +1,167 @@
+import { FlatConfigComposer } from 'eslint-flat-config-utils'
+import type { Linter } from 'eslint'
+import { isBoolean } from '@lntvow/utils'
+import { isPackageExists } from 'local-pkg'
+import { gitignore, ignores, javascript, typescript, vue } from './configs'
+import type { Awaitable, ConfigNames, OptionsConfig, TypedFlatConfigItem } from './types'
+import { stylistic } from './configs/stylistic'
+import { imports } from './configs/imports'
+import { prettier } from './configs/prettier'
+
+const flatConfigProps: (keyof TypedFlatConfigItem)[] = [
+  'name',
+  'files',
+  'ignores',
+  'languageOptions',
+  'linterOptions',
+  'processor',
+  'plugins',
+  'rules',
+  'settings',
+]
+
+export function lntvow(
+  options: OptionsConfig & TypedFlatConfigItem = {},
+  ...userConfigs: Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[] | FlatConfigComposer | Linter.FlatConfig[]>[]
+): FlatConfigComposer<TypedFlatConfigItem, ConfigNames> {
+  const {
+    // autoRenamePlugins = true,
+    componentExts = [],
+    gitignore: enableGitignore = true,
+    // regexp: enableRegexp = true,
+    typescript: enableTypeScript = isPackageExists('typescript'),
+    vue: enableVue = ['vue', 'nuxt', 'vitepress'].some(i => isPackageExists(i)),
+  } = options
+
+  const stylisticOptions =
+    options.stylistic === false ? false : typeof options.stylistic === 'object' ? options.stylistic : {}
+
+  // if (stylisticOptions && !('jsx' in stylisticOptions)) stylisticOptions.jsx = options.jsx ?? true
+
+  const configs: Awaitable<TypedFlatConfigItem[]>[] = []
+
+  // Base configs
+  configs.push(
+    ignores(),
+    javascript({
+      ...resolveSubOptions(options, 'javascript'),
+    }),
+    imports()
+    // comments(),
+    // node(),
+    // jsdoc({
+    //   stylistic: stylisticOptions,
+    // }),
+    // unicorn(),
+    // command(),
+
+    // Optional plugins (installed but not enabled by default)
+    // perfectionist(),
+  )
+
+  if (enableGitignore) {
+    configs.push(gitignore(resolveSubOptions(options, 'gitignore')))
+  }
+
+  if (enableVue) {
+    componentExts.push('vue')
+  }
+
+  if (enableTypeScript) {
+    configs.push(typescript({ ...resolveSubOptions(options, 'typescript'), componentExts }))
+  }
+
+  if (stylisticOptions) {
+    configs.push(stylistic({ ...stylisticOptions }))
+  }
+
+  // if (enableRegexp)
+  //   configs.push(regexp(typeof enableRegexp === 'boolean' ? {} : enableRegexp))
+
+  // if (options.test ?? true) {
+  //   configs.push(test({
+  //     isInEditor,
+  //     overrides: getOverrides(options, 'test'),
+  //   }))
+  // }
+
+  if (enableVue) {
+    configs.push(vue({ ...resolveSubOptions(options, 'vue') }))
+  }
+
+  // if (options.jsonc ?? true) {
+  //   configs.push(
+  //     jsonc({
+  //       overrides: getOverrides(options, 'jsonc'),
+  //       stylistic: stylisticOptions,
+  //     }),
+  //     sortPackageJson(),
+  //     sortTsconfig(),
+  //   )
+  // }
+
+  // if (options.yaml ?? true) {
+  //   configs.push(yaml({
+  //     overrides: getOverrides(options, 'yaml'),
+  //     stylistic: stylisticOptions,
+  //   }))
+  // }
+
+  // if (options.toml ?? true) {
+  //   configs.push(toml({
+  //     overrides: getOverrides(options, 'toml'),
+  //     stylistic: stylisticOptions,
+  //   }))
+  // }
+
+  // if (options.markdown ?? true) {
+  //   configs.push(
+  //     markdown(
+  //       {
+  //         componentExts,
+  //         overrides: getOverrides(options, 'markdown'),
+  //       },
+  //     ),
+  //   )
+  // }
+
+  // if (options.formatters) {
+  //   configs.push(formatters(
+  //     options.formatters,
+  //     typeof stylisticOptions === 'boolean' ? {} : stylisticOptions,
+  //   ))
+  // }
+
+  configs.push(prettier())
+
+  // User can optionally pass a flat config item to the first argument
+  const fusedConfig = flatConfigProps.reduce((acc, key) => {
+    if (key in options) {
+      acc[key] = options[key] as any
+    }
+    return acc
+  }, {} as TypedFlatConfigItem)
+
+  if (Object.keys(fusedConfig).length) {
+    configs.push([fusedConfig])
+  }
+
+  // Merge all configs
+  let composer = new FlatConfigComposer<TypedFlatConfigItem, ConfigNames>()
+  composer = composer.append(...configs, ...(userConfigs as any))
+
+  // if (autoRenamePlugins) {
+  //   composer = composer.renamePlugins(defaultPluginRenaming)
+  // }
+
+  return composer
+}
+
+export type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>
+
+export function resolveSubOptions<K extends keyof OptionsConfig>(
+  options: OptionsConfig,
+  key: K
+): ResolvedOptions<OptionsConfig[K]> {
+  return isBoolean(options[key]) ? ({} as any) : options[key] || {}
+}

package/src/globs.ts

@@ -0,0 +1,86 @@
+export const GLOB_SRC_EXT = '?([cm])[jt]s?(x)'
+export const GLOB_SRC = '**/*.?([cm])[jt]s?(x)'
+
+export const GLOB_JS = '**/*.?([cm])js'
+export const GLOB_JSX = '**/*.?([cm])jsx'
+
+export const GLOB_TS = '**/*.?([cm])ts'
+export const GLOB_TSX = '**/*.?([cm])tsx'
+
+export const GLOB_STYLE = '**/*.{c,le,sc}ss'
+export const GLOB_CSS = '**/*.css'
+export const GLOB_POSTCSS = '**/*.{p,post}css'
+export const GLOB_LESS = '**/*.less'
+export const GLOB_SCSS = '**/*.scss'
+
+export const GLOB_JSON = '**/*.json'
+export const GLOB_JSON5 = '**/*.json5'
+export const GLOB_JSONC = '**/*.jsonc'
+
+export const GLOB_MARKDOWN = '**/*.md'
+export const GLOB_MARKDOWN_IN_MARKDOWN = '**/*.md/*.md'
+export const GLOB_SVELTE = '**/*.svelte'
+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_HTML = '**/*.htm?(l)'
+export const GLOB_ASTRO = '**/*.astro'
+export const GLOB_GRAPHQL = '**/*.{g,graph}ql'
+
+export const GLOB_MARKDOWN_CODE = `${GLOB_MARKDOWN}/${GLOB_SRC}`
+
+export const GLOB_TESTS = [
+  `**/__tests__/**/*.${GLOB_SRC_EXT}`,
+  `**/*.spec.${GLOB_SRC_EXT}`,
+  `**/*.test.${GLOB_SRC_EXT}`,
+  `**/*.bench.${GLOB_SRC_EXT}`,
+  `**/*.benchmark.${GLOB_SRC_EXT}`,
+]
+
+export const GLOB_ALL_SRC = [
+  GLOB_SRC,
+  GLOB_STYLE,
+  GLOB_JSON,
+  GLOB_JSON5,
+  GLOB_MARKDOWN,
+  GLOB_SVELTE,
+  GLOB_VUE,
+  GLOB_YAML,
+  GLOB_XML,
+  GLOB_HTML,
+]
+
+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',
+  '**/.vercel',
+  '**/.changeset',
+  '**/.idea',
+  '**/.cache',
+  '**/.output',
+  '**/.vite-inspect',
+  '**/.yarn',
+
+  '**/CHANGELOG*.md',
+  '**/*.min.*',
+  '**/LICENSE*',
+  '**/__snapshots__',
+  '**/auto-import?(s).d.ts',
+  '**/components.d.ts',
+]

package/src/index.ts

@@ -0,0 +1,7 @@
+import { lntvow } from './factory'
+
+export * from './utils'
+export * from './configs'
+export * from './globs'
+export { lntvow } from './factory'
+export default lntvow