@longzai-intelligence-cuts/ledger 0.0.0-stage → 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,253 @@
+import "./rolldown-runtime-BqT_7tdF.js";
+import { LziCutsConfig } from "@longzai-intelligence-cuts/config";
+/**
+ * 注册表 lint 核心
+ *
+ * 六条核心规则守护衍生品标准形态：文件夹命名、正本在场、标题形态、登
+ * 记日期行、三节结构、聚合页一致。读侧判定与写侧渲染共用 `format.utils`
+ * 单一口径。
+ */
+/**
+ * lint 发现
+ */
+type LintFinding = {
+  /**
+   * 规则标识
+   */
+  rule: string;
+  /**
+   * 违规位置即相对注册表的文件或文件夹路径
+   */
+  file: string;
+  /**
+   * 违规描述
+   */
+  message: string;
+};
+/**
+ * lint 结果
+ */
+type LintResult = {
+  /**
+   * 注册表目录路径
+   */
+  registryDir: string;
+  /**
+   * 衍生品总数
+   */
+  cutCount: number;
+  /**
+   * 发现清单
+   */
+  findings: LintFinding[];
+};
+/**
+ * 核心规则标识清单
+ */
+declare const CORE_LINT_RULES: readonly ['folder-kebab-case', 'readme-present', 'entry-title-format', 'entry-date-line', 'entry-three-sections', 'registry-readme-consistent'];
+/**
+ * 运行注册表 lint
+ *
+ * @param registryDir - 注册表目录路径
+ * @returns lint 结果即含全部发现不快速失败
+ */
+declare function runLint(registryDir: string): LintResult;
+/**
+ * 衍生品标题行解析结果类型
+ */
+type CutTitleParts = {
+  /**
+   * 衍生品标题文本
+   */
+  title: string;
+};
+/**
+ * 解析衍生品标题行
+ *
+ * @param line - 标题行文本
+ * @returns 解析结果，未命中为 null
+ */
+declare function parseCutTitleLine(line: string): CutTitleParts | null;
+/**
+ * 衍生品文件夹解析器
+ *
+ * 读入单个衍生品文件夹，产出结构化登记记录：标题、登记日期、三节在场
+ * 态与解析问题清单。
+ */
+/**
+ * 衍生品登记记录
+ */
+type CutRecord = {
+  /**
+   * 衍生品文件夹名
+   */
+  folderName: string;
+  /**
+   * 衍生品文件夹绝对或相对路径
+   */
+  dirPath: string;
+  /**
+   * 衍生品标题，标题未命中为空串
+   */
+  title: string;
+  /**
+   * 登记日期，日期行未命中为 null
+   */
+  registeredDate: string | null;
+  /**
+   * 正文在场节标题清单
+   */
+  presentSections: string[];
+  /**
+   * 正文缺席节标题清单
+   */
+  missingSections: string[];
+  /**
+   * 解析问题清单即无法归入结构字段的形态异常
+   */
+  parseIssues: string[];
+};
+/**
+ * 解析衍生品文件夹
+ *
+ * @param dirPath - 衍生品文件夹路径
+ * @returns 登记记录，正本缺席时记录问题并返回骨架
+ */
+declare function parseCut(dirPath: string): CutRecord;
+/**
+ * 注册表扫描结果
+ */
+type RegistryScan = {
+  /**
+   * 注册表目录路径
+   */
+  registryDir: string;
+  /**
+   * 衍生品登记记录清单即按文件夹名排序
+   */
+  cuts: CutRecord[];
+  /**
+   * 非法文件夹名清单即不匹配 kebab-case 的目录
+   */
+  invalidFolderNames: string[];
+  /**
+   * 注册表 README 是否在场
+   */
+  hasReadme: boolean;
+};
+/**
+ * 扫描注册表目录
+ *
+ * @param registryDir - 注册表目录路径
+ * @returns 扫描结果，目录缺席时返回空集
+ */
+declare function scanRegistryDir(registryDir: string): RegistryScan;
+/**
+ * 衍生品登记模板渲染器
+ *
+ * 渲染建档所需的全部文件文本：登记正本 `README.md`。形态与 format.utils
+ * 单一口径对齐。
+ */
+/**
+ * 登记正本渲染选项
+ */
+type RenderCutTemplateOptions = {
+  /**
+   * 衍生品标题
+   */
+  title: string;
+  /**
+   * 登记日期即 `YYYY-MM-DD` 形态
+   */
+  registeredDate: string;
+};
+/**
+ * 渲染登记正本全文
+ *
+ * @param options - 渲染选项
+ * @returns 登记正本全文文本
+ */
+declare function renderCutTemplate(options: RenderCutTemplateOptions): string;
+/**
+ * 建档模板字段清单即 create 命令必填项
+ */
+declare const TEMPLATE_FIELDS: readonly ['title', 'slug'];
+/**
+ * 衍生品建档核心
+ *
+ * 建档即新建 kebab-case 文件夹并落登记正本 `README.md`，标题即名称无编
+ * 号。落盘后回读校验解析结果。
+ */
+/**
+ * 建档选项
+ */
+type CreateCutOptions = {
+  /**
+   * 注册表目录路径
+   */
+  registryDir: string;
+  /**
+   * 衍生品标题
+   */
+  title: string;
+  /**
+   * 衍生品文件夹 kebab-case 名
+   */
+  slug: string;
+  /**
+   * 登记日期即 `YYYY-MM-DD` 形态
+   *
+   * @default 当日
+   */
+  registeredDate?: string;
+};
+/**
+ * 建档结果
+ */
+type CreateCutResult = {
+  /**
+   * 衍生品文件夹路径
+   */
+  folderPath: string;
+};
+/**
+ * 创建衍生品登记
+ *
+ * @param options - 建档选项
+ * @returns 建档结果
+ * @throws {@link Error} slug 形态非法或文件夹已存在时抛错
+ */
+declare function createCut(options: CreateCutOptions): CreateCutResult;
+/**
+ * 聚合门禁结果
+ */
+type CutsCheckResult = {
+  /**
+   * 全部门禁通过标记
+   */
+  ok: boolean;
+  /**
+   * 汇总退出码即 0 过 1 违规
+   */
+  exitCode: number;
+  /**
+   * 注册表级 lint 结果清单
+   */
+  lintResults: ReturnType<typeof runLint>[];
+};
+/**
+ * 运行聚合门禁
+ *
+ * @param root - 仓库根路径
+ * @param config - 解析后配置
+ * @returns 聚合门禁结果
+ */
+declare function runCutsCheck(root: string, config: LziCutsConfig): CutsCheckResult;
+/**
+ * lint 发现格式化为单行文本
+ *
+ * @param finding - lint 发现
+ * @returns `文件 [规则] 消息` 形态单行
+ */
+declare function formatLintFinding(finding: LintFinding): string;
+export { CORE_LINT_RULES, type CreateCutOptions, type CreateCutResult, type CutRecord, type CutTitleParts, type CutsCheckResult, type LintFinding, type LintResult, type RegistryScan, type RenderCutTemplateOptions, TEMPLATE_FIELDS, createCut, formatLintFinding, parseCut, parseCutTitleLine, renderCutTemplate, runCutsCheck, runLint, scanRegistryDir };

