@longzai-intelligence-git/config 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,180 @@
+//#region src/types.d.ts
+/**
+ * @longzai-intelligence-git/config
+ *
+ *   配置契约包，承载 lzi-git.config.ts 的类型定义与内置默认预设。
+ *   声明配置形状（types）+ 提供开箱即用的默认选项与默认分组预设（defineConfig 深合并消费）。
+ *   业务逻辑（归一化引擎）在 @longzai-intelligence-git/gitignore-formatter。
+ */
+/**
+ * .gitignore 分组定义
+ *
+ * 用于把散落在 .gitignore 中的模式按主题归类，输出时以 `# <comment>` 作为分组头。
+ */
+interface GitignoreGroup {
+  /**
+   * 分组标题纯文本。
+   *
+   * **不含 `#` 前缀**——输出时由格式化器自动补 `# `，配置层只表达语义文本。
+   * 例如应写 `'依赖与构建产物'`，而非 `'# 依赖与构建产物'`。
+   */
+  readonly comment: string;
+  /**
+   * 归属本组的模式集合。
+   *
+   * 用于把现有 .gitignore 中的行分类到分组；分类时按归一化后的模式精确匹配。
+   */
+  readonly patterns: readonly string[];
+}
+/**
+ * .gitignore 格式化选项
+ *
+ * 控制归一化与分组编排的具体行为。所有字段在 lzi-git.config.ts 中以 Partial 形式可选，
+ * 未提供时由格式化器回退到默认值。
+ */
+interface GitignoreFormatOptions {
+  /**
+   * 是否按 config.groups 重组模式到分组下。
+   *
+   * - true：忽略原文件中的分组结构，按 groups 定义重新归类并输出分组头
+   * - false：保留原文件的 `#` 注释分组结构，仅在组内做归一化/排序/去重
+   */
+  readonly groupByConfig: boolean;
+  /**
+   * 组内是否按大小写敏感升序稳定排序。
+   *
+   * 稳定排序保证相等键的模式不互换相对顺序，避免无谓 diff。
+   */
+  readonly sortWithinGroup: boolean;
+  /**
+   * 归一化后是否去重。
+   *
+   * 去重在尾空白清理之后进行，因此 `foo ` 与 `foo` 视为同一模式。
+   */
+  readonly dedupe: boolean;
+  /**
+   * 分组之间插入的空行数。
+   *
+   * 默认 1。0 表示分组紧邻。
+   */
+  readonly blankLinesBetweenGroups: number;
+  /**
+   * 未匹配任何分组的模式所归入的尾部组标题。
+   *
+   * **纯文本，不含 `#` 前缀**（与 GitignoreGroup.comment 约定一致），输出时自动补 `# `。
+   * 默认 '其他'。
+   */
+  readonly miscGroupComment: string;
+}
+/**
+ * .gitignore 格式化的默认选项。
+ *
+ * 格式化器在用户未覆盖某字段时使用这些值。导出供 lzi-git.config.ts 的类型推断与 CLI 兜底使用。
+ */
+declare const DEFAULT_GITIGNORE_OPTIONS: GitignoreFormatOptions;
+/**
+ * 内置预设键。
+ *
+ * 每个键对应一组通用忽略模式，用户在 lzi-git.config.ts 的 presets 里用同名 boolean 开关控制。
+ * 扩展新预设时在此联合类型追加键名。
+ */
+type GitignorePresetKey = 'node' | 'bun' | 'turbo' | 'coverage' | 'env' | 'idea' | 'vscode' | 'macos' | 'windows' | 'linux' | 'npm' | 'agent';
+/**
+ * 内置预设定义。
+ *
+ * 每个 preset 含：归属分组标题（纯文本，不含 #）、模式集合、默认开关。
+ * - default=true 的 preset 在用户未配置时自动启用（开箱即用）
+ * - default=false 的 preset 需用户显式开启（如 vscode，多数团队希望保留 .vscode 共享配置提交）
+ */
+interface GitignorePresetDefinition {
+  /** 归属分组标题（纯文本，不含 #，输出时自动补） */
+  readonly comment: string;
+  /** 该预设注入的模式集合 */
+  readonly patterns: readonly string[];
+  /** 默认开关（用户未在 presets 里声明时使用） */
+  readonly default: boolean;
+}
+/**
+ * 内置预设表（键 → 定义）。
+ *
+ * 顺序即输出顺序（启用的 preset 按此表顺序生成分组，先于用户自定义 groups）。
+ * 导出供格式化器消费、供 lzi-git.config.ts 类型推断。
+ */
+declare const GITIGNORE_PRESETS: Readonly<Record<GitignorePresetKey, GitignorePresetDefinition>>;
+/**
+ * presets 开关字典（用户在 lzi-git.config.ts 里提供）。
+ *
+ * 键为内置预设名，值为 boolean：true=启用（format 时注入其模式），false=禁用（不注入）。
+ * 未列出的 preset 走其 default 值。
+ */
+type GitignorePresets = Partial<Record<GitignorePresetKey, boolean>>;
+/**
+ * 内置预设的默认开关快照（从 GITIGNORE_PRESETS 派生）。
+ *
+ * defineConfig 合并 presets 时用此作为基底，用户覆盖优先。
+ */
+declare const DEFAULT_GITIGNORE_PRESETS: GitignorePresets;
+/**
+ * lzi-git.config.ts 根配置。
+ *
+ * 顶层按工具域分块，当前仅有 gitignore。后续新增工具域（如 hooks、aliases）时在此扩展。
+ */
+interface LziGitConfig {
+  /**
+   * .gitignore 格式化配置。
+   */
+  readonly gitignore?: {
+    /**
+     * 格式化选项（Partial，未提供字段回退到 DEFAULT_GITIGNORE_OPTIONS）。
+     */
+    readonly options?: Partial<GitignoreFormatOptions>;
+    /**
+     * 内置预设开关字典。
+     *
+     * 控制各内置预设（node/vscode/macos 等）是否启用。未列出的 preset 走其 default。
+     * 启用的 preset 在 format 时会向文件注入其缺失的模式（inject），并作为分组参与输出。
+     *
+     * @example
+     *   // 默认 .vscode 不忽略；开启它进入 ignore
+     *   presets: { vscode: true }
+     */
+    readonly presets?: GitignorePresets;
+    /**
+     * 用户自定义分组定义（项目特有项）。
+     *
+     * 输出顺序：启用的 preset 分组在前，自定义 groups 在后，最后是 misc 组。
+     * 未提供时仅使用 preset 分组。
+     */
+    readonly groups?: readonly GitignoreGroup[];
+  };
+}
+//#endregion
+//#region src/define-config.d.ts
+/**
+ * lzi-git.config.ts 配置定义助手（内置默认预设 + 深合并覆盖）。
+ *
+ * 合并规则：
+ *   - options：浅合并（用户字段覆盖 DEFAULT_GITIGNORE_OPTIONS 对应字段）
+ *   - presets：浅合并（用户开关覆盖 DEFAULT_GITIGNORE_PRESETS 对应键，未列出的走 preset 自身 default）
+ *   - groups：原样保留（用户自定义分组，可选；未提供则无自定义分组）
+ *
+ * 镜像 @longzai-intelligence-oxfmt/config 的 deep-merge defineConfig 模式。
+ *
+ * @example
+ *   // 开箱即用（默认预设：node/macos/env 等启用，vscode 禁用）
+ *   export default defineConfig();
+ *
+ *   // 开启 vscode 忽略（默认禁用）
+ *   export default defineConfig({ gitignore: { presets: { vscode: true } } });
+ *
+ *   // 追加项目特有分组
+ *   export default defineConfig({
+ *     gitignore: { groups: [{ comment: 'Agent', patterns: ['CLAUDE.local.md'] }] },
+ *   });
+ *
+ * @param userConfig - 用户配置（可选，缺省则全用默认）
+ * @returns 合并后的完整配置
+ */
+declare const defineConfig: (userConfig?: LziGitConfig) => LziGitConfig;
+//#endregion
+export { DEFAULT_GITIGNORE_OPTIONS, DEFAULT_GITIGNORE_PRESETS, GITIGNORE_PRESETS, GitignoreFormatOptions, GitignoreGroup, GitignorePresetDefinition, GitignorePresetKey, GitignorePresets, LziGitConfig, defineConfig };

