feat: support reading .gitignore by default

Author: coderwyd

eslint.config.js

@@ -11,7 +11,7 @@ require('sucrase/register')
 export default coderwyd(
   undefined,
   {
-    files: ['**/eslint-config/src/**/*.ts'],
+    files: ['src/**/*.ts'],
     plugins: {
       '@stylistic/migrate': stylisticMigrate,
       'sort-keys': sortKeys,

package.json

@@ -10,8 +10,10 @@
     "eslint-config"
   ],
   "exports": {
-    "import": "./dist/index.js",
-    "require": "./dist/index.cjs"
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
   },
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -26,11 +28,11 @@
     "node": ">=16.14.0"
   },
   "scripts": {
-    "build": "tsup src/index.ts --format esm --clean --dts",
+    "build": "tsup src/index.ts --format esm,cjs --clean --dts",
     "stub": "tsup src/index.ts --format esm",
     "lint": "pnpm run stub && eslint .",
-    "prepublishOnly": "nr build",
-    "release": "bumpp && npm publish",
+    "prepack": "nr build",
+    "release": "bumpp && pnpm publish",
     "test": "vitest",
     "typecheck": "tsc --noEmit",
     "prepare": "simple-git-hooks"
@@ -45,6 +47,7 @@
     "@typescript-eslint/eslint-plugin": "^6.7.2",
     "@typescript-eslint/parser": "^6.7.2",
     "astro-eslint-parser": "^0.15.0",
+    "eslint-config-flat-gitignore": "^0.1.0",
     "eslint-define-config": "^1.23.0",
     "eslint-plugin-antfu": "1.0.0-beta.6",
     "eslint-plugin-astro": "^0.29.0",

pnpm-lock.yaml

@@ -3,6 +3,7 @@ import globals from 'globals'
 import { pluginAntfu, pluginUnusedImports } from '../plugins'
 import { OFF } from '../flags'
 import type { OptionsIsInEditor } from '../types'
+import { GLOB_SRC, GLOB_SRC_EXT } from '../globs'
 
 export function javascript(options: OptionsIsInEditor = {}): FlatESLintConfigItem[] {
   return [
@@ -48,7 +49,7 @@ export function javascript(options: OptionsIsInEditor = {}): FlatESLintConfigIte
         'max-statements-per-line': ['error', { max: 1 }],
         'new-cap': ['error', { capIsNew: false, newIsCap: true, properties: true }],
         'new-parens': 'error',
-        'no-alert': 'warn',
+        'no-alert': 'error',
         'no-array-constructor': 'error',
         'no-async-promise-executor': 'error',
         'no-caller': 'error',
@@ -213,7 +214,7 @@ export function javascript(options: OptionsIsInEditor = {}): FlatESLintConfigIte
 
         'unused-imports/no-unused-imports': options.isInEditor ? OFF : 'error',
         'unused-imports/no-unused-vars': [
-          'warn',
+          'error',
           { args: 'after-used', argsIgnorePattern: '^_', vars: 'all', varsIgnorePattern: '^_' },
         ],
 
@@ -225,7 +226,7 @@ export function javascript(options: OptionsIsInEditor = {}): FlatESLintConfigIte
       },
     },
     {
-      files: ['scripts/**/*.*', 'cli.*'],
+      files: [`scripts/${GLOB_SRC}`, `cli.${GLOB_SRC_EXT}`],
       rules: {
         'no-console': OFF,
       },

src/configs/javascript.ts

@@ -11,8 +11,8 @@ export const javascriptStylistic: FlatESLintConfigItem[] = [
       style: pluginStylisticJs,
     },
     rules: {
+      'antfu/consistent-list-newline': 'error',
       'antfu/if-newline': 'error',
-      'antfu/consistent-object-newline': 'error',
 
       'comma-dangle': ['error', 'always-multiline'],
       'curly': ['error', 'multi-or-nest', 'consistent'],
@@ -27,8 +27,6 @@ export const javascriptStylistic: FlatESLintConfigItem[] = [
       'style/comma-style': ['error', 'last'],
       'style/computed-property-spacing': ['error', 'never', { enforceForClassMembers: true }],
       'style/dot-location': ['error', 'property'],
-      'style/func-call-spacing': OFF,
-      'style/generator-star-spacing': OFF,
       'style/indent': ['error', 2, {
         ArrayExpression: 1,
         CallExpression: { arguments: 1 },
@@ -77,7 +75,6 @@ export const javascriptStylistic: FlatESLintConfigItem[] = [
       'style/no-tabs': 'error',
       'style/no-trailing-spaces': 'error',
       'style/no-whitespace-before-property': 'error',
-      'style/object-curly-newline': OFF,
       'style/object-curly-spacing': ['error', 'always'],
       'style/object-property-newline': ['error', { allowMultiplePropertiesPerLine: true }],
       'style/operator-linebreak': ['error', 'before'],

src/configs/stylistic.ts

@@ -66,13 +66,14 @@ export function typescript(options?: OptionsComponentExts): FlatESLintConfigItem
         'ts/explicit-module-boundary-types': OFF,
         'ts/naming-convention': OFF,
         'ts/no-dupe-class-members': 'error',
+        'ts/no-dynamic-delete': OFF,
         'ts/no-empty-function': OFF,
         'ts/no-empty-interface': OFF,
         'ts/no-explicit-any': OFF,
         'ts/no-extra-parens': ['error', 'functions'],
         'ts/no-invalid-this': 'error',
-        'ts/no-loss-of-precision': 'error',
         'ts/no-invalid-void-type': OFF,
+        'ts/no-loss-of-precision': 'error',
         'ts/no-non-null-assertion': OFF,
         'ts/no-redeclare': 'error',
         'ts/no-require-imports': 'error',

src/configs/typescript.ts

@@ -55,6 +55,8 @@ export function vue(options: OptionsHasTypeScript = {}): FlatESLintConfigItem[]
       rules: {
         ...(isVue3 ? vue3Rules : vue2Rules),
 
+        'node/prefer-global/process': OFF,
+
         'vue/array-bracket-spacing': ['error', 'never'],
         'vue/arrow-spacing': ['error', { after: true, before: true }],
         'vue/block-order': ['error', {
@@ -86,7 +88,6 @@ export function vue(options: OptionsHasTypeScript = {}): FlatESLintConfigItem[]
         'vue/keyword-spacing': ['error', { after: true, before: true }],
         'vue/max-attributes-per-line': OFF,
         'vue/multi-word-component-names': OFF,
-        'vue/no-constant-condition': 'warn',
         'vue/no-dupe-keys': OFF,
         'vue/no-empty-pattern': 'error',
         'vue/no-extra-parens': ['error', 'functions'],
@@ -100,7 +101,6 @@ export function vue(options: OptionsHasTypeScript = {}): FlatESLintConfigItem[]
         ],
         'vue/no-restricted-v-bind': ['error', '/^v-/'],
 
-        // reactivity transform
         'vue/no-setup-props-reactivity-loss': OFF,
         'vue/no-sparse-arrays': 'error',
         'vue/no-unused-refs': 'error',

src/configs/vue.ts

@@ -1,6 +1,8 @@
 import process from 'node:process'
+import fs from 'node:fs'
 import type { FlatESLintConfigItem } from 'eslint-define-config'
 import { isPackageExists } from 'local-pkg'
+import gitignore from 'eslint-config-flat-gitignore'
 import {
   astro,
   comments,
@@ -48,16 +50,29 @@ export function coderwyd(options: OptionsConfig & FlatESLintConfigItem = {}, ...
 
   const enableTypeScript = options.typescript ?? (isPackageExists('typescript'))
   const enableStylistic = options.stylistic ?? true
+  const enableGitignore = options.gitignore ?? true
 
-  const configs = [
+  const configs: FlatESLintConfigItem[][] = []
+  if (enableGitignore) {
+    if (typeof enableGitignore !== 'boolean') {
+      configs.push([gitignore(enableGitignore)])
+    }
+    else {
+      if (fs.existsSync('.gitignore'))
+        configs.push([gitignore()])
+    }
+  }
+
+  // Base configs
+  configs.push(
     ignores,
     javascript({ isInEditor }),
     comments,
     node,
     jsdoc,
     imports,
     unicorn,
-  ]
+  )
 
   // In the future we may support more component extensions like Svelte or so
   const componentExts: string[] = []

src/factory.ts

@@ -1,3 +1,5 @@
+import type { FlatGitignoreOptions } from 'eslint-config-flat-gitignore'
+
 export interface OptionsComponentExts {
   /**
    * Additional extensions for components.
@@ -22,6 +24,16 @@ export interface OptionsIsInEditor {
 }
 
 export interface OptionsConfig {
+  /**
+   * Enable gitignore support.
+   *
+   * Passing an object to configure the options.
+   *
+   * @see https://github.com/antfu/eslint-config-flat-gitignore
+   * @default true
+   */
+  gitignore?: boolean | FlatGitignoreOptions
+
   /**
    * Enable TypeScript support.
    *