@tienne/gestalt 0.84.2 → 0.86.0

package/dist/src/humanize/overlap.d.ts

@@ -0,0 +1,116 @@
+export type ExampleKind = 'before' | 'after' | 'exempt';
+export interface RuleExample {
+    ruleId: string;
+    kind: ExampleKind;
+    text: string;
+    /** 예시가 나온 문장. 후보 질문에 그대로 붙인다 */
+    sentence: string;
+    line: number;
+}
+export interface RuleEntry {
+    id: string;
+    file: string;
+    line: number;
+    /** 행과 그 룰에 딸린 문단의 문장 전부 */
+    sentences: RuleSentence[];
+    examples: RuleExample[];
+}
+export interface RuleSentence {
+    text: string;
+    line: number;
+    exception: boolean;
+}
+export interface DetectorSet {
+    /** 탐지기가 있는 룰 ID */
+    ids: readonly string[];
+    /** 걸린 룰 ID와 걸린 문자열 */
+    run: (text: string) => Array<{
+        ruleId: string;
+        samples: string[];
+    }>;
+}
+/** 이 레포 탐지기. 과거 커밋을 재현할 때는 그 커밋의 탐지기로 같은 꼴을 만들어 넘긴다 */
+export declare const RULE_DETECTORS: DetectorSet;
+export type FindingCode = 'after-hit' | 'before-miss' | 'exempt-hit-self' | 'form-exempt-hit' | 'exempt-hit-other' | 'before-hit-other';
+export interface MatrixFinding {
+    code: FindingCode;
+    /** error는 게이트를 막는다. info는 리뷰 단계에 보이기만 한다 */
+    level: 'error' | 'info';
+    ruleId: string;
+    /** 걸린 탐지기 룰. before-miss는 자기 자신 */
+    hitBy: string;
+    example: RuleExample;
+    message: string;
+}
+export type CandidateCode = 'target-exempt-share' | 'exceptions-no-order' | 'cited-no-order' | 'shared-source';
+export interface OverlapCandidate {
+    code: CandidateCode;
+    rules: string[];
+    file: string;
+    line: number;
+    /** 리뷰어에게 넘길 질문 */
+    question: string;
+    evidence: string[];
+}
+export interface Undecidable {
+    ruleId: string;
+    file: string;
+    line: number;
+    before: number;
+    exempt: number;
+}
+export interface OverlapReport {
+    findings: MatrixFinding[];
+    candidates: OverlapCandidate[];
+    undecidable: Undecidable[];
+}
+/** 룰 표를 가진 문서만 룰북으로 본다. 표 머리가 "| ID | 패턴 |"이다 */
+export declare function hasRuleTable(markdown: string): boolean;
+/** 문장 끝 마침표로 자른다. 괄호 안 마침표나 소수점은 안 자른다 */
+export declare function sentencesOf(text: string): string[];
+/**
+ * 룰북 하나를 룰 단위로 읽는다.
+ *
+ * 룰은 표의 행에만 있지 않다. 행이 길어지면 상세를 표 아래 문단으로 빼서, 겹침 사례의
+ * 절반이 그 문단에서 나왔다(ca3a2dbb의 '원본' 경계). 그래서 룰 하나만 부르는 헤딩 아래
+ * 문단과 볼드 도입구가 룰을 부르는 문단을 그 룰에 붙인다.
+ */
+export declare function parseRuleEntries(markdown: string, file: string): RuleEntry[];
+/**
+ * 탐지기 행렬.
+ *
+ * - 처방(after)이 아무 탐지기에나 걸리면 룰북이 시키는 대로 고친 글이 다시 걸린다 (error)
+ * - 예외로 둔 말을 다른 룰 탐지기가 잡으면 두 룰이 같은 말에 반대로 판정한다.
+ *   둘 사이에 순서를 정한 문장이 없으면 error다
+ * - 형태로 빠진다고 적은 예외를 자기 탐지기가 잡으면 선언과 탐지기가 갈라진 것이다 (error)
+ * - 뜻으로 가르는 예외를 자기 탐지기가 잡는 건 룰북이 "넓게 건다"고 적어둔 룰이 많아 info다
+ * - 금지 예시를 자기 탐지기가 못 잡는 건 룰북이 탐지기 범위를 좁혀 적어둔 자리가 섞여 info다
+ * - 금지 예시가 다른 룰에도 걸리는 건 순서 문장이 없을 때만 보인다 (info)
+ */
+export declare function runMatrix(entries: RuleEntry[], detectors: DetectorSet): MatrixFinding[];
+/** 내용어 낱말. 조사를 떼고 두 글자 이상만 남긴다 */
+export declare function contentWords(text: string): string[];
+export declare function hangulSkeleton(text: string): string;
+/** 영어를 같은 뼈대로. 한국어 음차가 구분하지 않는 자음을 한데 모은다 */
+export declare function latinSkeleton(text: string): string;
+export interface CandidateOptions {
+    /**
+     * 이번 변경에서 새로 생긴 문장. 주면 그 문장이 끼는 후보만 남긴다.
+     * 안 주면 전부 낸다 — 룰북 전체를 훑을 때다.
+     */
+    changed?: ReadonlySet<string>;
+}
+/**
+ * 탐지기로 판정이 안 되는 겹침을 질문으로 뽑는다.
+ *
+ * 판정이 아니다. 같은 낱말이 금지와 예외에 함께 나온다고 다 모순은 아니다 —
+ * "원본"처럼 어느 쪽인지 가르는 문장이 이미 있을 수 있다. 그래서 리뷰어가 읽을
+ * 질문으로만 넘기고 게이트에 걸지 않는다.
+ */
+export declare function findCandidates(entries: RuleEntry[], options?: CandidateOptions): OverlapCandidate[];
+/** 탐지기가 없어 자기 예시를 판정할 수 없는 룰. 건너뛰지 않고 목록으로 드러낸다 */
+export declare function undecidableRules(entries: RuleEntry[], detectors: DetectorSet): Undecidable[];
+/** 이번 변경에서 새로 생긴 문장. 문장 단위로 비교해야 긴 행 한 칸의 수정이 행 전체로 번지지 않는다 */
+export declare function changedSentences(base: RuleEntry[], head: RuleEntry[]): Set<string>;
+export declare function checkOverlap(entries: RuleEntry[], detectors: DetectorSet, options?: CandidateOptions): OverlapReport;
+//# sourceMappingURL=overlap.d.ts.map