package/dist/index.js

@@ -0,0 +1 @@
+const e={groupByConfig:!0,sortWithinGroup:!0,dedupe:!0,blankLinesBetweenGroups:1,miscGroupComment:`其他`},t={node:{comment:`依赖与构建`,patterns:[`node_modules/`,`.pnp/`,`.pnp.js`,`.pnp.cjs`,`dist/`,`out/`,`build/`,`*.log`,`*.tsbuildinfo`,`tsup.config.bundled_*.mjs`],default:!0},bun:{comment:`Bun`,patterns:[`.bun/`],default:!0},turbo:{comment:`Turbo`,patterns:[`.turbo/`],default:!0},coverage:{comment:`测试覆盖率`,patterns:[`coverage/`,`.nyc_output/`],default:!0},env:{comment:`环境变量`,patterns:[`.env`,`.env.*`,`!.env.example`],default:!0},idea:{comment:`JetBrains IDE`,patterns:[`.idea/`],default:!0},vscode:{comment:`VSCode`,patterns:[`.vscode/`,`!.vscode/settings.json`,`!.vscode/tasks.json`,`!.vscode/launch.json`,`!.vscode/extensions.json`],default:!1},macos:{comment:`macOS 系统文件`,patterns:[`.DS_Store`],default:!0},windows:{comment:`Windows 系统文件`,patterns:[`Thumbs.db`,`ehthumbs.db`,`Desktop.ini`],default:!1},linux:{comment:`Linux 系统文件`,patterns:[`*~`],default:!1},npm:{comment:`npm`,patterns:[`.npmrc`],default:!0},agent:{comment:`AI Agent 本地文件`,patterns:[`CLAUDE.local.md`],default:!0}},n=Object.fromEntries(Object.keys(t).map(e=>[e,t[e].default])),r={gitignore:{options:e,presets:n}},i=t=>{if(t===void 0||t.gitignore===void 0)return r;let i=t.gitignore,a={options:{...e,...i.options},presets:{...n,...i.presets},...i.groups===void 0?{}:{groups:i.groups}};return{...t,gitignore:a}};export{e as DEFAULT_GITIGNORE_OPTIONS,n as DEFAULT_GITIGNORE_PRESETS,t as GITIGNORE_PRESETS,i as defineConfig};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@longzai-intelligence-git/config",
+  "version": "0.0.1",
+  "description": "Longzai Intelligence Git - lzi-git.config.ts 配置契约",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "NODE_ENV=production lzi-builder",
+    "build:prod": "NODE_ENV=production lzi-builder",
+    "prepublishOnly": "bun run build:prod",
+    "typecheck": "bun run typecheck:app && bun run typecheck:node && bun run typecheck:test",
+    "typecheck:app": "lzi-tsgo typecheck tsconfig/app.json",
+    "typecheck:node": "lzi-tsgo typecheck tsconfig/node.json",
+    "typecheck:test": "lzi-tsgo typecheck tsconfig/test.json",
+    "lint": "oxlint && oxfmt --check",
+    "lint:fix": "oxlint --fix && oxfmt",
+    "test": "bun test",
+    "test:watch": "bun test --watch",
+    "test:coverage": "bun test --coverage",
+    "clean": "lzi-dev-cli clean"
+  },
+  "dependencies": {},
+  "devDependencies": {},
+  "peerDependencies": {}
+}