specthread 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +139 -0
- package/dist/bin/check.d.ts +1 -0
- package/dist/bin/check.js +67 -0
- package/dist/bin/cli.d.ts +2 -0
- package/dist/bin/cli.js +26 -0
- package/dist/bin/generate.d.ts +1 -0
- package/dist/bin/generate.js +55 -0
- package/dist/checks/changelog.d.ts +8 -0
- package/dist/checks/changelog.js +30 -0
- package/dist/checks/headings.d.ts +3 -0
- package/dist/checks/headings.js +54 -0
- package/dist/checks/links.d.ts +8 -0
- package/dist/checks/links.js +66 -0
- package/dist/checks/markers.d.ts +2 -0
- package/dist/checks/markers.js +60 -0
- package/dist/checks/pending.d.ts +2 -0
- package/dist/checks/pending.js +200 -0
- package/dist/checks/references.d.ts +2 -0
- package/dist/checks/references.js +41 -0
- package/dist/checks/sections.d.ts +3 -0
- package/dist/checks/sections.js +137 -0
- package/dist/checks/style.d.ts +10 -0
- package/dist/checks/style.js +61 -0
- package/dist/checks/timestamps.d.ts +2 -0
- package/dist/checks/timestamps.js +58 -0
- package/dist/checks/toc.d.ts +2 -0
- package/dist/checks/toc.js +41 -0
- package/dist/commands/init.d.ts +1 -0
- package/dist/commands/init.js +115 -0
- package/dist/config-loader.d.ts +2 -0
- package/dist/config-loader.js +106 -0
- package/dist/config.schema.d.ts +96 -0
- package/dist/config.schema.js +27 -0
- package/dist/constants/docs.d.ts +15 -0
- package/dist/constants/docs.js +16 -0
- package/dist/constants/patterns.d.ts +24 -0
- package/dist/constants/patterns.js +24 -0
- package/dist/constants/rules.d.ts +101 -0
- package/dist/constants/rules.js +97 -0
- package/dist/gen/pending-section.d.ts +19 -0
- package/dist/gen/pending-section.js +102 -0
- package/dist/gen/references.d.ts +13 -0
- package/dist/gen/references.js +144 -0
- package/dist/gen/summary.d.ts +27 -0
- package/dist/gen/summary.js +125 -0
- package/dist/gen/toc.d.ts +25 -0
- package/dist/gen/toc.js +66 -0
- package/dist/types.d.ts +125 -0
- package/dist/types.js +1 -0
- package/dist/utils/anchor.d.ts +20 -0
- package/dist/utils/anchor.js +24 -0
- package/dist/utils/ignore.d.ts +11 -0
- package/dist/utils/ignore.js +20 -0
- package/dist/utils/parse.d.ts +50 -0
- package/dist/utils/parse.js +272 -0
- package/dist/utils/report.d.ts +17 -0
- package/dist/utils/report.js +38 -0
- package/dist/utils/resolve.d.ts +21 -0
- package/dist/utils/resolve.js +157 -0
- package/dist/utils/scan.d.ts +11 -0
- package/dist/utils/scan.js +111 -0
- package/dist/utils/scope.d.ts +51 -0
- package/dist/utils/scope.js +55 -0
- package/package.json +29 -0
- package/scaffold/AGENTS.md +67 -0
- package/scaffold/CLAUDE.md +1 -0
- package/scaffold/claude/skills/check.md +43 -0
- package/scaffold/claude/skills/gen.md +41 -0
- package/scaffold/claude/skills/plan-close.md +57 -0
- package/scaffold/claude/skills/plan-open.md +50 -0
- package/scaffold/claude/skills/plan-run.md +51 -0
- package/scaffold/config.jsonc +71 -0
- package/scaffold/pending.md +34 -0
- package/scaffold/project.md +47 -0
- package/scaffold/rules.md +421 -0
- package/scaffold/templates/plan.md +159 -0
- package/scaffold/templates/spec.md +96 -0
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
|
|
2
|
+
import { join, dirname } from "node:path";
|
|
3
|
+
import { fileURLToPath } from "node:url";
|
|
4
|
+
const SPECTHREAD_START = "<!-- specthread:start -->";
|
|
5
|
+
const SPECTHREAD_END = "<!-- specthread:end -->";
|
|
6
|
+
const scaffoldDir = () => {
|
|
7
|
+
const thisFile = dirname(fileURLToPath(import.meta.url));
|
|
8
|
+
const candidates = [
|
|
9
|
+
join(thisFile, "..", "..", "scaffold"),
|
|
10
|
+
join(thisFile, "..", "scaffold"),
|
|
11
|
+
];
|
|
12
|
+
for (const dir of candidates) {
|
|
13
|
+
if (existsSync(dir))
|
|
14
|
+
return dir;
|
|
15
|
+
}
|
|
16
|
+
throw new Error("scaffold 디렉터리를 찾을 수 없다");
|
|
17
|
+
};
|
|
18
|
+
const copyIfMissing = (src, dest) => {
|
|
19
|
+
if (existsSync(dest))
|
|
20
|
+
return false;
|
|
21
|
+
const dir = dirname(dest);
|
|
22
|
+
if (!existsSync(dir))
|
|
23
|
+
mkdirSync(dir, { recursive: true });
|
|
24
|
+
writeFileSync(dest, readFileSync(src, "utf8"), "utf8");
|
|
25
|
+
return true;
|
|
26
|
+
};
|
|
27
|
+
const ensureAgentsMd = (cwd, scaffold) => {
|
|
28
|
+
const dest = join(cwd, "AGENTS.md");
|
|
29
|
+
const src = join(scaffold, "AGENTS.md");
|
|
30
|
+
if (!existsSync(dest)) {
|
|
31
|
+
writeFileSync(dest, readFileSync(src, "utf8"), "utf8");
|
|
32
|
+
console.log(" AGENTS.md 생성");
|
|
33
|
+
return;
|
|
34
|
+
}
|
|
35
|
+
const content = readFileSync(dest, "utf8");
|
|
36
|
+
if (content.includes(SPECTHREAD_START)) {
|
|
37
|
+
const before = content.slice(0, content.indexOf(SPECTHREAD_START));
|
|
38
|
+
const after = content.slice(content.indexOf(SPECTHREAD_END) + SPECTHREAD_END.length);
|
|
39
|
+
const section = readFileSync(src, "utf8");
|
|
40
|
+
writeFileSync(dest, `${before}${SPECTHREAD_START}\n${section}\n${SPECTHREAD_END}${after}`, "utf8");
|
|
41
|
+
console.log(" AGENTS.md specthread 섹션 갱신");
|
|
42
|
+
return;
|
|
43
|
+
}
|
|
44
|
+
const section = readFileSync(src, "utf8");
|
|
45
|
+
writeFileSync(dest, `${content.trimEnd()}\n\n${SPECTHREAD_START}\n${section}\n${SPECTHREAD_END}\n`, "utf8");
|
|
46
|
+
console.log(" AGENTS.md specthread 섹션 삽입");
|
|
47
|
+
};
|
|
48
|
+
const ensureClaudeMd = (cwd) => {
|
|
49
|
+
const dest = join(cwd, "CLAUDE.md");
|
|
50
|
+
if (!existsSync(dest)) {
|
|
51
|
+
writeFileSync(dest, "@AGENTS.md\n", "utf8");
|
|
52
|
+
console.log(" CLAUDE.md 생성");
|
|
53
|
+
return;
|
|
54
|
+
}
|
|
55
|
+
const content = readFileSync(dest, "utf8");
|
|
56
|
+
if (content.includes("@AGENTS.md")) {
|
|
57
|
+
console.log(" CLAUDE.md 이미 @AGENTS.md 참조 포함");
|
|
58
|
+
return;
|
|
59
|
+
}
|
|
60
|
+
writeFileSync(dest, `${content.trimEnd()}\n\n@AGENTS.md\n`, "utf8");
|
|
61
|
+
console.log(" CLAUDE.md @AGENTS.md 추가");
|
|
62
|
+
};
|
|
63
|
+
const parseTools = (args) => {
|
|
64
|
+
const idx = args.indexOf("--tools");
|
|
65
|
+
if (idx === -1 || idx + 1 >= args.length)
|
|
66
|
+
return new Set(["claude"]);
|
|
67
|
+
return new Set(args[idx + 1].split(",").map((t) => t.trim().toLowerCase()));
|
|
68
|
+
};
|
|
69
|
+
export const init = (args) => {
|
|
70
|
+
const cwd = process.cwd();
|
|
71
|
+
const scaffold = scaffoldDir();
|
|
72
|
+
const tools = parseTools(args);
|
|
73
|
+
console.log("specthread init\n");
|
|
74
|
+
const stDir = join(cwd, "specthread");
|
|
75
|
+
if (existsSync(stDir)) {
|
|
76
|
+
console.log(" specthread/ 이미 존재 - 기존 설정 유지");
|
|
77
|
+
}
|
|
78
|
+
else {
|
|
79
|
+
mkdirSync(stDir, { recursive: true });
|
|
80
|
+
console.log(" specthread/ 생성");
|
|
81
|
+
}
|
|
82
|
+
const specthreadFiles = ["config.jsonc", "rules.md", "project.md", "pending.md"];
|
|
83
|
+
for (const file of specthreadFiles) {
|
|
84
|
+
const created = copyIfMissing(join(scaffold, file), join(stDir, file));
|
|
85
|
+
if (created)
|
|
86
|
+
console.log(` specthread/${file} 생성`);
|
|
87
|
+
else
|
|
88
|
+
console.log(` specthread/${file} 이미 존재 - 건너뜀`);
|
|
89
|
+
}
|
|
90
|
+
const templateFiles = ["spec.md", "plan.md"];
|
|
91
|
+
const templatesDir = join(cwd, "docs", "templates");
|
|
92
|
+
for (const file of templateFiles) {
|
|
93
|
+
const created = copyIfMissing(join(scaffold, "templates", file), join(templatesDir, file));
|
|
94
|
+
if (created)
|
|
95
|
+
console.log(` docs/templates/${file} 생성`);
|
|
96
|
+
else
|
|
97
|
+
console.log(` docs/templates/${file} 이미 존재 - 건너뜀`);
|
|
98
|
+
}
|
|
99
|
+
ensureAgentsMd(cwd, scaffold);
|
|
100
|
+
if (tools.has("claude")) {
|
|
101
|
+
ensureClaudeMd(cwd);
|
|
102
|
+
const skillsDir = join(cwd, ".claude", "skills");
|
|
103
|
+
if (!existsSync(skillsDir))
|
|
104
|
+
mkdirSync(skillsDir, { recursive: true });
|
|
105
|
+
const skillFiles = ["check.md", "gen.md", "plan-open.md", "plan-run.md", "plan-close.md"];
|
|
106
|
+
for (const file of skillFiles) {
|
|
107
|
+
const created = copyIfMissing(join(scaffold, "claude", "skills", file), join(skillsDir, file));
|
|
108
|
+
if (created)
|
|
109
|
+
console.log(` .claude/skills/${file} 생성`);
|
|
110
|
+
else
|
|
111
|
+
console.log(` .claude/skills/${file} 이미 존재 - 건너뜀`);
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
console.log("\n완료. npx specthread check 로 문서 정합성을 확인할 수 있다.");
|
|
115
|
+
};
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import { readFileSync, existsSync } from "node:fs";
|
|
2
|
+
import { join } from "node:path";
|
|
3
|
+
import { DEFAULT_CONFIG } from "./config.schema.js";
|
|
4
|
+
import { ALL_RULE_GROUPS } from "./constants/rules.js";
|
|
5
|
+
const CONFIG_FILE = "specthread/config.jsonc";
|
|
6
|
+
const LOCAL_CONFIG_FILE = "specthread/config.local.jsonc";
|
|
7
|
+
// ---------------------------------------------------------------------------
|
|
8
|
+
// JSONC 파싱
|
|
9
|
+
// ---------------------------------------------------------------------------
|
|
10
|
+
const stripJsonComments = (text) => {
|
|
11
|
+
let result = "";
|
|
12
|
+
let i = 0;
|
|
13
|
+
let inString = false;
|
|
14
|
+
let escapeNext = false;
|
|
15
|
+
while (i < text.length) {
|
|
16
|
+
const ch = text[i];
|
|
17
|
+
if (escapeNext) {
|
|
18
|
+
result += ch;
|
|
19
|
+
escapeNext = false;
|
|
20
|
+
i++;
|
|
21
|
+
continue;
|
|
22
|
+
}
|
|
23
|
+
if (inString) {
|
|
24
|
+
if (ch === "\\")
|
|
25
|
+
escapeNext = true;
|
|
26
|
+
if (ch === '"')
|
|
27
|
+
inString = false;
|
|
28
|
+
result += ch;
|
|
29
|
+
i++;
|
|
30
|
+
continue;
|
|
31
|
+
}
|
|
32
|
+
if (ch === "/" && text[i + 1] === "/") {
|
|
33
|
+
while (i < text.length && text[i] !== "\n")
|
|
34
|
+
i++;
|
|
35
|
+
continue;
|
|
36
|
+
}
|
|
37
|
+
if (ch === "/" && text[i + 1] === "*") {
|
|
38
|
+
i += 2;
|
|
39
|
+
while (i < text.length && !(text[i] === "*" && text[i + 1] === "/"))
|
|
40
|
+
i++;
|
|
41
|
+
i += 2;
|
|
42
|
+
continue;
|
|
43
|
+
}
|
|
44
|
+
if (ch === '"')
|
|
45
|
+
inString = true;
|
|
46
|
+
result += ch;
|
|
47
|
+
i++;
|
|
48
|
+
}
|
|
49
|
+
return result;
|
|
50
|
+
};
|
|
51
|
+
const parseJsonc = (text) => JSON.parse(stripJsonComments(text));
|
|
52
|
+
// ---------------------------------------------------------------------------
|
|
53
|
+
// Deep merge — 중첩 객체만 재귀, 배열은 덮어쓰기
|
|
54
|
+
// ---------------------------------------------------------------------------
|
|
55
|
+
const isPlainObject = (v) => v !== null && typeof v === "object" && !Array.isArray(v);
|
|
56
|
+
const deepMerge = (base, override) => {
|
|
57
|
+
const result = { ...base };
|
|
58
|
+
for (const key of Object.keys(override)) {
|
|
59
|
+
const baseVal = result[key];
|
|
60
|
+
const overVal = override[key];
|
|
61
|
+
if (isPlainObject(baseVal) && isPlainObject(overVal)) {
|
|
62
|
+
result[key] = deepMerge(baseVal, overVal);
|
|
63
|
+
}
|
|
64
|
+
else if (overVal !== undefined) {
|
|
65
|
+
result[key] = overVal;
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
return result;
|
|
69
|
+
};
|
|
70
|
+
// ---------------------------------------------------------------------------
|
|
71
|
+
// skipCheck 검증
|
|
72
|
+
// ---------------------------------------------------------------------------
|
|
73
|
+
const ruleGroupSet = new Set(ALL_RULE_GROUPS);
|
|
74
|
+
const validateSkipCheck = (items) => {
|
|
75
|
+
for (const item of items) {
|
|
76
|
+
if (typeof item === "string")
|
|
77
|
+
continue;
|
|
78
|
+
for (const group of item.only) {
|
|
79
|
+
if (!ruleGroupSet.has(group)) {
|
|
80
|
+
console.warn(`[specthread] skipCheck: unknown rule group "${group}" in path "${item.path}". ` +
|
|
81
|
+
`Valid groups: ${ALL_RULE_GROUPS.join(", ")}`);
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
return items;
|
|
86
|
+
};
|
|
87
|
+
// ---------------------------------------------------------------------------
|
|
88
|
+
// Public API
|
|
89
|
+
// ---------------------------------------------------------------------------
|
|
90
|
+
export const loadConfig = (cwd = process.cwd()) => {
|
|
91
|
+
let config = { ...DEFAULT_CONFIG };
|
|
92
|
+
const configPath = join(cwd, CONFIG_FILE);
|
|
93
|
+
if (existsSync(configPath)) {
|
|
94
|
+
const raw = readFileSync(configPath, "utf-8");
|
|
95
|
+
const parsed = parseJsonc(raw);
|
|
96
|
+
config = deepMerge(config, parsed);
|
|
97
|
+
}
|
|
98
|
+
const localPath = join(cwd, LOCAL_CONFIG_FILE);
|
|
99
|
+
if (existsSync(localPath)) {
|
|
100
|
+
const raw = readFileSync(localPath, "utf-8");
|
|
101
|
+
const parsed = parseJsonc(raw);
|
|
102
|
+
config = deepMerge(config, parsed);
|
|
103
|
+
}
|
|
104
|
+
config.skipCheck = validateSkipCheck(config.skipCheck);
|
|
105
|
+
return config;
|
|
106
|
+
};
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* specthread.config.jsonc 스키마.
|
|
3
|
+
*
|
|
4
|
+
* 파싱: strip-json-comments 로 주석 제거 후 JSON.parse().
|
|
5
|
+
*/
|
|
6
|
+
import type { RuleGroup } from "./constants/rules.ts";
|
|
7
|
+
/**
|
|
8
|
+
* 프로젝트 경로. 자유 KV — 키는 용도 라벨, 값은 경로 배열.
|
|
9
|
+
* 디렉터리면 재귀 스캔, 파일이면 직접 로드. 파싱 전략은 확장자로 결정.
|
|
10
|
+
*
|
|
11
|
+
* 예:
|
|
12
|
+
* "docs": ["docs/"] — docs-only 프로젝트
|
|
13
|
+
* "source": ["client/src/"], "data": ["data/"] — 소스+데이터
|
|
14
|
+
* "meta": ["CLAUDE.md", "AGENTS.md"] — 루트의 개별 파일
|
|
15
|
+
*/
|
|
16
|
+
export type PathConfig = Record<string, string[]>;
|
|
17
|
+
/**
|
|
18
|
+
* 기능 단위 on/off. tsconfig 의 strict/noImplicitAny 모델.
|
|
19
|
+
*
|
|
20
|
+
* 28 개 규칙은 독립적이지 않다 (heading 이 깨지면 section-ref 가 깨짐).
|
|
21
|
+
* 개별 레벨이 아닌 기능 플래그로 묶는다.
|
|
22
|
+
*/
|
|
23
|
+
export interface FeaturesConfig {
|
|
24
|
+
/** 마커 체계 전체. false → marker/*, pending/* 검사 + pending 추적 비활성화 */
|
|
25
|
+
markers: boolean;
|
|
26
|
+
/** em dash 검사 + 치환 훅. false → style/em-dash 검사 + hook 비활성화 */
|
|
27
|
+
emDash: boolean;
|
|
28
|
+
/** 참조 절 자동 생성. false → reference/* 검사 + gen references 스킵 */
|
|
29
|
+
references: boolean;
|
|
30
|
+
}
|
|
31
|
+
export interface MarkersConfig {
|
|
32
|
+
/**
|
|
33
|
+
* 마커 종류. "system" 은 코어 예약, 나머지는 프로젝트 정의.
|
|
34
|
+
* 예: ["system", "design", "balance", "deps", "style"]
|
|
35
|
+
*/
|
|
36
|
+
types: string[];
|
|
37
|
+
/**
|
|
38
|
+
* 처리 시점 라벨. 마일스톤 등.
|
|
39
|
+
* 예: ["M1", "M2", "M3"]
|
|
40
|
+
*/
|
|
41
|
+
timepoints: string[];
|
|
42
|
+
}
|
|
43
|
+
export interface FrontmatterSchema {
|
|
44
|
+
required: string[];
|
|
45
|
+
optional: string[];
|
|
46
|
+
}
|
|
47
|
+
export interface DocTypeConfig {
|
|
48
|
+
path: string;
|
|
49
|
+
template: string;
|
|
50
|
+
frontmatter?: FrontmatterSchema;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* skipCheck 항목의 객체 형태.
|
|
54
|
+
* path 에 매칭되는 파일에 대해 only 에 지정한 군만 검사한다.
|
|
55
|
+
*/
|
|
56
|
+
export interface SkipCheckEntry {
|
|
57
|
+
path: string;
|
|
58
|
+
only: RuleGroup[];
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* 현재 한국어 고정. 다국어 필요 시 locale 별 문자열 맵으로 확장.
|
|
62
|
+
*
|
|
63
|
+
* 한국어 의존: TAIL_NAMES, TIMEPOINT 정규식, SENTENCE_END,
|
|
64
|
+
* 출력 메시지, 참조 절 제목, 요약 표 헤더.
|
|
65
|
+
*/
|
|
66
|
+
export type Locale = "ko";
|
|
67
|
+
export interface SpecthreadConfig {
|
|
68
|
+
/** 스캔 대상 경로. 자유 KV */
|
|
69
|
+
path: PathConfig;
|
|
70
|
+
features: FeaturesConfig;
|
|
71
|
+
markers: MarkersConfig;
|
|
72
|
+
docTypes: Record<string, DocTypeConfig>;
|
|
73
|
+
/**
|
|
74
|
+
* 문서명 해소 시 무시할 단어.
|
|
75
|
+
* 예: ["spec"] — "spec §4" 가 template/spec.md 로 잘못 매칭되는 것 방지.
|
|
76
|
+
*/
|
|
77
|
+
ignoreDocNames: string[];
|
|
78
|
+
/**
|
|
79
|
+
* 규칙 검사를 건너뛸 경로.
|
|
80
|
+
* - string: 해당 경로 prefix 의 전체 검사를 건너뛴다
|
|
81
|
+
* - { path, only }: 해당 경로에서 지정한 군만 검사한다
|
|
82
|
+
*/
|
|
83
|
+
skipCheck: (string | SkipCheckEntry)[];
|
|
84
|
+
/** 참조 절 생성을 건너뛸 경로 */
|
|
85
|
+
skipRefs: string[];
|
|
86
|
+
locale: Locale;
|
|
87
|
+
/** 규칙 문서 */
|
|
88
|
+
rules: string;
|
|
89
|
+
/** 미확정 사항 정본 */
|
|
90
|
+
pending: string;
|
|
91
|
+
/** 프로젝트 맥락 문서 */
|
|
92
|
+
project: string;
|
|
93
|
+
/** 초안 문서 폴더 */
|
|
94
|
+
work: string;
|
|
95
|
+
}
|
|
96
|
+
export declare const DEFAULT_CONFIG: SpecthreadConfig;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
// ---------------------------------------------------------------------------
|
|
2
|
+
// 기본값
|
|
3
|
+
// ---------------------------------------------------------------------------
|
|
4
|
+
export const DEFAULT_CONFIG = {
|
|
5
|
+
path: {
|
|
6
|
+
docs: ["docs/"],
|
|
7
|
+
specthread: ["specthread/"],
|
|
8
|
+
},
|
|
9
|
+
features: {
|
|
10
|
+
markers: true,
|
|
11
|
+
emDash: true,
|
|
12
|
+
references: true,
|
|
13
|
+
},
|
|
14
|
+
markers: {
|
|
15
|
+
types: ["system"],
|
|
16
|
+
timepoints: [],
|
|
17
|
+
},
|
|
18
|
+
docTypes: {},
|
|
19
|
+
ignoreDocNames: [],
|
|
20
|
+
skipCheck: [],
|
|
21
|
+
skipRefs: [],
|
|
22
|
+
locale: "ko",
|
|
23
|
+
rules: "specthread/rules.md",
|
|
24
|
+
pending: "specthread/pending.md",
|
|
25
|
+
project: "specthread/project.md",
|
|
26
|
+
work: "docs/work/",
|
|
27
|
+
};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 문서 체계 값 - 여러 곳이 같은 값을 봐야 하는 것들.
|
|
3
|
+
*
|
|
4
|
+
* 두 곳에 같은 값을 두면 한쪽만 고쳤을 때 생성기와 검사기가 어긋난다. `TAIL_NAMES` 가
|
|
5
|
+
* `utils/parse.ts` 와 `checks/headings.ts` 에 각각 있어 실제로 그 상태였다.
|
|
6
|
+
*
|
|
7
|
+
* 규칙 본문은 `docs/system/rules.md` 가 갖는다. 여기는 그 규칙이 쓰는 값만 담는다.
|
|
8
|
+
*/
|
|
9
|
+
/**
|
|
10
|
+
* 꼬리 절 예약어 (`rules.md` §2-5).
|
|
11
|
+
*
|
|
12
|
+
* 파서가 꼬리 절 경계를 잡는 데 쓰고, 검사기가 본문 절이 이 이름을 쓰는지 본다.
|
|
13
|
+
* 순서가 곧 문서 안 등장 순서다.
|
|
14
|
+
*/
|
|
15
|
+
export declare const TAIL_NAMES: readonly ['참조', '미확정 사항', '변경 이력'];
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 문서 체계 값 - 여러 곳이 같은 값을 봐야 하는 것들.
|
|
3
|
+
*
|
|
4
|
+
* 두 곳에 같은 값을 두면 한쪽만 고쳤을 때 생성기와 검사기가 어긋난다. `TAIL_NAMES` 가
|
|
5
|
+
* `utils/parse.ts` 와 `checks/headings.ts` 에 각각 있어 실제로 그 상태였다.
|
|
6
|
+
*
|
|
7
|
+
* 규칙 본문은 `docs/system/rules.md` 가 갖는다. 여기는 그 규칙이 쓰는 값만 담는다.
|
|
8
|
+
*/
|
|
9
|
+
/**
|
|
10
|
+
* 꼬리 절 예약어 (`rules.md` §2-5).
|
|
11
|
+
*
|
|
12
|
+
* 파서가 꼬리 절 경계를 잡는 데 쓰고, 검사기가 본문 절이 이 이름을 쓰는지 본다.
|
|
13
|
+
* 순서가 곧 문서 안 등장 순서다.
|
|
14
|
+
*/
|
|
15
|
+
// locale: ko
|
|
16
|
+
export const TAIL_NAMES = ['참조', '미확정 사항', '변경 이력'];
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 여러 검사가 같은 형식을 봐야 할 때 쓰는 정규식과 문자.
|
|
3
|
+
*
|
|
4
|
+
* 한 형식을 두 검사가 각자 표현하면 하나를 고칠 때 다른 하나가 남는다. 시점 표기가
|
|
5
|
+
* 실제로 그 상태였다 - `checks/timestamps.ts` 는 날짜를 예외로 빼려고, `checks/pending.ts`
|
|
6
|
+
* 는 형식을 검사하려고 같은 것을 따로 적고 있었다.
|
|
7
|
+
*
|
|
8
|
+
* 한 검사만 쓰는 정규식은 그 파일에 둔다. 여기 모으면 어디서 쓰는지 알 수 없어진다.
|
|
9
|
+
*/
|
|
10
|
+
/**
|
|
11
|
+
* em dash. 리터럴로 적으면 치환 훅이 그 파일을 고쳐 검사를 무력화한다.
|
|
12
|
+
*
|
|
13
|
+
* 훅 설정에 기대지 않고 손상을 막으려고 이스케이프로 둔다.
|
|
14
|
+
*/
|
|
15
|
+
export declare const EM_DASH = "\u2014";
|
|
16
|
+
/**
|
|
17
|
+
* 관리 문서 항목의 시점 표기 (`rules.md` §4-2).
|
|
18
|
+
*
|
|
19
|
+
* `작성일 <ISO 날짜>` 에 `/ 해결 예정 <라벨>` 이 붙을 수 있다. 낱말이 두 값을 갈라
|
|
20
|
+
* 말하므로 방향을 나타내는 기호가 필요 없다. `해결 예정` 이 없으면 미정이다.
|
|
21
|
+
*/
|
|
22
|
+
export declare const TIMEPOINT: RegExp;
|
|
23
|
+
/** 전역 플래그가 필요한 자리용. 같은 형식을 두 번 적지 않으려고 여기서 만든다 */
|
|
24
|
+
export declare const timepointGlobal: () => RegExp;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 여러 검사가 같은 형식을 봐야 할 때 쓰는 정규식과 문자.
|
|
3
|
+
*
|
|
4
|
+
* 한 형식을 두 검사가 각자 표현하면 하나를 고칠 때 다른 하나가 남는다. 시점 표기가
|
|
5
|
+
* 실제로 그 상태였다 - `checks/timestamps.ts` 는 날짜를 예외로 빼려고, `checks/pending.ts`
|
|
6
|
+
* 는 형식을 검사하려고 같은 것을 따로 적고 있었다.
|
|
7
|
+
*
|
|
8
|
+
* 한 검사만 쓰는 정규식은 그 파일에 둔다. 여기 모으면 어디서 쓰는지 알 수 없어진다.
|
|
9
|
+
*/
|
|
10
|
+
/**
|
|
11
|
+
* em dash. 리터럴로 적으면 치환 훅이 그 파일을 고쳐 검사를 무력화한다.
|
|
12
|
+
*
|
|
13
|
+
* 훅 설정에 기대지 않고 손상을 막으려고 이스케이프로 둔다.
|
|
14
|
+
*/
|
|
15
|
+
export const EM_DASH = '\u2014';
|
|
16
|
+
/**
|
|
17
|
+
* 관리 문서 항목의 시점 표기 (`rules.md` §4-2).
|
|
18
|
+
*
|
|
19
|
+
* `작성일 <ISO 날짜>` 에 `/ 해결 예정 <라벨>` 이 붙을 수 있다. 낱말이 두 값을 갈라
|
|
20
|
+
* 말하므로 방향을 나타내는 기호가 필요 없다. `해결 예정` 이 없으면 미정이다.
|
|
21
|
+
*/
|
|
22
|
+
export const TIMEPOINT = /작성일\s+(\d{4}-\d{2}-\d{2})(?:\s*\/\s*해결 예정\s+([^\n]+))?/;
|
|
23
|
+
/** 전역 플래그가 필요한 자리용. 같은 형식을 두 번 적지 않으려고 여기서 만든다 */
|
|
24
|
+
export const timepointGlobal = () => new RegExp(TIMEPOINT.source, 'g');
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 검사 규칙 id 의 단일 정의처.
|
|
3
|
+
*
|
|
4
|
+
* 각 검사 파일이 문자열 리터럴을 들고 있으면 오타가 컴파일을 통과하고, 이름을 바꿀 때
|
|
5
|
+
* 파일을 훑어야 하며, 규칙 전체 목록을 얻을 곳이 없다. 여기 모아 `Finding.rule` 을
|
|
6
|
+
* `RuleId` 로 좁히면 오타가 타입 오류가 되고 이 파일이 곧 목록이 된다.
|
|
7
|
+
*
|
|
8
|
+
* id 는 `<군>/<검사>` 형태다. 군 이름은 `checks/<군>.ts` 와 대응하므로 id 를 보면
|
|
9
|
+
* 어느 파일을 열어야 하는지 나온다. 한 파일이 한 군을 갖고, 한 군은 여러 검사를 갖는다 -
|
|
10
|
+
* 같은 파싱을 반복하지 않기 위해서다.
|
|
11
|
+
*
|
|
12
|
+
* 규칙 본문은 `docs/system/rules.md` 가 갖고 각 절이 자기 id 를 병기한다.
|
|
13
|
+
*/
|
|
14
|
+
export declare const RULE: {
|
|
15
|
+
readonly CHANGELOG: {
|
|
16
|
+
/** 변경 이력이 오래된 순이 아니다 */
|
|
17
|
+
readonly ORDER: 'changelog/order';
|
|
18
|
+
};
|
|
19
|
+
readonly HEADING: {
|
|
20
|
+
/** 제목이 둘 이상이다 */
|
|
21
|
+
readonly MULTIPLE_TITLE: 'heading/multiple-title';
|
|
22
|
+
/** 꼬리 절에 번호가 붙었다 */
|
|
23
|
+
readonly NUMBERED_TAIL: 'heading/numbered-tail';
|
|
24
|
+
/** 꼬리 절 예약어를 본문 절이 쓴다 */
|
|
25
|
+
readonly TAIL_NAME_REUSED: 'heading/tail-name-reused';
|
|
26
|
+
};
|
|
27
|
+
readonly LINK: {
|
|
28
|
+
/** 링크 대상 파일이 없다 */
|
|
29
|
+
readonly TARGET: 'link/target';
|
|
30
|
+
/** 링크 대상에 그 앵커가 없다 */
|
|
31
|
+
readonly ANCHOR: 'link/anchor';
|
|
32
|
+
};
|
|
33
|
+
readonly MARKER: {
|
|
34
|
+
/** 마커 slug 가 관리 문서 항목에 없다 */
|
|
35
|
+
readonly ORPHAN: 'marker/orphan';
|
|
36
|
+
/** 관리 문서 항목을 가리키는 마커가 없다 */
|
|
37
|
+
readonly UNMARKED: 'marker/unmarked';
|
|
38
|
+
};
|
|
39
|
+
readonly PENDING: {
|
|
40
|
+
/** 항목 첫 줄에 본문이 이어붙었다 */
|
|
41
|
+
readonly INLINE_BODY: 'pending/inline-body';
|
|
42
|
+
/** 선택지를 한 줄 안에 늘어놓았다 */
|
|
43
|
+
readonly INLINE_OPTIONS: 'pending/inline-options';
|
|
44
|
+
/** 흡수 후 사라지는 작업 문서를 가리킨다 */
|
|
45
|
+
readonly WORK_LINK: 'pending/work-link';
|
|
46
|
+
/** 시점 표기가 형식에 안 맞는다 */
|
|
47
|
+
readonly TIMEPOINT: 'pending/timepoint';
|
|
48
|
+
/** 항목이 `li` 로 적혀 있다. 관리 문서 항목은 헤딩이라 앵커를 갖는다 */
|
|
49
|
+
readonly ITEM_SHAPE: 'pending/item-shape';
|
|
50
|
+
/** 절 머리 요약 표가 없다 */
|
|
51
|
+
readonly SUMMARY_MISSING: 'pending/summary-missing';
|
|
52
|
+
/** 절 머리 요약 표가 항목과 어긋난다 */
|
|
53
|
+
readonly SUMMARY_STALE: 'pending/summary-stale';
|
|
54
|
+
/** 문서의 미확정 사항 절이 관리 문서 백링크와 어긋난다. 절이 없는 문서는 대상 밖 */
|
|
55
|
+
readonly SECTION_STALE: 'pending/section-stale';
|
|
56
|
+
};
|
|
57
|
+
readonly REFERENCE: {
|
|
58
|
+
/** 참조 절이 없다 */
|
|
59
|
+
readonly MISSING: 'reference/missing';
|
|
60
|
+
/** 참조 절이 본문 링크와 어긋난다 */
|
|
61
|
+
readonly STALE: 'reference/stale';
|
|
62
|
+
};
|
|
63
|
+
readonly SECTION_REF: {
|
|
64
|
+
/** 가리킨 절이 대상 문서에 없다 */
|
|
65
|
+
readonly MISSING: 'section-ref/missing';
|
|
66
|
+
/** 절 참조가 링크로 걸려 있지 않다 */
|
|
67
|
+
readonly NOT_LINKED: 'section-ref/not-linked';
|
|
68
|
+
/** 가리킨 문서 이름을 못 찾았다 */
|
|
69
|
+
readonly UNKNOWN_DOC: 'section-ref/unknown-doc';
|
|
70
|
+
/** 같은 이름의 문서가 여럿이라 특정할 수 없다 */
|
|
71
|
+
readonly AMBIGUOUS_DOC: 'section-ref/ambiguous-doc';
|
|
72
|
+
/** 문서명이 없어 대상을 특정할 수 없다 */
|
|
73
|
+
readonly NO_DOC_NAME: 'section-ref/no-doc-name';
|
|
74
|
+
};
|
|
75
|
+
readonly STYLE: {
|
|
76
|
+
/** em dash 를 썼다 */
|
|
77
|
+
readonly EM_DASH: 'style/em-dash';
|
|
78
|
+
/** 코드에 있는 검사 id 가 규칙 문서에 선언되지 않았다 */
|
|
79
|
+
readonly RULE_UNDECLARED: 'style/rule-undeclared';
|
|
80
|
+
};
|
|
81
|
+
readonly TIMESTAMP: {
|
|
82
|
+
/** 본문에 날짜가 있다 */
|
|
83
|
+
readonly BODY_DATE: 'timestamp/body-date';
|
|
84
|
+
};
|
|
85
|
+
readonly TOC: {
|
|
86
|
+
/** 목차가 없다 */
|
|
87
|
+
readonly MISSING: 'toc/missing';
|
|
88
|
+
/** 목차가 헤딩과 어긋난다 */
|
|
89
|
+
readonly STALE: 'toc/stale';
|
|
90
|
+
};
|
|
91
|
+
};
|
|
92
|
+
/** 중첩 구조에서 잎 문자열만 뽑는다 */
|
|
93
|
+
type Leaf<T> = T extends string ? T : Leaf<T[keyof T]>;
|
|
94
|
+
export type RuleId = Leaf<typeof RULE>;
|
|
95
|
+
/** RuleId 에서 슬래시 앞 군 이름만 뽑는다. skipCheck.only 검증에 쓴다 */
|
|
96
|
+
export type RuleGroup = RuleId extends `${infer G}/${string}` ? G : never;
|
|
97
|
+
/** 정의된 모든 id. 규칙 문서와의 대조에 쓴다 */
|
|
98
|
+
export declare const ALL_RULE_IDS: readonly RuleId[];
|
|
99
|
+
/** 정의된 모든 군 이름. skipCheck.only 런타임 검증에 쓴다 */
|
|
100
|
+
export declare const ALL_RULE_GROUPS: readonly RuleGroup[];
|
|
101
|
+
export {};
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 검사 규칙 id 의 단일 정의처.
|
|
3
|
+
*
|
|
4
|
+
* 각 검사 파일이 문자열 리터럴을 들고 있으면 오타가 컴파일을 통과하고, 이름을 바꿀 때
|
|
5
|
+
* 파일을 훑어야 하며, 규칙 전체 목록을 얻을 곳이 없다. 여기 모아 `Finding.rule` 을
|
|
6
|
+
* `RuleId` 로 좁히면 오타가 타입 오류가 되고 이 파일이 곧 목록이 된다.
|
|
7
|
+
*
|
|
8
|
+
* id 는 `<군>/<검사>` 형태다. 군 이름은 `checks/<군>.ts` 와 대응하므로 id 를 보면
|
|
9
|
+
* 어느 파일을 열어야 하는지 나온다. 한 파일이 한 군을 갖고, 한 군은 여러 검사를 갖는다 -
|
|
10
|
+
* 같은 파싱을 반복하지 않기 위해서다.
|
|
11
|
+
*
|
|
12
|
+
* 규칙 본문은 `docs/system/rules.md` 가 갖고 각 절이 자기 id 를 병기한다.
|
|
13
|
+
*/
|
|
14
|
+
export const RULE = {
|
|
15
|
+
CHANGELOG: {
|
|
16
|
+
/** 변경 이력이 오래된 순이 아니다 */
|
|
17
|
+
ORDER: 'changelog/order',
|
|
18
|
+
},
|
|
19
|
+
HEADING: {
|
|
20
|
+
/** 제목이 둘 이상이다 */
|
|
21
|
+
MULTIPLE_TITLE: 'heading/multiple-title',
|
|
22
|
+
/** 꼬리 절에 번호가 붙었다 */
|
|
23
|
+
NUMBERED_TAIL: 'heading/numbered-tail',
|
|
24
|
+
/** 꼬리 절 예약어를 본문 절이 쓴다 */
|
|
25
|
+
TAIL_NAME_REUSED: 'heading/tail-name-reused',
|
|
26
|
+
},
|
|
27
|
+
LINK: {
|
|
28
|
+
/** 링크 대상 파일이 없다 */
|
|
29
|
+
TARGET: 'link/target',
|
|
30
|
+
/** 링크 대상에 그 앵커가 없다 */
|
|
31
|
+
ANCHOR: 'link/anchor',
|
|
32
|
+
},
|
|
33
|
+
MARKER: {
|
|
34
|
+
/** 마커 slug 가 관리 문서 항목에 없다 */
|
|
35
|
+
ORPHAN: 'marker/orphan',
|
|
36
|
+
/** 관리 문서 항목을 가리키는 마커가 없다 */
|
|
37
|
+
UNMARKED: 'marker/unmarked',
|
|
38
|
+
},
|
|
39
|
+
PENDING: {
|
|
40
|
+
/** 항목 첫 줄에 본문이 이어붙었다 */
|
|
41
|
+
INLINE_BODY: 'pending/inline-body',
|
|
42
|
+
/** 선택지를 한 줄 안에 늘어놓았다 */
|
|
43
|
+
INLINE_OPTIONS: 'pending/inline-options',
|
|
44
|
+
/** 흡수 후 사라지는 작업 문서를 가리킨다 */
|
|
45
|
+
WORK_LINK: 'pending/work-link',
|
|
46
|
+
/** 시점 표기가 형식에 안 맞는다 */
|
|
47
|
+
TIMEPOINT: 'pending/timepoint',
|
|
48
|
+
/** 항목이 `li` 로 적혀 있다. 관리 문서 항목은 헤딩이라 앵커를 갖는다 */
|
|
49
|
+
ITEM_SHAPE: 'pending/item-shape',
|
|
50
|
+
/** 절 머리 요약 표가 없다 */
|
|
51
|
+
SUMMARY_MISSING: 'pending/summary-missing',
|
|
52
|
+
/** 절 머리 요약 표가 항목과 어긋난다 */
|
|
53
|
+
SUMMARY_STALE: 'pending/summary-stale',
|
|
54
|
+
/** 문서의 미확정 사항 절이 관리 문서 백링크와 어긋난다. 절이 없는 문서는 대상 밖 */
|
|
55
|
+
SECTION_STALE: 'pending/section-stale',
|
|
56
|
+
},
|
|
57
|
+
REFERENCE: {
|
|
58
|
+
/** 참조 절이 없다 */
|
|
59
|
+
MISSING: 'reference/missing',
|
|
60
|
+
/** 참조 절이 본문 링크와 어긋난다 */
|
|
61
|
+
STALE: 'reference/stale',
|
|
62
|
+
},
|
|
63
|
+
SECTION_REF: {
|
|
64
|
+
/** 가리킨 절이 대상 문서에 없다 */
|
|
65
|
+
MISSING: 'section-ref/missing',
|
|
66
|
+
/** 절 참조가 링크로 걸려 있지 않다 */
|
|
67
|
+
NOT_LINKED: 'section-ref/not-linked',
|
|
68
|
+
/** 가리킨 문서 이름을 못 찾았다 */
|
|
69
|
+
UNKNOWN_DOC: 'section-ref/unknown-doc',
|
|
70
|
+
/** 같은 이름의 문서가 여럿이라 특정할 수 없다 */
|
|
71
|
+
AMBIGUOUS_DOC: 'section-ref/ambiguous-doc',
|
|
72
|
+
/** 문서명이 없어 대상을 특정할 수 없다 */
|
|
73
|
+
NO_DOC_NAME: 'section-ref/no-doc-name',
|
|
74
|
+
},
|
|
75
|
+
STYLE: {
|
|
76
|
+
/** em dash 를 썼다 */
|
|
77
|
+
EM_DASH: 'style/em-dash',
|
|
78
|
+
/** 코드에 있는 검사 id 가 규칙 문서에 선언되지 않았다 */
|
|
79
|
+
RULE_UNDECLARED: 'style/rule-undeclared',
|
|
80
|
+
},
|
|
81
|
+
TIMESTAMP: {
|
|
82
|
+
/** 본문에 날짜가 있다 */
|
|
83
|
+
BODY_DATE: 'timestamp/body-date',
|
|
84
|
+
},
|
|
85
|
+
TOC: {
|
|
86
|
+
/** 목차가 없다 */
|
|
87
|
+
MISSING: 'toc/missing',
|
|
88
|
+
/** 목차가 헤딩과 어긋난다 */
|
|
89
|
+
STALE: 'toc/stale',
|
|
90
|
+
},
|
|
91
|
+
};
|
|
92
|
+
/** 정의된 모든 id. 규칙 문서와의 대조에 쓴다 */
|
|
93
|
+
export const ALL_RULE_IDS = Object.values(RULE).flatMap((group) => Object.values(group));
|
|
94
|
+
/** 정의된 모든 군 이름. skipCheck.only 런타임 검증에 쓴다 */
|
|
95
|
+
export const ALL_RULE_GROUPS = [
|
|
96
|
+
...new Set(ALL_RULE_IDS.map((id) => id.split("/")[0])),
|
|
97
|
+
];
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { DocIndex, IndexedFile } from '../types.ts';
|
|
2
|
+
type Item = {
|
|
3
|
+
slug: string;
|
|
4
|
+
title: string;
|
|
5
|
+
anchor: string;
|
|
6
|
+
};
|
|
7
|
+
/** 대상 문서 경로 → 그 문서를 가리키는 항목 목록 (slug 순) */
|
|
8
|
+
export declare const invertByTarget: (pending: IndexedFile) => Map<string, Item[]>;
|
|
9
|
+
/**
|
|
10
|
+
* 미확정 사항 절 본문. 절 자체가 없는 문서는 빈 배열 - 새로 만들지 않는다.
|
|
11
|
+
*
|
|
12
|
+
* 절은 있는데 가리키는 항목이 0 인 경우도 있다 (전부 해소됐거나 애초에 없음). 그때도
|
|
13
|
+
* _해당 없음_ 을 명시해 빈 채로 방치하지 않는다 - 빈 결과와 stale 결과를 구분 못 하면
|
|
14
|
+
* 검사가 항상 통과해 버린다.
|
|
15
|
+
*/
|
|
16
|
+
export declare const pendingSectionBlock: (file: IndexedFile, byTarget: Map<string, Item[]>, index: DocIndex) => string[];
|
|
17
|
+
/** 미확정 사항 절을 채운 문서 줄 목록. 바꿀 것이 없으면 null */
|
|
18
|
+
export declare const applyPendingSection: (file: IndexedFile, lines: string[], index: DocIndex) => string[] | null;
|
|
19
|
+
export {};
|