@longzai-intelligence-ledger/config 0.0.1

package/README.md

@@ -0,0 +1,5 @@
+# @longzai-intelligence-ledger/config
+
+Longzai Intelligence Ledger 配置包：`lzi-ledger.config.ts` 的类型定义、`defineConfig` 工厂、常量、配置文件模板与统一加载器，台账形态阈值与豁免声明的唯一出口。
+
+主导出契约：`defineConfig`、`LziLedgerConfig`、`LedgerThresholds`、`LedgerExemptions`、`renderLziLedgerConfigTemplate`、`loadLziLedgerConfig`、`findLziLedgerConfigFile`、`STANDALONE_CONFIG_FILE`、`DEFAULT_STATUS_VOCABULARY`、`ENV_KEYS`。

package/dist/index.d.ts

@@ -0,0 +1,215 @@
+//#region src/types.d.ts
+/**
+ * 台账形态量化阈值组
+ *
+ * 对应族 README 最简索引量化口径，全部为闭区间上限
+ * 行宽按字符计数，中文与半角字符均计一字符
+ */
+type LedgerThresholds = {
+  /**
+   * 索引文件单行最大字符数
+   *
+   * @default 400
+   */
+  maxLineLength: number;
+  /**
+   * 工作流档最大行数
+   *
+   * @default 100
+   */
+  maxWorkstreamLines: number;
+  /**
+   * 工作流档最大字节数
+   *
+   * @default 16000
+   */
+  maxWorkstreamBytes: number;
+};
+/**
+ * 台账形态豁免组
+ *
+ * 豁免以相对台账族根的 glob 声明，支持 `*` 单段与 `**` 跨段通配
+ */
+type LedgerExemptions = {
+  /**
+   * 体量豁免清单
+   *
+   * 命中者不受工作流档行数与字节数上限约束，行宽与链接规则仍然生效
+   * 典型形态为并档承袭档，原账总账全文迁入且内容逐字保留
+   *
+   * @default [ ]
+   */
+  sizeExemptGlobs: string[];
+  /**
+   * 临时路径豁免清单
+   *
+   * 命中者不执行临时目录路径禁令，典型形态为引述 gitignore 模式枚举的正档案
+   *
+   * @default [ ]
+   */
+  tmpPathAllowGlobs: string[];
+  /**
+   * 哈希禁令豁免清单
+   *
+   * 命中者不受索引面提交哈希禁令约束，典型形态为并档承袭档
+   *
+   * @default [ ]
+   */
+  hashExemptGlobs: string[];
+};
+/**
+ * LziLedger 配置
+ *
+ * 定义 `lzi-ledger.config.ts` 配置文件的结构，由 `lzi-ledger check` 消费
+ */
+type LziLedgerConfig = {
+  /**
+   * 台账族根目录，相对消费仓仓库根
+   *
+   * @default 'docs/ledgers'
+   */
+  ledgersRoot: string;
+  /**
+   * 量化阈值覆写
+   *
+   * 未声明的阈值项沿用默认值
+   */
+  thresholds: Partial<LedgerThresholds>;
+  /**
+   * 豁免清单
+   */
+  exemptions: LedgerExemptions;
+  /**
+   * 附加状态词表
+   *
+   * 在默认词表之外追加合法状态值，适配各账自定义工作流级状态
+   *
+   * @default [ ]
+   */
+  extraStatusVocabulary: string[];
+};
+//#endregion
+//#region src/define.config.d.ts
+/**
+ * 定义 LziLedger 配置
+ *
+ * 填充缺省字段后原样返回，提供完整类型推导
+ * 纯数据整理，运行时无副作用
+ *
+ * @example
+ *   ```typescript
+ *   import { defineConfig } from '@longzai-intelligence-ledger/config';
+ *
+ *   export default defineConfig({
+ *     exemptions: {
+ *       sizeExemptGlobs: ['compliance-clearance/workstreams/00*.md'],
+ *     },
+ *   });
+ *   ```;
+ *
+ * @param config - LziLedger 配置对象，可省略全部字段
+ * @returns 填充缺省值后的完整配置对象
+ */
+declare const defineConfig: (config?: Partial<LziLedgerConfig>) => LziLedgerConfig;
+//#endregion
+//#region src/constants.d.ts
+/**
+ * standalone 配置文件名
+ *
+ * 消费仓仓库根的 `lzi-ledger.config.ts`，是台账形态阈值与豁免声明的单一真源
+ */
+declare const STANDALONE_CONFIG_FILE = "lzi-ledger.config.ts";
+/**
+ * 统一配置字段名
+ *
+ * 消费仓选择统一配置形态时，`lzi.config.ts` 中承载 LziLedger 配置的字段名
+ */
+declare const UNIFIED_CONFIG_FIELD = "ledger";
+/**
+ * 默认台账族根目录，相对消费仓仓库根
+ */
+declare const DEFAULT_LEDGERS_ROOT = "docs/ledgers";
+/**
+ * 默认状态词表
+ *
+ * 聚合表与工作流档状态位的合法取值，`已并入 NNN` 形态由引擎按模式识别
+ */
+declare const DEFAULT_STATUS_VOCABULARY: readonly ['待建档', '待启动', '进行中', '已收口', '不适用'];
+/**
+ * lzi-ledger 自身消费的环境变量名单一真源
+ *
+ * 新增环境变量先入本名单再使用，禁止裸字符串散落
+ * 当前版本不消费任何自有环境变量，保留空记录固化规范位
+ */
+declare const ENV_KEYS: {};
+//#endregion
+//#region src/config-template.utils.d.ts
+/**
+ * 配置文件模板渲染
+ *
+ * 为 `lzi-ledger init` 生成 `lzi-ledger.config.ts` 存根
+ * 存根只携带注释指引与空骨架，阈值一律沿用默认值
+ */
+/**
+ * 配置模板参数
+ */
+type LziLedgerConfigTemplateParams = {
+  /**
+   * 是否带豁免示例注释
+   *
+   * @default false
+   */
+  withExemptionExamples?: boolean;
+};
+/**
+ * 渲染 lzi-ledger 配置文件模板
+ *
+ * @param params - 模板参数，控制是否附带豁免示例注释
+ * @returns 配置文件全文
+ */
+declare const renderLziLedgerConfigTemplate: (params?: LziLedgerConfigTemplateParams) => string;
+//#endregion
+//#region src/load.config.d.ts
+/**
+ * 配置来源
+ */
+type LziLedgerConfigSource = 'standalone' | 'unified';
+/**
+ * 配置加载结果
+ */
+type LziLedgerConfigResult = {
+  /**
+   * 加载后的 LziLedger 配置对象
+   */
+  config: Partial<LziLedgerConfig>;
+  /**
+   * 命中的配置文件绝对路径
+   */
+  configFilePath: string;
+  /**
+   * 配置来源，standalone 专属文件或 unified 统一配置字段
+   */
+  source: LziLedgerConfigSource;
+};
+/**
+ * 查找配置文件路径
+ *
+ * 从起点目录向上查找 `lzi-ledger.config.ts`
+ *
+ * @param cwd - 查找起点目录，缺省为当前工作目录
+ * @returns 配置文件的绝对路径，未找到时返回 null
+ */
+declare const findLziLedgerConfigFile: (cwd?: string) => string | null;
+/**
+ * 加载 LziLedger 配置
+ *
+ * shared-config 标准组合，standalone 优先，unified 兜底，整配置生效不做字段级合并
+ * 调用方负责对返回的局部配置做缺省填充
+ *
+ * @param cwd - 查找起点目录，缺省为当前工作目录
+ * @returns 配置加载结果，两种形态均未命中时返回 null
+ * @throws {@link Error} 当配置文件存在但动态加载或解析失败时，由 loadUnifiedConfig 透传
+ */
+declare const loadLziLedgerConfig: (cwd?: string) => Promise<LziLedgerConfigResult | null>;
+//#endregion
+export { DEFAULT_LEDGERS_ROOT, DEFAULT_STATUS_VOCABULARY, ENV_KEYS, type LedgerExemptions, type LedgerThresholds, type LziLedgerConfig, type LziLedgerConfigResult, type LziLedgerConfigSource, type LziLedgerConfigTemplateParams, STANDALONE_CONFIG_FILE, UNIFIED_CONFIG_FIELD, defineConfig, findLziLedgerConfigFile, loadLziLedgerConfig, renderLziLedgerConfigTemplate };