package/dist/index.js

@@ -0,0 +1,4 @@
+import"./rolldown-runtime-BqT_7tdF.js";import{existsSync as e,mkdirSync as t,readFileSync as n,readdirSync as r,writeFileSync as i}from"node:fs";import{join as a}from"node:path";const o=`README.md`,s=`README.md`,c=/^[a-z][a-z0-9]*(?:-[a-z0-9]+)+$/,l=/^#\s+衍生品：(.+)$/,u=/^>\s*登记日期：(\d{4}-\d{2}-\d{2})$/,d=[`一、来源与背景`,`二、产物清单`,`三、说明与定位`];function f(e){let t=l.exec(e);return t===null?null:{title:t[1]??``}}function p(t){let r=t.split(/[\\/]/).pop()??t,i=a(t,o),s={folderName:r,dirPath:t,title:``,registeredDate:null,presentSections:[],missingSections:[],parseIssues:[]};if(!e(i))return s.parseIssues.push(`登记正本 ${o} 缺席`),s;let c=n(i,`utf8`).split(`
+`),l=c.find(e=>e.startsWith(`# `))??``,u=f(l);u===null?s.parseIssues.push(`标题行不符合衍生品形态：${l||`未找到一级标题`}`):s.title=u.title,s.registeredDate=m(c);let p=c.filter(e=>/^##\s+/.test(e));return s.presentSections=d.filter(e=>p.some(t=>t.includes(e))),s.missingSections=d.filter(e=>!s.presentSections.includes(e)),s}function m(e){for(let t of e.slice(0,10)){let e=u.exec(t);if(e!==null)return e[1]??null}return null}function h(e){let t=r(e,{withFileTypes:!0}),n=t.filter(e=>e.isDirectory()).map(e=>e.name),i=n.filter(e=>c.test(e)),o=n.filter(e=>!c.test(e));return{registryDir:e,cuts:i.map(t=>p(a(e,t))).sort((e,t)=>e.folderName.localeCompare(t.folderName)),invalidFolderNames:o,hasReadme:t.some(e=>e.isFile()&&e.name===`README.md`)}}const g=[`folder-kebab-case`,`readme-present`,`entry-title-format`,`entry-date-line`,`entry-three-sections`,`registry-readme-consistent`];function _(e){let t=h(e),n=[];for(let e of t.invalidFolderNames)n.push({rule:`folder-kebab-case`,file:e,message:`衍生品文件夹名必须为 kebab-case 语义命名`});for(let e of t.cuts)v(e,n);return y(t,n),{registryDir:e,cutCount:t.cuts.length,findings:n}}function v(e,t){for(let n of e.parseIssues)n.includes(`缺席`)?t.push({rule:`readme-present`,file:e.folderName,message:`登记正本 ${o} 缺席`}):t.push({rule:`entry-title-format`,file:a(e.folderName,o),message:n});e.title===``&&t.push({rule:`entry-title-format`,file:a(e.folderName,o),message:"标题行必须为 `# 衍生品：名称` 形态"}),e.registeredDate===null&&t.push({rule:`entry-date-line`,file:a(e.folderName,o),message:"头部 10 行内必须含 `> 登记日期：YYYY-MM-DD` 行"}),e.missingSections.length>0&&t.push({rule:`entry-three-sections`,file:a(e.folderName,o),message:`缺席节：${e.missingSections.join(`、`)}`})}function y(e,t){if(!e.hasReadme){t.push({rule:`registry-readme-consistent`,file:s,message:`注册表聚合页 README.md 缺席`});return}let r=n(a(e.registryDir,s),`utf8`),i=/* @__PURE__ */ new Set;for(let e of r.split(`
+`)){let t=/\]\(([^)/]+)\/?\)/.exec(e)?.[1];t!==void 0&&i.add(t)}let o=[...i].filter(t=>!e.cuts.some(e=>e.folderName===t));o.length>0&&t.push({rule:`registry-readme-consistent`,file:s,message:`聚合页引用缺席衍生品文件夹：${o.join(`、`)}`})}function b(e){return[`# 衍生品：${e.title}`,``,`> 登记日期：${e.registeredDate}`,``,`## 一、来源与背景`,``,`## 二、产物清单`,``,`## 三、说明与定位`,``].join(`
+`)}const x=[`title`,`slug`];function S(n){if(!c.test(n.slug))throw Error(`slug 必须为多词 kebab-case 形态：${n.slug}`);let r=a(n.registryDir,n.slug);if(e(r))throw Error(`衍生品文件夹已存在：${r}`);let s=n.registeredDate??(/* @__PURE__ */ new Date()).toISOString().slice(0,10);t(r,{recursive:!0}),i(a(r,o),b({title:n.title,registeredDate:s}));let l=p(r);if(l.title!==n.title)throw Error(`建档后回读标题不一致：期望 ${n.title} 实得 ${l.title}`);return{folderPath:r}}function C(e,t){let n=[];for(let r of t.scopes){let t=a(e,r.registryDir);n.push(_(t))}let r=n.reduce((e,t)=>e+t.findings.length,0);return{ok:r===0,exitCode:r===0?0:1,lintResults:n}}function w(e){return`${e.file} [${e.rule}] ${e.message}`}export{g as CORE_LINT_RULES,x as TEMPLATE_FIELDS,S as createCut,w as formatLintFinding,p as parseCut,f as parseCutTitleLine,b as renderCutTemplate,C as runCutsCheck,_ as runLint,h as scanRegistryDir};

package/dist/rolldown-runtime-BqT_7tdF.js

@@ -0,0 +1 @@
+import"node:module";export{};

package/package.json

@@ -1,6 +1,43 @@
 {
   "name": "@longzai-intelligence-cuts/ledger",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.1",
+  "description": "Longzai Intelligence Cuts 注册表引擎",
+  "keywords": [
+    "cuts",
+    "engine",
+    "ledger",
+    "longzai-intelligence",
+    "registry"
+  ],
+  "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": "lzi-bun test",
+    "test:watch": "lzi-bun test --watch",
+    "test:coverage": "lzi-bun test --coverage",
+    "clean": "lzi-dev-tools clean"
+  },
+  "dependencies": {
+    "@longzai-intelligence-cuts/config": "0.0.1"
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.