hanlint 0.0.12 → 0.0.13

package/README.md

@@ -14,6 +14,7 @@
 npx hanlint 글.md
 npx hanlint docs/ --preset docs
 npx hanlint 글.md --format json
+npx hanlint sheet src/ --preset screen
 ```
 
 인자 없이 실행하면 현재 폴더의 파일을 바탕으로 시작 안내를 보여 준다.

package/data/version.json

@@ -1 +1 @@
-{"version": "0.0.12"}
+{"version": "0.0.13"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hanlint",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "description": "한국어 글 검사기. Korean prose linter for Markdown: translationese, noun piles, double passives, weak structure. Zero dependencies",
   "type": "module",
   "bin": {

package/src/cli/help.js

@@ -23,6 +23,7 @@ export function rootHelp() {
   hanlint spec --preset <종류> --chars 800
                                          쓰기 전 숫자 사양을 만든다
   hanlint primer --preset <종류>         쓰기 전에 규칙의 고치는 법과 본보기를 한 장으로 본다
+  hanlint sheet src/ --preset screen    소스의 화면 글을 표 하나로 떨군다. 고친 표는 sheet apply 로 되돌려 쓴다
 
 추가 명령
   baseline, print

package/src/cli/main.js

@@ -46,7 +46,9 @@ import { exemplarFor } from "../data/exemplars.js";
 import { patterns, patternsAvoiding } from "../data/patterns.js";
 import { HAPNIDA, REGISTERS } from "../analysis/grammar/index.js";
 import { CATEGORY_TITLES, MECHANISMS, ruleCategory, ruleFix, ruleMechanism, runAll } from "../rules/registry.js";
-import { MARKDOWN, SKIPPED_FOLDERS, markdownUnder } from "./walk.js";
+import { MARKDOWN, SKIPPED_FOLDERS, isSkipped, markdownUnder } from "./walk.js";
+import { SOURCE_SUFFIXES, replaceLiteral, sourceLiterals } from "../document/sourceText.js";
+import { parseSheet, renderSheet, renderSheetJson } from "../report/sheet.js";
 import { welcome } from "./welcome.js";
 import { rootHelp } from "./help.js";
 import { renderCompact } from "../report/compactReport.js";
@@ -57,7 +59,7 @@ import { renderText } from "../report/textReport.js";
 import { renderWritingSpec, writingSpec } from "../report/writingSpec.js";
 import { exemplarInRegister, patternInRegister } from "../report/registerMatch.js";
 
-const COMMANDS = ["lint", "fix", "print", "rules", "explain", "patterns", "primer", "spec", "hook", "baseline", "doctor", "init", "contract", "check", "verify-patch"];
+const COMMANDS = ["lint", "fix", "print", "rules", "explain", "patterns", "primer", "spec", "hook", "baseline", "doctor", "init", "contract", "check", "verify-patch", "sheet"];
 const PYTHON_ONLY = [
   "audit",
   "map",
@@ -130,6 +132,7 @@ const OPTION_KINDS = {
   "--chars": "value",
   "--baseline": "optional",
   "--prune": "flag",
+  "--all": "flag",
 };
 
 class UsageError extends Error {}
@@ -982,6 +985,106 @@ function runInit(args) {
   return 0;
 }
 
+/** 폴더 아래 소스 파일. 뜻은 파이썬 cli/commands/sheet.py 의 sourceUnder 가 소유한다. @param {string} folder @returns {string[]} */
+function sourceUnder(folder) {
+  /** @type {string[]} */
+  const found = [];
+  for (const name of readdirSync(folder).sort()) {
+    const path = join(folder, name);
+    if (statSync(path).isDirectory()) {
+      if (!isSkipped(name)) found.push(...sourceUnder(path));
+    } else if (SOURCE_SUFFIXES.includes(extname(name).toLowerCase())) found.push(path);
+  }
+  return found.sort();
+}
+
+/** 작업 폴더 기준 상대 경로, 구분자는 `/`. 파이썬 relativeLabel 과 같은 글자를 낸다. @param {string} path */
+function relativeLabel(path) {
+  const rel = relative(process.cwd(), resolve(path));
+  const label = !rel || rel.startsWith("..") || isAbsolute(rel) ? path : rel;
+  return label.split(sep).join("/").replaceAll("\\", "/");
+}
+
+/** 표의 고침을 파일에 쓴다. 뜻은 파이썬 applySheet 가 소유한다. @param {string} sheetPath @param {boolean} dryRun @returns {[string[], string[]]} */
+function applySheet(sheetPath, dryRun) {
+  const parsed = parseSheet(readFileSync(sheetPath, "utf-8"));
+  /** @type {string[]} */
+  const applied = [];
+  const failed = [...parsed.problems];
+  /** @type {Map<string, import("../report/sheet.js").SheetRow[]>} */
+  const byFile = new Map();
+  for (const row of parsed.rows) {
+    if (!byFile.has(row.file)) byFile.set(row.file, []);
+    /** @type {import("../report/sheet.js").SheetRow[]} */ (byFile.get(row.file)).push(row);
+  }
+  for (const file of [...byFile.keys()].sort()) {
+    const rows = /** @type {import("../report/sheet.js").SheetRow[]} */ (byFile.get(file));
+    if (!existsSync(file)) {
+      failed.push(...rows.map((row) => `${row.file}:${row.line}: 파일이 없다`));
+      continue;
+    }
+    const lines = readFileSync(file, "utf-8").split("\n");
+    let changed = false;
+    for (const row of rows) {
+      const place = `${row.file}:${row.line}`;
+      if (row.line < 1 || row.line > lines.length) {
+        failed.push(`${place}: 그 줄이 없다`);
+        continue;
+      }
+      const [newLine, count] = replaceLiteral(lines[row.line - 1], row.text, row.fix);
+      if (count !== 1) {
+        failed.push(`${place}: 글이 그 줄에 ${count}번 있다. 한 번이어야 바꾼다`);
+        continue;
+      }
+      lines[row.line - 1] = newLine;
+      changed = true;
+      applied.push(`${place}: ${row.text} -> ${row.fix}`);
+    }
+    if (changed && !dryRun) writeFileSync(file, lines.join("\n"), "utf-8");
+  }
+  return [applied, failed];
+}
+
+/** `hanlint sheet 폴더/ --preset screen` 과 `hanlint sheet apply 시트.md`. 뜻은 파이썬 cli/commands/sheet.py 가 소유한다. @param {string[]} args */
+function runSheet(args) {
+  const { options, positionals } = parseArgs(args);
+  const output = /** @type {string | undefined} */ (options["--output"]);
+  if (!positionals.length) throw new UsageError("hanlint sheet 폴더/ 또는 hanlint sheet apply 시트.md");
+  if (positionals[0] === "apply") {
+    if (positionals.length !== 2) {
+      emit("hanlint sheet apply 시트.md 꼴로 시트 하나를 준다", output);
+      return 2;
+    }
+    const dryRun = Boolean(options["--dry-run"]);
+    const [applied, failed] = applySheet(positionals[1], dryRun);
+    const lines = [`${dryRun ? "볼 것" : "적용"} ${applied.length}건, 실패 ${failed.length}건`];
+    lines.push(...applied.map((item) => `  ${item}`));
+    lines.push(...failed.map((item) => `  실패 ${item}`));
+    emit(lines.join("\n"), output);
+    return failed.length ? 1 : 0;
+  }
+  /** @type {string[]} */
+  const files = [];
+  for (const target of positionals) {
+    if (!existsSync(target)) throw new Error(`${target} 이 없다`);
+    if (statSync(target).isDirectory()) files.push(...sourceUnder(target));
+    else files.push(target);
+  }
+  const config = configFrom(options, files);
+  const format = choose(/** @type {string} */ (options["--format"] ?? "markdown"), ["markdown", "json"], "--format");
+  /** @type {import("../report/sheet.js").SheetRow[]} */
+  const rows = [];
+  for (const file of files) {
+    const label = relativeLabel(file);
+    for (const literal of sourceLiterals(readFileSync(file, "utf-8"), label)) {
+      const findings = runAll(fingerprint(literal.plain, config), config).filter((finding) => finding.severity === "error");
+      if (findings.length || options["--all"]) rows.push({ file: label, line: literal.line, text: literal.text, findings, fix: "" });
+    }
+  }
+  emit(format === "json" ? renderSheetJson(rows, config.preset, files.length) : renderSheet(rows, config.preset, files.length), output);
+  return 0;
+}
+
 /** @param {string[]} argv */
 function dispatch(argv) {
   if (!argv.length) {
@@ -1014,6 +1117,7 @@ function dispatch(argv) {
   if (command === "hook") return runHook(rest);
   if (command === "baseline") return runBaseline(rest);
   if (command === "doctor") return runDoctor(rest);
+  if (command === "sheet") return runSheet(rest);
   return runInit(rest);
 }
 

package/src/document/sourceText.js

@@ -0,0 +1,143 @@
+// @ts-check
+/**
+ * 소스 파일의 글 마디. 사람이 읽는 한국어 문자열 리터럴과 JSX 글을 줄 번호와 함께 뽑는다.
+ * 뜻과 규칙은 파이썬 document/sourceText.py 가 소유한다. 여기는 같은 값을 낸다.
+ */
+
+export const SOURCE_SUFFIXES = [".js", ".jsx", ".mjs", ".cjs", ".ts", ".tsx", ".rs", ".py"];
+
+const KOREAN = /[가-힣]/;
+// 문자열의 경계. 줄을 앞에서부터 훑어 여는 따옴표에서 같은 닫는 따옴표까지를 한 마디로 본다. 파이썬 sourceText.py 와 같다.
+const QUOTES = ["'", '"', "`"];
+const EXPRESSION = /\{[^{}]*\}/g;
+const BLOCK_COMMENT = /\/\*[\s\S]*?\*\//g;
+const DEVELOPER_LINE = /new Error\(|console\.|panic!\(|expect\(|assert/;
+const RUST_CONTINUATION = /\\\r?\n[ \t]*/g;
+const RUST_TEST_MARKER = "#[cfg(test)]";
+
+/**
+ * @typedef {object} SourceLiteral
+ * @property {number} line 1부터 세는 줄 번호. 여러 줄을 이은 러스트 문자열은 시작 줄이다
+ * @property {string} text 따옴표와 태그를 뺀 글. 파일에 있는 그대로라 되돌려 쓸 때 찾을 수 있다
+ * @property {string} plain 검사에 쓰는 글. 식 (`${...}`, `{...}`) 을 비우고 공백을 하나로 모았다
+ */
+
+/** 템플릿 리터럴의 `${ ... }` 식을 (중첩 괄호를 세어) 같은 길이의 빈칸으로 바꾼다. @param {string} source */
+export function withoutTemplateExpressions(source) {
+  let output = "";
+  let index = 0;
+  while (index < source.length) {
+    if (source[index] === "$" && source[index + 1] === "{") {
+      let depth = 0;
+      let cursor = index + 1;
+      for (; cursor < source.length; cursor++) {
+        if (source[cursor] === "{") depth += 1;
+        else if (source[cursor] === "}") {
+          depth -= 1;
+          if (depth === 0) break;
+        }
+      }
+      output += " ".repeat(cursor + 1 - index);
+      index = cursor + 1;
+      continue;
+    }
+    output += source[index];
+    index += 1;
+  }
+  return output;
+}
+
+/** 주석과 개발자용 줄을 걷어낸 소스. 줄 번호는 유지한다. @param {string} source @param {string} path */
+export function userFacingSource(source, path) {
+  const isRust = path.endsWith(".rs");
+  let body = source;
+  if (isRust && body.includes(RUST_TEST_MARKER)) body = body.slice(0, body.indexOf(RUST_TEST_MARKER));
+  if (isRust) body = body.replace(RUST_CONTINUATION, "");
+  body = body.replace(BLOCK_COMMENT, (block) => block.replace(/[^\n]/g, " "));
+  return body
+    .split("\n")
+    .map((line) => {
+      const trimmed = line.trim();
+      if (trimmed.startsWith("//") || trimmed.startsWith("*") || trimmed.startsWith("#")) return "";
+      if (DEVELOPER_LINE.test(line)) return "";
+      return line.replace(/\/\/.*$/, "");
+    })
+    .join("\n");
+}
+
+/** 검사에 쓰는 글. 식을 비우고 공백을 하나로 모은다. @param {string} text */
+export function plainText(text) {
+  let copy = withoutTemplateExpressions(text);
+  while (EXPRESSION.test(copy)) copy = copy.replace(EXPRESSION, " ");
+  return copy.replace(/\s+/g, " ").trim();
+}
+
+/** `start` 의 따옴표를 닫는 자리. 역슬래시 뒤 글자는 건너뛴다. 없으면 -1. @param {string} line @param {number} start */
+function closingQuote(line, start) {
+  const quote = line[start];
+  let index = start + 1;
+  while (index < line.length) {
+    const char = line[index];
+    if (char === "\\") {
+      index += 2;
+      continue;
+    }
+    if (char === quote) return index;
+    index += 1;
+  }
+  return -1;
+}
+
+/** 한 줄의 글 마디를 나온 차례로. 뜻은 파이썬 lineLiterals 가 소유한다. @param {string} line @returns {string[]} */
+export function lineLiterals(line) {
+  /** @type {string[]} */
+  const found = [];
+  let index = 0;
+  while (index < line.length) {
+    const char = line[index];
+    if (QUOTES.includes(char)) {
+      const end = closingQuote(line, index);
+      if (end < 0) break;
+      found.push(line.slice(index + 1, end));
+      index = end + 1;
+      continue;
+    }
+    if (char === ">" && (index === 0 || !"=-".includes(line[index - 1]))) {
+      const end = line.indexOf("<", index + 1);
+      if (end > index) {
+        const inner = line.slice(index + 1, end);
+        found.push(inner);
+        if (!inner.includes("{")) {
+          index = end;
+          continue;
+        }
+      }
+    }
+    index += 1;
+  }
+  return found;
+}
+
+/** 소스에서 글 마디를 줄 번호 순으로. @param {string} source @param {string} [path] @returns {SourceLiteral[]} */
+export function sourceLiterals(source, path = "") {
+  /** @type {SourceLiteral[]} */
+  const found = [];
+  userFacingSource(source, path).split("\n").forEach((line, index) => {
+    for (const raw of lineLiterals(line)) {
+      const text = raw.trim();
+      const plain = plainText(text);
+      if (text && KOREAN.test(plain)) found.push({ line: index + 1, text, plain });
+    }
+  });
+  return found;
+}
+
+/**
+ * 한 줄 안에서 글 `old` 를 `new` 로 바꾼다. 몇 번 나왔는지 같이 준다 (한 번일 때만 바꾼 것이 확정이다).
+ * @param {string} lineText @param {string} oldText @param {string} newText @returns {[string, number]}
+ */
+export function replaceLiteral(lineText, oldText, newText) {
+  const count = lineText.split(oldText).length - 1;
+  if (count !== 1) return [lineText, count];
+  return [lineText.replace(oldText, () => newText), 1];
+}

package/src/index.js

@@ -25,6 +25,8 @@ import {
 import { configFromMapping, defaultConfig } from "./config/settings.js";
 import { loadVersion } from "./data/load.js";
 import { parseMarkdown } from "./document/parseMarkdown.js";
+import { SOURCE_SUFFIXES, replaceLiteral, sourceLiterals } from "./document/sourceText.js";
+import { parseSheet, renderSheet, renderSheetJson } from "./report/sheet.js";
 import { headingsOf } from "./document/model.js";
 import { applyFixes } from "./edit/applyFixes.js";
 import { buildFingerprint } from "./fingerprint/build.js";
@@ -48,6 +50,12 @@ export function loadConfig(path = null, start = null) {
 
 export {
   CheckResult,
+  SOURCE_SUFFIXES,
+  parseSheet,
+  renderSheet,
+  renderSheetJson,
+  replaceLiteral,
+  sourceLiterals,
   CONTRACT_VERSION,
   CONTRACT_VERSIONS,
   Contract,