@longzai-intelligence-records/config 0.0.1 → 0.0.3

package/package.json

@@ -1,7 +1,17 @@
 {
   "name": "@longzai-intelligence-records/config",
-  "version": "0.0.1",
+  "version": "0.0.3",
+  "description": "Longzai Intelligence Records 配置",
+  "keywords": [
+    "config",
+    "longzai-intelligence",
+    "records",
+    "schema"
+  ],
   "license": "UNLICENSED",
+  "files": [
+    "dist"
+  ],
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/CHANGELOG.md

@@ -1,12 +0,0 @@
-# 更新日志
-
-本项目的所有重要更改都将记录在此文件中。
-
-格式基于 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.1.0/)，
-本项目遵循 [语义化版本](https://semver.org/lang/zh-CN/)。
-
-## [0.0.1] - 2026-09-27
-
-### 新增
-
-- 新增 @longzai-intelligence-records/config 包提供配置 schema 与加载器

package/lzi-builder.config.ts

@@ -1,11 +0,0 @@
-import { defineConfig } from '@longzai-intelligence-builder/esm';
-
-/**
- * 配置包构建配置
- */
-export default defineConfig({
-  entry: {
-    index: 'src/index.ts',
-  },
-  platform: 'node',
-});

package/oxlint.config.ts

@@ -1,6 +0,0 @@
-import { defineConfig } from '@longzai-intelligence-oxlint/presets/library';
-
-/**
- * Oxlint 配置
- */
-export default defineConfig();

package/src/__tests__/schema/lzi-records-config.schema.test.ts

@@ -1,63 +0,0 @@
-import { describe, expect, test } from 'bun:test';
-
-import { defineConfig, parseLziRecordsConfig } from '@/schema/lzi-records-config.schema';
-import { validateLziRecordsConfig } from '@/validation/validate-cross-entries';
-
-/**
- * lzi-records 配置 schema 解析与跨条目校验测试
- */
-describe('lzi-records-config schema', () => {
-  test('最小合法配置解析且默认值落定', () => {
-    /**
-     * 最小配置
-     */
-    const config = parseLziRecordsConfig(
-      defineConfig({
-        scopes: [{ key: 'root', title: '全局', paths: ['.'], registryDir: 'docs/records' }],
-      }),
-    );
-
-    expect(config.scopes).toHaveLength(1);
-    expect(config.lint.baseline).toEqual([]);
-  });
-
-  test('scope key 形态非法即抛', () => {
-    expect(() =>
-      parseLziRecordsConfig({
-        scopes: [{ key: 'Root', title: '全局', paths: ['.'], registryDir: 'docs/records' }],
-      }),
-    ).toThrow('lzi-records 配置形态非法');
-  });
-
-  test('scopes 空数组即抛（至少一个注册面）', () => {
-    expect(() => parseLziRecordsConfig({ scopes: [] })).toThrow();
-  });
-
-  test('跨条目：注册表目录被两 scope 共用即抛', () => {
-    /**
-     * 共用目录配置
-     */
-    const config = parseLziRecordsConfig({
-      scopes: [
-        { key: 'root', title: '全局', paths: ['.'], registryDir: 'docs/records' },
-        { key: 'sub', title: '子面', paths: ['packages'], registryDir: 'docs/records' },
-      ],
-    });
-
-    expect(() => validateLziRecordsConfig(config)).toThrow(
-      '注册表目录「docs/records」被 root、sub 共用',
-    );
-  });
-
-  test('跨条目：基线豁免文件不在注册面内即抛', () => {
-    /**
-     * 带越界基线的配置
-     */
-    const config = parseLziRecordsConfig({
-      scopes: [{ key: 'root', title: '全局', paths: ['.'], registryDir: 'docs/records' }],
-      lint: { baseline: [{ file: 'docs/other/0001-x.md', rule: 'R-FILENAME', reason: '存量' }] },
-    });
-
-    expect(() => validateLziRecordsConfig(config)).toThrow('不在任何 scope 注册表目录内');
-  });
-});

package/src/index.ts

@@ -1,13 +0,0 @@
-/**
- * 配置包入口
- *
- * 汇出：defineConfig、schema 与解析、跨条目校验、加载器、init 脚手架渲染。
- */
-
-export * from '@/loader/load-records-config.utils';
-
-export * from '@/scaffold/render-scaffold.renderer';
-
-export * from '@/schema/lzi-records-config.schema';
-
-export * from '@/validation/validate-cross-entries';

package/src/loader/load-records-config.utils.ts

@@ -1,180 +0,0 @@
-/**
- * lzi-records 配置加载器
- *
- * 复用 shared-config 的 loadUnifiedConfig 统一加载：优先工具专属
- * lzi-records.config.ts（cwd 向上查找），回退统一配置 lzi.config.ts 的 records
- * 字段；命中后 zod 形态解析 + 跨条目语义校验，非法即抛（加载即失败）。
- */
-
-import { loadUnifiedConfig } from '@longzai-intelligence-shared-config/core';
-import { existsSync } from 'node:fs';
-import { resolve } from 'node:path';
-import { pathToFileURL } from 'node:url';
-
-import { type LziRecordsConfig, parseLziRecordsConfig } from '@/schema/lzi-records-config.schema';
-import { validateLziRecordsConfig } from '@/validation/validate-cross-entries';
-
-/**
- * 配置来源类型
- */
-export type LziRecordsConfigSource = 'standalone' | 'unified' | 'explicit';
-
-/**
- * 加载成功结果
- */
-export type LoadLziRecordsConfigSuccess = {
-  /**
-   * 加载成功标记
-   */
-  ok: true;
-
-  /**
-   * 解析并校验后的配置（默认值全部落定）
-   */
-  config: LziRecordsConfig;
-
-  /**
-   * 命中的配置文件绝对路径
-   */
-  configFilePath: string;
-
-  /**
-   * 配置来源
-   */
-  source: LziRecordsConfigSource;
-};
-
-/**
- * 加载失败结果（未找到配置）
- */
-export type LoadLziRecordsConfigFailure = {
-  /**
-   * 加载成功标记
-   */
-  ok: false;
-
-  /**
-   * 失败原因
-   */
-  reason: string;
-};
-
-/**
- * 加载结果
- */
-export type LoadLziRecordsConfigResult = LoadLziRecordsConfigSuccess | LoadLziRecordsConfigFailure;
-
-/**
- * 加载选项
- */
-export type LoadLziRecordsConfigOptions = {
-  /**
-   * 查找起点目录（缺省 process.cwd()）
-   */
-  cwd?: string;
-
-  /**
-   * 显式配置文件路径（优先级最高，绕过向上查找）
-   */
-  configPath?: string;
-};
-
-/**
- * 解析 + 校验配置对象（形态 + 跨条目，非法即抛带路径上下文）
- *
- * @param input - 配置原始对象
- * @param configFilePath - 配置文件路径（错误消息附注）
- * @returns 解析并校验后的配置
- * @throws {@link Error} 形态或跨条目违规
- */
-function parseAndValidate(input: unknown, configFilePath: string): LziRecordsConfig {
-  try {
-    /**
-     * 形态解析 + 跨条目校验后的配置
-     */
-    return validateLziRecordsConfig(parseLziRecordsConfig(input));
-  } catch (error) {
-    /**
-     * 原始错误消息
-     */
-    const message = error instanceof Error ? error.message : String(error);
-
-    throw new Error(`${message}（配置文件：${configFilePath}）`);
-  }
-}
-
-/**
- * 加载 lzi-records 配置
- *
- * @param options - 加载选项
- * @returns 加载结果：命中返回解析后配置；未找到返回失败（显式路径不存在也按失败处理）
- * @throws {@link Error} 命中配置但形态/跨条目非法（加载即失败语义）
- */
-export async function loadLziRecordsConfig(
-  options: LoadLziRecordsConfigOptions = {},
-): Promise<LoadLziRecordsConfigResult> {
-  if (options.configPath !== undefined) {
-    /**
-     * 显式路径解析结果（相对 cwd 锚定）
-     */
-    const resolved = resolve(options.cwd ?? process.cwd(), options.configPath);
-
-    if (!existsSync(resolved)) {
-      return {
-        ok: false,
-        reason: `未找到配置文件：${resolved}`,
-      };
-    }
-
-    return {
-      ok: true,
-      config: parseAndValidate(await importConfigModule(resolved), resolved),
-      configFilePath: resolved,
-      source: 'explicit',
-    };
-  }
-
-  /**
-   * 统一加载结果（standalone 优先 > unified records 字段）
-   */
-  const unified = await loadUnifiedConfig({
-    standaloneFile: 'lzi-records.config.ts',
-    unifiedField: 'records',
-    cwd: options.cwd,
-  });
-
-  if (!unified.success) {
-    return {
-      ok: false,
-      reason:
-        '未找到 lzi-records.config.ts（且 lzi.config.ts 无 records 字段）——可先执行 lzi-records init',
-    };
-  }
-
-  return {
-    ok: true,
-    config: parseAndValidate(unified.config, unified.configFilePath),
-    configFilePath: unified.configFilePath,
-    source: unified.source,
-  };
-}
-
-/**
- * 按显式文件 URL 动态导入配置模块（测试与工具内部使用）
- *
- * @param configPath - 配置文件绝对路径
- * @returns 配置模块 default 导出
- * @throws {@link Error} 导入失败或无 default 导出
- */
-export async function importConfigModule(configPath: string): Promise<unknown> {
-  /**
-   * 动态导入的配置模块
-   */
-  const module = await import(pathToFileURL(configPath).href);
-
-  if (module.default === undefined) {
-    throw new Error(`配置文件缺少 default 导出：${configPath}`);
-  }
-
-  return module.default;
-}

package/src/scaffold/render-scaffold.renderer.ts

@@ -1,47 +0,0 @@
-/**
- * lzi-records 配置脚手架渲染（init 命令落盘）
- *
- * 渲染 lzi-records.config.ts 全文（单 scope 起步形态）；幂等不覆盖由命令层守卫。
- */
-
-/**
- * 脚手架渲染入参
- */
-export type ConfigScaffoldInput = {
-  /**
-   * scope key（kebab-case）
-   */
-  scopeKey: string;
-
-  /**
-   * scope 人类可读名
-   */
-  scopeTitle: string;
-
-  /**
-   * 注册表目录（posix 相对仓库根）
-   */
-  registryDir: string;
-};
-
-/**
- * 渲染 lzi-records.config.ts 脚手架全文
- *
- * @param input - 脚手架入参
- * @returns 可直接落盘的配置文件全文
- */
-export function renderConfigScaffold(input: ConfigScaffoldInput): string {
-  return [
-    "import { defineConfig } from '@longzai-intelligence-records/config';",
-    '',
-    '/**',
-    ' * lzi-records 配置',
-    ' */',
-    'export default defineConfig({',
-    '  scopes: [',
-    `    { key: '${input.scopeKey}', title: '${input.scopeTitle}', paths: ['.'], registryDir: '${input.registryDir}' },`,
-    '  ],',
-    '});',
-    '',
-  ].join('\n');
-}

package/src/schema/lzi-records-config.schema.ts

@@ -1,122 +0,0 @@
-/**
- * lzi-records 配置 schema 与解析
- *
- * 单一真源 `lzi-records.config.ts` 的形态定义：zod 守形态、跨条目语义由
- * validate-cross-entries 纯函数承担，非法配置在加载即失败。引擎零仓库知识——
- * 一切仓库特有信息（scope 注册、豁免基线）只存在于本配置。
- *
- * records 定位（decisions/021）：广义降级 fallback 通道，无语义分型——配置面
- * 亦无类型维度，仅 scope 注册与 lint 豁免基线。
- */
-
-import * as z from 'zod';
-
-/**
- * scope key 合法形态（kebab-case）
- */
-export const SCOPE_KEY_PATTERN = /^[a-z][a-z0-9-]*$/;
-
-/**
- * init 缺省注册表目录
- */
-export const DEFAULT_REGISTRY_DIR = 'docs/records';
-
-/**
- * 棘轮基线条目 schema（存量豁免逐条带理由登记——存量不追溯，豁免只许缩短）
- */
-export const baselineEntrySchema = z.object({
-  file: z.string().min(1),
-  rule: z.string().min(1),
-  reason: z.string().min(1),
-});
-
-/**
- * scope 注册条目 schema
- */
-const scopeSchema = z.object({
-  key: z.string().regex(SCOPE_KEY_PATTERN),
-  title: z.string().min(1),
-  paths: z.array(z.string().min(1)).min(1),
-  registryDir: z.string().min(1),
-});
-
-/**
- * scope 注册条目（书写形态）
- */
-export type ScopeEntryInput = z.input<typeof scopeSchema>;
-
-/**
- * scope 注册条目（解析后形态）
- */
-export type ScopeEntry = z.output<typeof scopeSchema>;
-
-/**
- * lint 节 schema（baseline 为豁免基线：存量违例逐条登记，只许缩短）
- */
-const lintSchema = z.object({
-  baseline: z.array(baselineEntrySchema).default([]),
-});
-
-/**
- * lzi-records 配置根 schema
- */
-export const lziRecordsConfigSchema = z.object({
-  scopes: z.array(scopeSchema).min(1),
-  lint: lintSchema.default({ baseline: [] }),
-});
-
-/**
- * lzi-records 配置（用户书写形态，可省略各默认值）
- */
-export type LziRecordsConfigInput = z.input<typeof lziRecordsConfigSchema>;
-
-/**
- * lzi-records 配置（解析后形态，默认值全部落定）
- */
-export type LziRecordsConfig = z.output<typeof lziRecordsConfigSchema>;
-
-/**
- * 棘轮基线条目
- */
-export type LintBaselineEntry = z.infer<typeof baselineEntrySchema>;
-
-/**
- * 解析并校验配置（非法即抛，加载即失败）
- *
- * @param input - 配置原始对象（defineConfig 产物）
- * @returns 默认值落定的配置
- * @throws {@link Error} 形态违规（消息聚合全部违规项；跨条目语义校验由
- * validateLziRecordsConfig 在加载链路上追加执行）
- */
-export function parseLziRecordsConfig(input: unknown): LziRecordsConfig {
-  /**
-   * 形态解析结果
-   */
-  const parsed = lziRecordsConfigSchema.safeParse(input);
-
-  if (!parsed.success) {
-    /**
-     * 形态违规明细（路径 + 消息）
-     */
-    const details = parsed.error.issues
-      .map((issue) => `${issue.path.join('.')}: ${issue.message}`)
-      .join('；');
-
-    throw new Error(`lzi-records 配置形态非法：${details}`);
-  }
-
-  return parsed.data;
-}
-
-/**
- * 定义 lzi-records 配置（identity 工厂）
- *
- * 类型透传，与 lzi-dev.config.ts / oxfmt.config.ts 等 workspace 配置惯例同构：
- * 不在工厂层做任何合并——默认值由本模块 schema 解析层统一落定。
- *
- * @param config - 配置对象（可省略各默认值）
- * @returns 原样返回传入的配置对象
- */
-export function defineConfig(config: LziRecordsConfigInput): LziRecordsConfigInput {
-  return config;
-}

package/src/validation/validate-cross-entries.ts

@@ -1,85 +0,0 @@
-/**
- * lzi-records 配置跨条目语义校验（纯函数，零 fs）
- *
- * 形态由 schema 承担；本模块承担条目间语义：scope key 唯一、注册表目录不共用
- * （两 scope 共用同一 registryDir 会造成取号与 lint 双重歧义）、基线豁免文件
- * 须落在某 scope 注册表内。
- */
-
-import type { LziRecordsConfig } from '@/schema/lzi-records-config.schema';
-
-/**
- * 校验并透传配置（语义非法即抛，消息聚合全部违规项）
- *
- * @param config - 形态解析后的配置
- * @returns 原样透传（校验通过）
- * @throws {@link Error} 跨条目语义违规
- */
-export function validateLziRecordsConfig(config: LziRecordsConfig): LziRecordsConfig {
-  /**
-   * 违规消息列表
-   */
-  const violations: string[] = [];
-
-  /**
-   * scope key 重复检测（key → 出现次数）
-   */
-  const keyCounts = new Map<string, number>();
-
-  for (const scope of config.scopes) {
-    keyCounts.set(scope.key, (keyCounts.get(scope.key) ?? 0) + 1);
-  }
-
-  for (const [key, count] of keyCounts) {
-    if (count > 1) {
-      violations.push(`scopes: key「${key}」重复登记 ${count} 次（scope key 必须唯一）`);
-    }
-  }
-
-  /**
-   * 注册表目录重复检测（registryDir → 占用 scope key 列表）
-   */
-  const dirOwners = new Map<string, string[]>();
-
-  for (const scope of config.scopes) {
-    /**
-     * 现占用列表
-     */
-    const owners = dirOwners.get(scope.registryDir) ?? [];
-
-    owners.push(scope.key);
-    dirOwners.set(scope.registryDir, owners);
-  }
-
-  for (const [dir, owners] of dirOwners) {
-    if (owners.length > 1) {
-      violations.push(
-        `scopes: 注册表目录「${dir}」被 ${owners.join('、')} 共用（一目录一 scope，否则取号与 lint 歧义）`,
-      );
-    }
-  }
-
-  /**
-   * 基线豁免文件落点检测（豁免文件须命中某 scope 的注册表目录内）
-   */
-  for (const entry of config.lint.baseline) {
-    /**
-     * 命中标记（文件路径以某 registryDir 前缀开头）
-     */
-    const covered = config.scopes.some(
-      (scope) => entry.file === scope.registryDir || entry.file.startsWith(`${scope.registryDir}/`),
-    );
-
-    if (!covered) {
-      violations.push(
-        `lint.baseline: 豁免条目「${entry.file}」（规则 ${entry.rule}）不在任何 scope 注册表目录内`,
-      );
-    }
-  }
-
-  if (violations.length > 0) {
-    throw new Error(`lzi-records 配置跨条目语义非法：${violations.join('；')}`);
-  }
-
-  return config;
-}