@lntvow/eslint-config 8.5.0 → 9.1.2

package/src/types.ts

@@ -0,0 +1,127 @@
+import type { Linter } from 'eslint'
+import type { ParserOptions } from '@typescript-eslint/parser'
+import type { StylisticCustomizeOptions } from '@stylistic/eslint-plugin'
+import type { ConfigNames, RuleOptions } from './typegen'
+
+export type Awaitable<T> = T | Promise<T>
+
+export type Rules = RuleOptions
+
+export type { ConfigNames }
+
+export type TypedFlatConfigItem = Omit<Linter.FlatConfig<Linter.RulesRecord & Rules>, 'plugins'> & {
+  // Relax plugins type limitation, as most of the plugins did not have correct type info yet.
+  /**
+   * An object containing a name-value mapping of plugin names to plugin objects. When `files` is specified, these plugins are only available to the matching files.
+   *
+   * @see [Using plugins in your configuration](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#using-plugins-in-your-configuration)
+   */
+  plugins?: Record<string, any>
+}
+
+export interface OptionsVue extends OptionsOverrides {
+  /**
+   * Vue version. Apply different rules set from `eslint-plugin-vue`.
+   *
+   * @default auto-detect based on the dependencies
+   */
+  // eslint-disable-next-line no-magic-numbers
+  vueVersion?: 2 | 3
+}
+
+export interface OptionsComponentExts {
+  /**
+   * Additional extensions for components.
+   *
+   * @example ['vue']
+   * @default []
+   */
+  componentExts?: string[]
+}
+
+export interface OptionsTypeScript extends OptionsOverrides {
+  /**
+   * When this options is provided, type aware rules will be enabled.
+   * @see https://typescript-eslint.io/linting/typed-linting/
+   */
+  tsconfigPath?: string | string[]
+
+  /**
+   * Additional parser options for TypeScript.
+   */
+  parserOptions?: Partial<ParserOptions>
+
+  /**
+   * Glob patterns for files that should be type aware.
+   * @default ['**\/*.{ts,tsx}']
+   */
+  filesTypeAware?: string[]
+}
+
+export interface StylisticConfig
+  extends Pick<StylisticCustomizeOptions, 'indent' | 'quotes' | 'jsx' | 'semi'>,
+    OptionsOverrides {}
+
+export interface OptionsOverrides {
+  overrides?: TypedFlatConfigItem['rules']
+}
+
+export interface FlatGitignoreOptions {
+  /**
+   * Name of the configuration.
+   * @default 'gitignore'
+   */
+  name?: string
+  /**
+   * Path to `.gitignore` files, or files with compatible formats like `.eslintignore`.
+   */
+  files?: string | string[]
+  /**
+   * Mark the current working directory as the root directory,
+   * disable searching for `.gitignore` files in parent directories.
+   *
+   * This option is not effective when `files` is explicitly specified.
+   * @default false
+   */
+  root?: boolean
+}
+
+export interface OptionsConfig extends OptionsComponentExts {
+  /**
+   * Core rules. Can't be disabled.
+   */
+  javascript?: OptionsOverrides
+
+  /**
+   * Enable TypeScript support.
+   *
+   * Passing an object to enable TypeScript Language Server support.
+   *
+   * @default auto-detect based on the dependencies
+   */
+  typescript?: boolean | OptionsTypeScript
+
+  /**
+   * Enable Vue support.
+   *
+   * @default auto-detect based on the dependencies
+   */
+  vue?: boolean | OptionsVue
+
+  /**
+   * Enable stylistic rules.
+   *
+   * @see https://eslint.style/
+   * @default true
+   */
+  stylistic?: boolean | StylisticConfig
+
+  /**
+   * Enable gitignore support.
+   *
+   * Passing an object to configure the options.
+   *
+   * @default true
+   */
+  gitignore?: boolean | FlatGitignoreOptions
+}

package/src/typings/index.d.ts

@@ -0,0 +1,3 @@
+declare module 'eslint-plugin-vue'
+declare module '@eslint/js'
+declare module 'parse-gitignore'

package/src/utils/index.ts