package/dist/index.js

@@ -0,0 +1,17 @@
+import{loadUnifiedConfig as e,resolveStandaloneConfigPath as t}from"@longzai-intelligence-shared-config/core";const n=(e={})=>({ledgersRoot:e.ledgersRoot??`docs/ledgers`,thresholds:e.thresholds??{},exemptions:{sizeExemptGlobs:e.exemptions?.sizeExemptGlobs??[],tmpPathAllowGlobs:e.exemptions?.tmpPathAllowGlobs??[],hashExemptGlobs:e.exemptions?.hashExemptGlobs??[]},extraStatusVocabulary:e.extraStatusVocabulary??[]}),r=`lzi-ledger.config.ts`,i=`ledger`,a=`docs/ledgers`,o=[`待建档`,`待启动`,`进行中`,`已收口`,`不适用`],s={},c=(e={})=>`import { defineConfig } from '@longzai-intelligence-ledger/config';
+
+/**
+ * lzi-ledger 台账形态门禁配置
+ *
+ * 量化口径正源为台账族 README，本文件只做阈值覆写与豁免声明
+ * 阈值默认值为单行 400 字符，工作流档 100 行且 16000 字节
+ */
+export default defineConfig({
+${e.withExemptionExamples===!0?`  exemptions: {
+    // 体量豁免，并档承袭档原账全文迁入者适用，行宽与链接规则仍生效
+    sizeExemptGlobs: [],
+    // 临时路径豁免，引述 gitignore 模式枚举的正档案适用
+    tmpPathAllowGlobs: [],
+  },
+`:``}});
+`,l=e=>t(r,e),u=async t=>{let n=await e({standaloneFile:r,unifiedField:i,cwd:t});return n.success?{config:n.config,configFilePath:n.configFilePath,source:n.source}:null};export{a as DEFAULT_LEDGERS_ROOT,o as DEFAULT_STATUS_VOCABULARY,s as ENV_KEYS,r as STANDALONE_CONFIG_FILE,i as UNIFIED_CONFIG_FIELD,n as defineConfig,l as findLziLedgerConfigFile,u as loadLziLedgerConfig,c as renderLziLedgerConfigTemplate};

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@longzai-intelligence-ledger/config",
+  "version": "0.0.1",
+  "description": "Longzai Intelligence Ledger 配置",
+  "keywords": [
+    "config",
+    "ledger",
+    "longzai-intelligence",
+    "schema"
+  ],
+  "license": "UNLICENSED",
+  "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": "lzi-builder",
+    "build:prod": "NODE_ENV=production bun run build",
+    "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": {
+    "@longzai-intelligence-shared-config/core": "^0.0.7"
+  }
+}