feat(gitignore): add config gitignore

package.json

@@ -60,6 +60,7 @@
     "@types/eslint": "^9.6.1",
     "@unocss/eslint-plugin": "^0.62.3",
     "@vitest/eslint-plugin": "^1.1.0",
+    "eslint-config-flat-gitignore": "^0.3.0",
     "eslint-flat-config-utils": "^0.3.1",
     "eslint-plugin-command": "^0.2.3",
     "eslint-plugin-import-x": "^4.2.1",

scripts/generateType.ts

@@ -3,6 +3,7 @@ import { flatConfigsToRulesDTS } from 'eslint-typegen/core'
 import {
   command,
   comments,
+  gitignore,
   ignores,
   imports,
   javascript,
@@ -30,6 +31,7 @@ const configs = [
   ...comments(),
   ...ignores(),
   ...imports(),
+  ...gitignore(),
   ...javascript(),
   ...jsdoc(),
   ...jsonc(),

src/configs/gitignore.ts

@@ -0,0 +1,9 @@
+import createGitIgnore from 'eslint-config-flat-gitignore'
+import type { ConfigGitIgnoreOptions, TypedConfigItem } from '../types'
+
+export const gitignore = (options: ConfigGitIgnoreOptions = {}): TypedConfigItem[] => [
+  {
+    ...createGitIgnore(options),
+    name: 'ntnyq/gitignore',
+  },
+]

src/configs/index.ts

@@ -17,6 +17,8 @@ export * from './perfectionist'
 
 export * from './regexp'
 export * from './unocss'
+
+export * from './gitignore'
 export * from './command'
 
 export * from './vitest'

src/core.ts

@@ -14,6 +14,7 @@ import {
 import {
   command,
   comments,
+  gitignore,
   ignores,
   imports,
   javascript,
@@ -41,7 +42,13 @@ import type { Arrayable, ConfigOptions, TypedConfigItem } from './types'
  * Config factory
  */
 export function ntnyq(options: ConfigOptions = {}, customConfig: Arrayable<TypedConfigItem> = []) {
-  const configs: TypedConfigItem[] = [
+  const configs: TypedConfigItem[] = []
+
+  if (options.gitignore ?? true) {
+    configs.push(...gitignore(resolveSubOptions(options, 'gitignore')))
+  }
+
+  configs.push(
     /**
      * Basic
      */
@@ -57,7 +64,7 @@ export function ntnyq(options: ConfigOptions = {}, customConfig: Arrayable<Typed
       ...resolveSubOptions(options, 'javascript'),
       overrides: getOverrides(options, 'javascript'),
     }),
-  ]
+  )
 
   if (options.unicorn ?? true) {
     configs.push(

src/types/config.ts

@@ -2,6 +2,7 @@
  * @file Config options
  */
 
+import type { FlatGitignoreOptions } from 'eslint-config-flat-gitignore'
 import type { ParserOptions, TypedConfigItem } from './eslint'
 
 /**
@@ -22,6 +23,8 @@ export interface OptionsOverrides<
 
 export type ConfigIgnoresOptions = string[]
 
+export type ConfigGitIgnoreOptions = FlatGitignoreOptions
+
 export interface ConfigJsdocOptions extends OptionsOverrides {}
 
 export interface ConfigUnoCSSOptions extends OptionsOverrides {}
@@ -103,6 +106,8 @@ export interface ConfigOptions {
 
   ignores?: ConfigIgnoresOptions
 
+  gitignore?: boolean | ConfigGitIgnoreOptions
+
   imports?: ConfigImportsOptions
 
   javascript?: ConfigJavaScriptOptions