@tienne/gestalt 0.87.0 → 0.89.0

package/dist/src/architecture/doc-scan.d.ts

@@ -0,0 +1,107 @@
+import type { ArchitectureIr, DocGap, DocRoute, DocScreen } from './types.js';
+import { resolveDocLink } from './doc-routes.js';
+export { resolveDocLink };
+/**
+ * 근거 표시와 구멍 표시, 머리줄을 찾는 정규식. 레포마다 형식이 달라 바꿀 수 있게 열어 둔다.
+ * evidence는 첫 캡처가 `종류:위치@ref` 꼴이어야 하고 gap과 unverified는 첫 캡처가 설명이다
+ */
+export interface DocScanPatterns {
+    evidence?: string;
+    gap?: string;
+    unverified?: string;
+    updated?: string;
+    keywordHeader?: string;
+    routeHeader?: string;
+    screenNameHeader?: string;
+}
+export interface DocRoot {
+    repoId: string;
+    name?: string;
+    path: string;
+    /** 이 접두로 시작하는 경로만 훑는다. 비면 전부 */
+    include?: string[];
+    exclude?: string[];
+}
+/** 코드 파일을 가리킨 근거. 링크 상태 검사와 기술 노드 잇기가 이걸 쓴다 */
+export interface DocCodeRef {
+    repo: string;
+    path: string;
+    ref?: string;
+    pinned: 'branch' | 'commit' | 'none';
+    line: number;
+}
+export interface DocScreenRow extends DocScreen {
+    name: string;
+    line: number;
+}
+export interface ScannedDoc {
+    repoId: string;
+    path: string;
+    title?: string;
+    updatedAt?: string;
+    /** 문서 파일의 마지막 커밋 날짜. scan_docs가 git에서 채운다. 순수 스캔에는 없다 */
+    committedAt?: string;
+    sections: string[];
+    gaps: DocGap[];
+    evidenceMix: Record<string, number>;
+    codeRefs: DocCodeRef[];
+    routes: ScannedRoute[];
+    screens: DocScreenRow[];
+    /** 본문의 상대 md 링크. 레포 기준 경로로 편 것 */
+    mdLinks: string[];
+    /** 본문이 말한 `METHOD /path`. 기술 그림 엔드포인트와 맞춰 보는 데 쓴다. 예전 스캔 결과에는 없다 */
+    apiRefs?: DocApiRef[];
+    /** 링크 문법 없이 백틱이나 맨 글자로 적은 md 경로. 어디를 기준으로 적었는지 몰라 편 경로가 아니라 적힌 그대로 둔다 */
+    mdRefs?: string[];
+}
+/** 질문 안내 표 한 줄. link는 표에 적힌 그대로라 옆 폴더 기준으로 적은 경로도 나중에 풀 수 있다 */
+export interface ScannedRoute extends DocRoute {
+    link?: string;
+}
+export interface DocApiRef {
+    method: string;
+    path: string;
+    line: number;
+}
+export interface DocScanResult {
+    docs: ScannedDoc[];
+    skipped: {
+        path: string;
+        reason: string;
+    }[];
+    /** scan_docs가 저장할 때만. link_docs가 문서 레포의 CODEOWNERS를 다시 찾는 데 쓴다 */
+    roots?: {
+        repoId: string;
+        name: string;
+        path: string;
+    }[];
+}
+/** `종류:위치@ref`를 막대 묶음과 코드 참조로 나눈다. 코드가 아니면 ref는 null */
+export declare function parseEvidenceMarker(body: string, line: number): {
+    group: string;
+    ref: DocCodeRef | null;
+};
+/** md 한 파일을 훑는다. 파일 시스템을 안 만져서 테스트가 문자열만 넘기면 된다 */
+export declare function scanMarkdown(repoId: string, path: string, text: string, patterns?: DocScanPatterns): ScannedDoc;
+/** 문서 루트들의 md를 전부 훑는다. 읽기만 한다 */
+export declare function scanDocRoots(roots: DocRoot[], patterns?: DocScanPatterns): DocScanResult;
+export declare const docNodeId: (repoId: string, path: string) => string;
+/**
+ * 훑은 결과로 지식 문서 지도 IR 초안을 만든다. 폴더가 묶음, md가 문서, 화면 색인 표의 행이 화면 문서다.
+ * 질문 안내 표와 화면 색인은 indexes 선으로 잇는다. 세션이 이 초안을 다듬어 render에 넘긴다
+ */
+export declare function buildKnowledgeIr(roots: DocRoot[], scan: DocScanResult, generatedAt: string): ArchitectureIr;
+export interface DocScanSummary {
+    docCount: number;
+    withUpdatedAt: number;
+    gapCount: number;
+    unverifiedCount: number;
+    evidenceMix: Record<string, number>;
+    codeRefCount: number;
+    apiRefCount: number;
+    routeCount: number;
+    unresolvedRouteCount: number;
+    screenCount: number;
+}
+export declare function summarizeScan(scan: DocScanResult): DocScanSummary;
+//# sourceMappingURL=doc-scan.d.ts.map

package/dist/src/architecture/doc-scan.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-scan.d.ts","sourceRoot":"","sources":["../../../src/architecture/doc-scan.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAEV,cAAc,EAEd,MAAM,EAEN,QAAQ,EACR,SAAS,EAEV,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAiC,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAGhF,OAAO,EAAE,cAAc,EAAE,CAAC;AAE1B;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAYD,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,+CAA+C;AAC/C,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;IACrC,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAa,SAAQ,SAAS;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yDAAyD;IACzD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,MAAM,EAAE,YAAY,EAAE,CAAC;IACvB,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,kCAAkC;IAClC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,oEAAoE;IACpE,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;IACtB,yEAAyE;IACzE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,gEAAgE;AAChE,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,UAAU,EAAE,CAAC;IACnB,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC5C,kEAAkE;IAClE,KAAK,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC1D;AAkDD,wDAAwD;AACxD,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GACX;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,UAAU,GAAG,IAAI,CAAA;CAAE,CAyC3C;AA0DD,mDAAmD;AACnD,wBAAgB,YAAY,CAC1B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,QAAQ,GAAE,eAAoB,GAC7B,UAAU,CA6LZ;AAmCD,iCAAiC;AACjC,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,QAAQ,GAAE,eAAoB,GAAG,aAAa,CAgB5F;AAQD,eAAO,MAAM,SAAS,GAAI,QAAQ,MAAM,EAAE,MAAM,MAAM,KAAG,MAAiC,CAAC;AAgB3F;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,OAAO,EAAE,EAChB,IAAI,EAAE,aAAa,EACnB,WAAW,EAAE,MAAM,GAClB,cAAc,CA6IhB;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,aAAa,GAAG,cAAc,CA2BjE"}