package/dist/src/humanize/overlap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"overlap.d.ts","sourceRoot":"","sources":["../../../src/humanize/overlap.ts"],"names":[],"mappings":"AA8BA,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;AAExD,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,2BAA2B;IAC3B,SAAS,EAAE,YAAY,EAAE,CAAC;IAC1B,QAAQ,EAAE,WAAW,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,mBAAmB;IACnB,GAAG,EAAE,SAAS,MAAM,EAAE,CAAC;IACvB,sBAAsB;IACtB,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAC;CACrE;AAED,uDAAuD;AACvD,eAAO,MAAM,cAAc,EAAE,WAG5B,CAAC;AAEF,MAAM,MAAM,WAAW,GACnB,WAAW,GACX,aAAa,GACb,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,kBAAkB,CAAC;AAEvB,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,4CAA4C;IAC5C,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,WAAW,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,aAAa,GACrB,qBAAqB,GACrB,qBAAqB,GACrB,gBAAgB,GAChB,eAAe,CAAC;AAEpB,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,aAAa,CAAC;IACpB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,UAAU,EAAE,gBAAgB,EAAE,CAAC;IAC/B,WAAW,EAAE,WAAW,EAAE,CAAC;CAC5B;AAED,iDAAiD;AACjD,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEtD;AAkED,0CAA0C;AAC1C,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAKlD;AA4ID;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,EAAE,CA0F5E;AAsCD;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,WAAW,GAAG,aAAa,EAAE,CA6FvF;AAKD,kCAAkC;AAClC,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAInD;AAwDD,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQnD;AAED,6CAA6C;AAC7C,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAclD;AAwBD,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;CAC/B;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,OAAO,EAAE,SAAS,EAAE,EACpB,OAAO,GAAE,gBAAqB,GAC7B,gBAAgB,EAAE,CAmGpB;AAYD,mDAAmD;AACnD,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,WAAW,GAAG,WAAW,EAAE,CAW5F;AAED,+DAA+D;AAC/D,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC,CAGlF;AAED,wBAAgB,YAAY,CAC1B,OAAO,EAAE,SAAS,EAAE,EACpB,SAAS,EAAE,WAAW,EACtB,OAAO,GAAE,gBAAqB,GAC7B,aAAa,CAMf"}