@@ -0,0 +1,30 @@
+import type { AnyObject } from '@lntvow/utils'
+
+/**
+ * Rename plugin prefixes in a rule object.
+ * Accepts a map of prefixes to rename.
+ *
+ * @example
+ * ```ts
+ * import { renameRules } from '@lntvow/eslint-config'
+ *
+ * export default [{
+ *   rules: renameRules(
+ *     {
+ *       '@typescript-eslint/indent': 'error'
+ *     },
+ *     { '@typescript-eslint': 'ts' }
+ *   )
+ * }]
+ * ```
+ */
+export function renameRules(rules: AnyObject, map: Record<string, string>) {
+  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/test/js.vue

@@ -0,0 +1,28 @@
+<script setup lang="js">
+import { computed, ref } from 'vue'
+
+// interface Props {
+//   name: string
+//   age: number
+// }
+// defineProps<{
+//   name: string
+//   age: number
+// }>()
+
+console.log('computed: ')
+
+console.log('pro: ', pro)
+
+const a = 10
+
+function test(str) {
+  return <div>{{ str }}</div>
+}
+</script>
+
+<template>
+  <div>111</div>
+</template>
+
+<style lang="scss"></style>

package/test/jsx.vue

@@ -0,0 +1,27 @@
+<script setup lang="jsx">
+import { computed, ref } from 'vue'
+// interface Props {
+//   name: string
+//   age: number
+// }
+// defineProps<{
+//   name: string
+//   age: number
+// }>()
+
+console.log('computed: ')
+
+console.log('pro: ', pro)
+
+const a = 10
+
+function test(str) {
+  return <div>{{ str }}</div>
+}
+</script>
+
+<template>
+  <div>111</div>
+</template>
+
+<style lang="scss"></style>

package/test/test.js

@@ -0,0 +1,11 @@
+import { computed, defineComponent } from 'vue'
+export const test = defineComponent({
+  setup() {
+    console.log('computed: ')
+
+    const pro = computed(() => Promise.all([new Promise((resolve, reject) => {})]))
+    console.log('pro: ', pro)
+
+    const a = 10
+  },
+})

package/test/test.ts

@@ -0,0 +1,18 @@
+import { computed, defineComponent } from 'vue'
+
+export const test = defineComponent({
+  setup() {
+    console.log('computed: ')
+
+    const pro = computed(() => Promise.all([new Promise((resolve, reject) => {})]))
+    console.log('pro: ', pro)
+
+    const a = 10
+  },
+})
+
+function b() {
+  return a
+}
+
+const a = 10

package/test/ts.vue

@@ -0,0 +1,26 @@
+<script setup lang="ts">
+import { computed, ref } from 'vue'
+
+interface Props {
+  name: string
+  age: number
+}
+defineProps<{
+  name: string
+  age: number
+}>()
+
+console.log('computed: ')
+
+const a = 10
+
+function test(str: string) {
+  return <div>{{ str }}</div>
+}
+</script>
+
+<template>
+  <div>111</div>
+</template>
+
+<style lang="scss"></style>

package/test/tsx.vue

@@ -0,0 +1,23 @@
+<script setup lang="tsx">
+import { computed, ref } from 'vue'
+defineProps<{
+  name: string
+  age: number
+}>()
+
+console.log('computed: ')
+
+console.log('pro: ', pro)
+
+const a = 10
+
+function test(str: string) {
+  return <div>{{ str }}</div>
+}
+</script>
+
+<template>
+  <div>111</div>
+</template>
+
+<style lang="scss"></style>

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "target": "ESNext",
+    "jsx": "preserve",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true, // 允许从 .json 文件中导入模块
+
+    "baseUrl": ".",
+    "noImplicitThis": false,
+    "verbatimModuleSyntax": true,
+    "allowSyntheticDefaultImports": true
+  },
+  // "ts-node": {
+  //   "esm": true
+  // },
+  "include": ["src/**/*", "tests/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

package/tsup.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig({
+  format: ['esm'],
+  dts: true,
+  clean: true,
+  entry: ['src/index.ts'],
+  shims: true,
+  // minify: true,
+})

package/index.js

@@ -1,3 +0,0 @@
-module.exports = {
-  extends: ['@lntvow/eslint-config-vue'],
-}