@cuiqg/eslint-config 2.2.2 → 2.3.0

package/LICENSE

@@ -1,24 +1,24 @@
-This is free and unencumbered software released into the public domain.
-
-Anyone is free to copy, modify, publish, use, compile, sell, or
-distribute this software, either in source code form or as a compiled
-binary, for any purpose, commercial or non-commercial, and by any
-means.
-
-In jurisdictions that recognize copyright laws, the author or authors
-of this software dedicate any and all copyright interest in the
-software to the public domain. We make this dedication for the benefit
-of the public at large and to the detriment of our heirs and
-successors. We intend this dedication to be an overt act of
-relinquishment in perpetuity of all present and future rights to this
-software under copyright law.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
-OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
-
-For more information, please refer to <https://unlicense.org>
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org/>

package/README.md

@@ -1,45 +1,3 @@
-# @cuiqg/eslint-config [![npm](https://img.shields.io/npm/v/%40cuiqg%2Feslint-config?style=flat-square)](https://www.npmjs.com/package/@cuiqg/eslint-config)
-
-## 使用
-
-```bash
-npm i -D eslint @cuiqg/eslint-config
-```
-
-修改 `package.json` 文件
-
-```diff
-{
-+ "type": "module",
-  "scripts": {
-+   "lint": "eslint .",
-+   "lint:fix": "eslint . --fix"
-  }
-}
-```
-
-创建 `eslint.config.js` 文件
-
-```js
-import cuiqg from '@cuiqg/eslint-config'
-
-export default cuiqg()
-```
-
-## 插件配置
-
-安装 [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
-
-创建配置文件 `.vscode/settings.json`
-
-```json
-{
-  "prettier.enable": false,
-  "editor.formatOnSave": false,
-  "eslint.useFlatConfig": true,
-  "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": "explicit",
-    "source.organizeImports": "never"
-  }
-}
-```
+<p align="center">
+  <img loading="lazy" src="https://boost.jpgcdn.com/c2.jpgcdn.com/2025/08/26/DzA8.png" width="100%"/>
+</p>

package/dist/index.d.ts

@@ -0,0 +1,124 @@
+import { FlatConfigComposer } from "eslint-flat-config-utils";
+import { Linter } from "eslint";
+
+//#region src/types.d.ts
+type Awaitable<T> = T | Promise<T>;
+type FlatConfigItem = Omit<Linter.Config, 'plugins'> & {
+  plugins?: Record<string, any>;
+};
+interface OptionsOverrides {
+  overrides?: Linter.Config['rules'];
+}
+interface OptionsFiles {
+  files?: Array<string | string[]>;
+}
+interface OptionsConfig {
+  /**
+   * @default true
+   */
+  gitignore?: boolean;
+  /**
+   * @default true
+   */
+  javascript?: boolean;
+  /**
+   * @default hasTypeScript()
+   */
+  typescript?: boolean;
+  /**
+   * @default true
+   */
+  imports?: boolean;
+  /**
+   * @default hasVue()
+   */
+  vue?: boolean;
+  /**
+   * @default false
+   */
+  prettier?: boolean;
+  /**
+   * @default hasUnoCss()
+   */
+  unocss?: boolean;
+  /**
+   * @default false
+   */
+  nextjs?: boolean;
+}
+//#endregion
+//#region src/presets.d.ts
+declare const defaultPluginRenaming: {
+  '@next/next': string;
+  n: string;
+  vitest: string;
+  yml: string;
+  '@typescript-eslint': string;
+};
+declare function cuiqg(options?: OptionsConfig & Omit<FlatConfigItem, 'files'>, ...userConfigs: Awaitable<FlatConfigItem | FlatConfigItem[]>[]): FlatConfigComposer<FlatConfigItem, string>;
+//#endregion
+//#region src/configs/nextjs.d.ts
+declare function nextjs(): Promise<FlatConfigItem[]>;
+//#endregion
+//#region src/configs/node.d.ts
+declare function node(): Promise<FlatConfigItem[]>;
+//#endregion
+//#region src/configs/package-json.d.ts
+declare function packageJson(): Promise<FlatConfigItem[]>;
+//#endregion
+//#region src/configs/vue.d.ts
+declare function vue(): Promise<FlatConfigItem[]>;
+//#endregion
+//#region src/configs/ignores.d.ts
+declare function ignores(): Promise<FlatConfigItem[]>;
+//#endregion
+//#region src/configs/unocss.d.ts
+declare function unocss(): Promise<FlatConfigItem[]>;
+//#endregion
+//#region src/configs/de-morgan.d.ts
+declare function deMorgan(): Promise<FlatConfigItem[]>;
+//#endregion
+//#region src/configs/prettier.d.ts
+declare function prettier(): Promise<FlatConfigItem[]>;
+//#endregion
+//#region src/configs/javascript.d.ts
+declare function javascript(): Promise<FlatConfigItem[]>;
+//#endregion
+//#region src/configs/typescript.d.ts
+declare function typescript(): Promise<FlatConfigItem[]>;
+//#endregion
+//#region src/env.d.ts
+declare const isInGitHookOrLintStaged: () => boolean;
+declare const isInEditor: () => boolean;
+declare const hasVue: () => boolean;
+declare const hasTypeScript: () => boolean;
+declare const hasUnoCss: () => boolean;
+declare const hasNextjs: () => boolean;
+//#endregion
+//#region src/globs.d.ts
+declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
+declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
+declare const GLOB_TS = "**/*.?([cm])ts";
+declare const GLOB_TSX = "**/*.?([cm])tsx";
+declare const GLOB_JS = "**/*.?([cm])js";
+declare const GLOB_JSX = "**/*.?([cm])jsx";
+declare const GLOB_STYLE = "**/*.{c,le,sc}ss";
+declare const GLOB_CSS = "**/*.css";
+declare const GLOB_SCSS = "**/*.scss";
+declare const GLOB_LESS = "**/*.less";
+declare const GLOB_STYLUS = "**/*.styl";
+declare const GLOB_POSTCSS = "**/*.{p,post}css";
+declare const GLOB_JSON = "**/*.json";
+declare const GLOB_JSON5 = "**/*.json5";
+declare const GLOB_JSONC = "**/*.jsonc";
+declare const GLOB_MARKDOWN = "**/*.md";
+declare const GLOB_VUE = "**/*.vue";
+declare const GLOB_YAML = "**/*.y?(a)ml";
+declare const GLOB_TOML = "**/*.toml";
+declare const GLOB_XML = "**/*.xml";
+declare const GLOB_SVG = "**/*.svg";
+declare const GLOB_HTML = "**/*.htm?(l)";
+declare const GLOB_ALL_SRC: string[];
+declare const GLOB_EXCLUDE: string[];
+//#endregion
+export { Awaitable, FlatConfigItem, GLOB_ALL_SRC, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_STYLUS, GLOB_SVG, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_XML, GLOB_YAML, OptionsConfig, OptionsFiles, OptionsOverrides, cuiqg, deMorgan, cuiqg as default, defaultPluginRenaming, hasNextjs, hasTypeScript, hasUnoCss, hasVue, ignores, isInEditor, isInGitHookOrLintStaged, javascript, nextjs, node, packageJson, prettier, typescript, unocss, vue };