chaffjs 0.0.1

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.
Files changed (182) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +76 -0
  3. package/bin/chaff.js +4 -0
  4. package/dist/adapter-load.d.ts +9 -0
  5. package/dist/adapter-load.d.ts.map +1 -0
  6. package/dist/adapter-load.js +38 -0
  7. package/dist/adapter-load.js.map +1 -0
  8. package/dist/baseline.d.ts +23 -0
  9. package/dist/baseline.d.ts.map +1 -0
  10. package/dist/baseline.js +41 -0
  11. package/dist/baseline.js.map +1 -0
  12. package/dist/cli.d.ts +2 -0
  13. package/dist/cli.d.ts.map +1 -0
  14. package/dist/cli.js +234 -0
  15. package/dist/cli.js.map +1 -0
  16. package/dist/config/load.d.ts +13 -0
  17. package/dist/config/load.d.ts.map +1 -0
  18. package/dist/config/load.js +26 -0
  19. package/dist/config/load.js.map +1 -0
  20. package/dist/config/write.d.ts +12 -0
  21. package/dist/config/write.d.ts.map +1 -0
  22. package/dist/config/write.js +60 -0
  23. package/dist/config/write.js.map +1 -0
  24. package/dist/detect-language.d.ts +3 -0
  25. package/dist/detect-language.d.ts.map +1 -0
  26. package/dist/detect-language.js +26 -0
  27. package/dist/detect-language.js.map +1 -0
  28. package/dist/detect.d.ts +7 -0
  29. package/dist/detect.d.ts.map +1 -0
  30. package/dist/detect.js +13 -0
  31. package/dist/detect.js.map +1 -0
  32. package/dist/detectors/count-per-section.d.ts +4 -0
  33. package/dist/detectors/count-per-section.d.ts.map +1 -0
  34. package/dist/detectors/count-per-section.js +13 -0
  35. package/dist/detectors/count-per-section.js.map +1 -0
  36. package/dist/detectors/heading-echo.d.ts +3 -0
  37. package/dist/detectors/heading-echo.d.ts.map +1 -0
  38. package/dist/detectors/heading-echo.js +36 -0
  39. package/dist/detectors/heading-echo.js.map +1 -0
  40. package/dist/detectors/index.d.ts +4 -0
  41. package/dist/detectors/index.d.ts.map +1 -0
  42. package/dist/detectors/index.js +16 -0
  43. package/dist/detectors/index.js.map +1 -0
  44. package/dist/detectors/phrase-match.d.ts +7 -0
  45. package/dist/detectors/phrase-match.d.ts.map +1 -0
  46. package/dist/detectors/phrase-match.js +38 -0
  47. package/dist/detectors/phrase-match.js.map +1 -0
  48. package/dist/detectors/repeated-head.d.ts +3 -0
  49. package/dist/detectors/repeated-head.d.ts.map +1 -0
  50. package/dist/detectors/repeated-head.js +21 -0
  51. package/dist/detectors/repeated-head.js.map +1 -0
  52. package/dist/detectors/sentence-length.d.ts +3 -0
  53. package/dist/detectors/sentence-length.d.ts.map +1 -0
  54. package/dist/detectors/sentence-length.js +19 -0
  55. package/dist/detectors/sentence-length.js.map +1 -0
  56. package/dist/detectors/sentence-rhythm.d.ts +3 -0
  57. package/dist/detectors/sentence-rhythm.d.ts.map +1 -0
  58. package/dist/detectors/sentence-rhythm.js +28 -0
  59. package/dist/detectors/sentence-rhythm.js.map +1 -0
  60. package/dist/document.d.ts +3 -0
  61. package/dist/document.d.ts.map +1 -0
  62. package/dist/document.js +138 -0
  63. package/dist/document.js.map +1 -0
  64. package/dist/files.d.ts +12 -0
  65. package/dist/files.d.ts.map +1 -0
  66. package/dist/files.js +30 -0
  67. package/dist/files.js.map +1 -0
  68. package/dist/genre.d.ts +8 -0
  69. package/dist/genre.d.ts.map +1 -0
  70. package/dist/genre.js +35 -0
  71. package/dist/genre.js.map +1 -0
  72. package/dist/index.d.ts +5 -0
  73. package/dist/index.d.ts.map +1 -0
  74. package/dist/index.js +3 -0
  75. package/dist/index.js.map +1 -0
  76. package/dist/init.d.ts +3 -0
  77. package/dist/init.d.ts.map +1 -0
  78. package/dist/init.js +71 -0
  79. package/dist/init.js.map +1 -0
  80. package/dist/levels.d.ts +20 -0
  81. package/dist/levels.d.ts.map +1 -0
  82. package/dist/levels.js +24 -0
  83. package/dist/levels.js.map +1 -0
  84. package/dist/mask.d.ts +3 -0
  85. package/dist/mask.d.ts.map +1 -0
  86. package/dist/mask.js +26 -0
  87. package/dist/mask.js.map +1 -0
  88. package/dist/plugin.d.ts +116 -0
  89. package/dist/plugin.d.ts.map +1 -0
  90. package/dist/plugin.js +4 -0
  91. package/dist/plugin.js.map +1 -0
  92. package/dist/position.d.ts +8 -0
  93. package/dist/position.d.ts.map +1 -0
  94. package/dist/position.js +7 -0
  95. package/dist/position.js.map +1 -0
  96. package/dist/render/compact.d.ts +5 -0
  97. package/dist/render/compact.d.ts.map +1 -0
  98. package/dist/render/compact.js +15 -0
  99. package/dist/render/compact.js.map +1 -0
  100. package/dist/render/explain.d.ts +4 -0
  101. package/dist/render/explain.d.ts.map +1 -0
  102. package/dist/render/explain.js +29 -0
  103. package/dist/render/explain.js.map +1 -0
  104. package/dist/render/friendly.d.ts +4 -0
  105. package/dist/render/friendly.d.ts.map +1 -0
  106. package/dist/render/friendly.js +55 -0
  107. package/dist/render/friendly.js.map +1 -0
  108. package/dist/render/rules-json.d.ts +6 -0
  109. package/dist/render/rules-json.d.ts.map +1 -0
  110. package/dist/render/rules-json.js +39 -0
  111. package/dist/render/rules-json.js.map +1 -0
  112. package/dist/render/summary.d.ts +10 -0
  113. package/dist/render/summary.d.ts.map +1 -0
  114. package/dist/render/summary.js +18 -0
  115. package/dist/render/summary.js.map +1 -0
  116. package/dist/render/suppressions.d.ts +13 -0
  117. package/dist/render/suppressions.d.ts.map +1 -0
  118. package/dist/render/suppressions.js +50 -0
  119. package/dist/render/suppressions.js.map +1 -0
  120. package/dist/render/text.d.ts +6 -0
  121. package/dist/render/text.d.ts.map +1 -0
  122. package/dist/render/text.js +8 -0
  123. package/dist/render/text.js.map +1 -0
  124. package/dist/rule-load.d.ts +3 -0
  125. package/dist/rule-load.d.ts.map +1 -0
  126. package/dist/rule-load.js +68 -0
  127. package/dist/rule-load.js.map +1 -0
  128. package/dist/run.d.ts +14 -0
  129. package/dist/run.d.ts.map +1 -0
  130. package/dist/run.js +47 -0
  131. package/dist/run.js.map +1 -0
  132. package/dist/stet.d.ts +19 -0
  133. package/dist/stet.d.ts.map +1 -0
  134. package/dist/stet.js +61 -0
  135. package/dist/stet.js.map +1 -0
  136. package/dist/watch.d.ts +12 -0
  137. package/dist/watch.d.ts.map +1 -0
  138. package/dist/watch.js +40 -0
  139. package/dist/watch.js.map +1 -0
  140. package/package.json +63 -0
  141. package/rules/bold-density.yaml +28 -0
  142. package/rules/closing-cliche.yaml +30 -0
  143. package/rules/empty-intensifier.yaml +29 -0
  144. package/rules/heading-echo.yaml +30 -0
  145. package/rules/max-sentence-length.yaml +28 -0
  146. package/rules/padded-intro.yaml +30 -0
  147. package/rules/repeated-sentence-head.yaml +28 -0
  148. package/rules/sentence-rhythm.yaml +30 -0
  149. package/src/adapter-load.ts +31 -0
  150. package/src/baseline.ts +51 -0
  151. package/src/cli.ts +259 -0
  152. package/src/config/load.ts +38 -0
  153. package/src/config/write.ts +63 -0
  154. package/src/detect-language.ts +28 -0
  155. package/src/detect.ts +15 -0
  156. package/src/detectors/count-per-section.ts +15 -0
  157. package/src/detectors/heading-echo.ts +40 -0
  158. package/src/detectors/index.ts +17 -0
  159. package/src/detectors/phrase-match.ts +41 -0
  160. package/src/detectors/repeated-head.ts +29 -0
  161. package/src/detectors/sentence-length.ts +21 -0
  162. package/src/detectors/sentence-rhythm.ts +28 -0
  163. package/src/document.ts +154 -0
  164. package/src/files.ts +34 -0
  165. package/src/genre.ts +36 -0
  166. package/src/index.ts +4 -0
  167. package/src/init.ts +76 -0
  168. package/src/levels.ts +27 -0
  169. package/src/mask.ts +33 -0
  170. package/src/plugin.ts +124 -0
  171. package/src/position.ts +9 -0
  172. package/src/render/compact.ts +18 -0
  173. package/src/render/explain.ts +31 -0
  174. package/src/render/friendly.ts +62 -0
  175. package/src/render/rules-json.ts +46 -0
  176. package/src/render/summary.ts +22 -0
  177. package/src/render/suppressions.ts +57 -0
  178. package/src/render/text.ts +13 -0
  179. package/src/rule-load.ts +78 -0
  180. package/src/run.ts +61 -0
  181. package/src/stet.ts +79 -0
  182. package/src/watch.ts +52 -0
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rules-json.d.ts","sourceRoot":"","sources":["../../src/render/rules-json.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAY1D,0DAA0D;AAC1D,eAAO,MAAM,SAAS,GAAI,OAAO,SAAS,cAAc,EAAE,EAAE,QAAQ,MAAM,EAAE,UAAU,MAAM,EAAE,OAAO,MAAM,KAAG,MA4B3G,CAAC;AAEJ,eAAO,MAAM,YAAY,QAAO,SAAS,KAAK,EAA4C,CAAC"}
@@ -0,0 +1,39 @@
1
+ import { definedLevels, resolve } from "../levels.js";
2
+ const now = (rule, config) => {
3
+ const explicit = config.rules[rule.id];
4
+ if (explicit === "off")
5
+ return { level: "off", why_off: "設定で止めている" };
6
+ if (explicit !== undefined)
7
+ return { level: explicit, limit: resolve(rule, explicit).limit };
8
+ if (rule.status === "experimental" && !config.experimental) {
9
+ return { level: "off", why_off: "experimental な rule は既定で動かさない", turn_on_with: `npx chaff lint --experimental` };
10
+ }
11
+ return { level: "normal", limit: resolve(rule, "normal").limit };
12
+ };
13
+ /** AI に設定を書かせるときの入口。推測せずに書けるだけの情報を 1 つに入れる。spec §19.3。 */
14
+ export const rulesJson = (rules, config, language, genre) => JSON.stringify({
15
+ schema_version: 1,
16
+ config_file: "chaff.yaml",
17
+ detected: { genre, language },
18
+ values_you_can_use: ["strict", "normal", "relaxed", "off"],
19
+ values_note: "この 4 語のかわりに数字を直接書いてもよい。4 語のほうを勧める。",
20
+ rules: rules.map((rule) => ({
21
+ id: rule.id,
22
+ layer: rule.layer,
23
+ status: rule.status,
24
+ name: rule.name,
25
+ why: rule.why,
26
+ how_to_fix: rule.how_to_fix,
27
+ use_for: rule.use_for,
28
+ levels: rule.levels,
29
+ levels_you_can_set: definedLevels(rule),
30
+ your_setting: config.rules[rule.id] === undefined ? null : { level: config.rules[rule.id], from: config.path },
31
+ now: now(rule, config),
32
+ })),
33
+ how_to_change: {
34
+ by_command: ['npx chaff relax <rule-id> --why "<理由>"', 'npx chaff strict <rule-id> --why "<理由>"', 'npx chaff off <rule-id> --why "<理由>"'],
35
+ by_file: "chaff.yaml の rules に <rule-id>: <level> を足す。既定のままのものは書かない。",
36
+ },
37
+ }, null, 2);
38
+ export const levelsForCli = () => ["strict", "normal", "relaxed", "off"];
39
+ //# sourceMappingURL=rules-json.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rules-json.js","sourceRoot":"","sources":["../../src/render/rules-json.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAItD,MAAM,GAAG,GAAG,CAAC,IAAoB,EAAE,MAAc,EAA2B,EAAE;IAC5E,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACvC,IAAI,QAAQ,KAAK,KAAK;QAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;IACrE,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;IAC7F,IAAI,IAAI,CAAC,MAAM,KAAK,cAAc,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;QAC3D,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,+BAA+B,EAAE,YAAY,EAAE,+BAA+B,EAAE,CAAC;IACnH,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;AACnE,CAAC,CAAC;AAEF,0DAA0D;AAC1D,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAgC,EAAE,MAAc,EAAE,QAAgB,EAAE,KAAa,EAAU,EAAE,CACrH,IAAI,CAAC,SAAS,CACZ;IACE,cAAc,EAAE,CAAC;IACjB,WAAW,EAAE,YAAY;IACzB,QAAQ,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE;IAC7B,kBAAkB,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,CAAC;IAC1D,WAAW,EAAE,oCAAoC;IACjD,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC1B,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,kBAAkB,EAAE,aAAa,CAAC,IAAI,CAAC;QACvC,YAAY,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE;QAC9G,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC;KACvB,CAAC,CAAC;IACH,aAAa,EAAE;QACb,UAAU,EAAE,CAAC,wCAAwC,EAAE,yCAAyC,EAAE,sCAAsC,CAAC;QACzI,OAAO,EAAE,4DAA4D;KACtE;CACF,EACD,IAAI,EACJ,CAAC,CACF,CAAC;AAEJ,MAAM,CAAC,MAAM,YAAY,GAAG,GAAqB,EAAE,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC"}
@@ -0,0 +1,10 @@
1
+ import type { Finding } from "../plugin.ts";
2
+ export type FileOutcome = {
3
+ readonly path: string;
4
+ readonly findings: readonly Finding[];
5
+ readonly notRun: number;
6
+ };
7
+ export declare const tally: (findings: readonly Finding[]) => string;
8
+ /** 複数ファイルを見たときの締め。1 ファイルのときは出さない。 */
9
+ export declare const renderSummary: (outcomes: readonly FileOutcome[]) => string[];
10
+ //# sourceMappingURL=summary.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../../src/render/summary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C,MAAM,MAAM,WAAW,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAIpH,eAAO,MAAM,KAAK,GAAI,UAAU,SAAS,OAAO,EAAE,KAAG,MAOpD,CAAC;AAEF,qCAAqC;AACrC,eAAO,MAAM,aAAa,GAAI,UAAU,SAAS,WAAW,EAAE,KAAG,MAAM,EAKtE,CAAC"}
@@ -0,0 +1,18 @@
1
+ const count = (findings, severity) => findings.filter((finding) => finding.severity === severity).length;
2
+ export const tally = (findings) => {
3
+ const parts = [
4
+ count(findings, "error") > 0 ? `エラー ${count(findings, "error")} 件` : undefined,
5
+ count(findings, "warning") > 0 ? `注意 ${count(findings, "warning")} 件` : undefined,
6
+ count(findings, "info") > 0 ? `参考 ${count(findings, "info")} 件` : undefined,
7
+ ].filter((part) => part !== undefined);
8
+ return parts.length === 0 ? "指摘はありません" : parts.join("、");
9
+ };
10
+ /** 複数ファイルを見たときの締め。1 ファイルのときは出さない。 */
11
+ export const renderSummary = (outcomes) => {
12
+ if (outcomes.length < 2)
13
+ return [];
14
+ const all = outcomes.flatMap((outcome) => outcome.findings);
15
+ const touched = outcomes.filter((outcome) => outcome.findings.length > 0).length;
16
+ return ["", "═".repeat(60), "", ` ${outcomes.length} ファイルを見て、${touched} ファイルに指摘がありました`, ` ${tally(all)}`, ""];
17
+ };
18
+ //# sourceMappingURL=summary.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"summary.js","sourceRoot":"","sources":["../../src/render/summary.ts"],"names":[],"mappings":"AAIA,MAAM,KAAK,GAAG,CAAC,QAA4B,EAAE,QAAgB,EAAU,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,MAAM,CAAC;AAE7I,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,QAA4B,EAAU,EAAE;IAC5D,MAAM,KAAK,GAAG;QACZ,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QAC9E,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QACjF,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;KAC5E,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IACvC,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3D,CAAC,CAAC;AAEF,qCAAqC;AACrC,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,QAAgC,EAAY,EAAE;IAC1E,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,EAAE,CAAC;IACnC,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC;IACjF,OAAO,CAAC,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,QAAQ,CAAC,MAAM,YAAY,OAAO,gBAAgB,EAAE,KAAK,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;AAClH,CAAC,CAAC"}
@@ -0,0 +1,13 @@
1
+ import type { Suppressed, Suppression } from "../stet.ts";
2
+ export type PerFile = {
3
+ readonly path: string;
4
+ readonly suppressed: readonly Suppressed[];
5
+ readonly reasonless: readonly Suppression[];
6
+ };
7
+ /**
8
+ * 抑制が溜まったことに気づけないと、規範と現実の乖離が静かに進む。
9
+ * 同じ rule を何度も黙らせているなら、それは (b) ではなく (c) のサイン。
10
+ * workflow spec §7.3。
11
+ */
12
+ export declare const renderSuppressions: (files: readonly PerFile[]) => string;
13
+ //# sourceMappingURL=suppressions.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"suppressions.d.ts","sourceRoot":"","sources":["../../src/render/suppressions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE1D,MAAM,MAAM,OAAO,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,UAAU,EAAE,SAAS,UAAU,EAAE,CAAC;IAAC,QAAQ,CAAC,UAAU,EAAE,SAAS,WAAW,EAAE,CAAA;CAAE,CAAC;AAqCzI;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAAI,OAAO,SAAS,OAAO,EAAE,KAAG,MAY9D,CAAC"}
@@ -0,0 +1,50 @@
1
+ /** これを超えたら、その rule は (b) ではなく (c) にすべきというサイン。 */
2
+ const NUDGE_AT = 5;
3
+ const groupByRule = (files) => {
4
+ const rows = files.flatMap((file) => file.suppressed.map((entry) => ({ path: file.path, rule: entry.finding.rule, reason: entry.suppression.reason })));
5
+ const ids = [...new Set(rows.map((row) => row.rule))];
6
+ return ids
7
+ .map((rule) => {
8
+ const mine = rows.filter((row) => row.rule === rule);
9
+ return {
10
+ rule,
11
+ count: mine.length,
12
+ files: [...new Set(mine.map((row) => row.path))],
13
+ reasons: [...new Set(mine.flatMap((row) => (row.reason === undefined ? [] : [row.reason])))],
14
+ };
15
+ })
16
+ .sort((left, right) => right.count - left.count);
17
+ };
18
+ const groupLines = (group) => {
19
+ const nudge = group.count >= NUDGE_AT ? " ← 設定の見直しを検討してください" : "";
20
+ const shown = group.files.slice(0, 3).join(", ");
21
+ const rest = group.files.length > 3 ? ` ほか ${group.files.length - 3} ファイル` : "";
22
+ return [
23
+ "",
24
+ ` ${group.rule.padEnd(26)}${String(group.count).padStart(3)} 件${nudge}`,
25
+ ` ${shown}${rest}`,
26
+ ...(group.count >= NUDGE_AT && group.reasons.length > 0
27
+ ? [` 理由: ${group.reasons.slice(0, 2).join(" / ")}`, ` ルールごとゆるめる: npx chaff relax ${group.rule} --why "..."`]
28
+ : []),
29
+ ];
30
+ };
31
+ /**
32
+ * 抑制が溜まったことに気づけないと、規範と現実の乖離が静かに進む。
33
+ * 同じ rule を何度も黙らせているなら、それは (b) ではなく (c) のサイン。
34
+ * workflow spec §7.3。
35
+ */
36
+ export const renderSuppressions = (files) => {
37
+ const groups = groupByRule(files);
38
+ const total = groups.reduce((sum, group) => sum + group.count, 0);
39
+ if (total === 0)
40
+ return "\n 抑制されている指摘はありません。\n";
41
+ const reasonless = files.flatMap((file) => file.reasonless.map(() => file.path));
42
+ return [
43
+ "",
44
+ ` 抑制されている指摘: ${total} 件`,
45
+ ...groups.flatMap(groupLines),
46
+ ...(reasonless.length > 0 ? ["", ` 理由が書かれていない抑制: ${reasonless.length} 件`, ` ${[...new Set(reasonless)].join(", ")}`] : []),
47
+ "",
48
+ ].join("\n");
49
+ };
50
+ //# sourceMappingURL=suppressions.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"suppressions.js","sourceRoot":"","sources":["../../src/render/suppressions.ts"],"names":[],"mappings":"AAIA,iDAAiD;AACjD,MAAM,QAAQ,GAAG,CAAC,CAAC;AAInB,MAAM,WAAW,GAAG,CAAC,KAAyB,EAAW,EAAE;IACzD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IACxJ,MAAM,GAAG,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACtD,OAAO,GAAG;SACP,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACZ,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QACrD,OAAO;YACL,IAAI;YACJ,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;YAChD,OAAO,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;SAC7F,CAAC;IACJ,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,KAAY,EAAY,EAAE;IAC5C,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC;IACnE,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAChF,OAAO;QACL,EAAE;QACF,KAAK,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE;QACxE,SAAS,KAAK,GAAG,IAAI,EAAE;QACvB,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;YACrD,CAAC,CAAC,CAAC,aAAa,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,oCAAoC,KAAK,CAAC,IAAI,cAAc,CAAC;YACtH,CAAC,CAAC,EAAE,CAAC;KACR,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,KAAyB,EAAU,EAAE;IACtE,MAAM,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAClC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAClE,IAAI,KAAK,KAAK,CAAC;QAAE,OAAO,wBAAwB,CAAC;IACjD,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjF,OAAO;QACL,EAAE;QACF,gBAAgB,KAAK,IAAI;QACzB,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;QAC7B,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,mBAAmB,UAAU,CAAC,MAAM,IAAI,EAAE,SAAS,CAAC,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAChI,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC,CAAC"}
@@ -0,0 +1,6 @@
1
+ import type { Finding, Localized, RuleDefinition } from "../plugin.ts";
2
+ export declare const localized: (field: Localized, language: string) => string;
3
+ export declare const fill: (template: string, values: Readonly<Record<string, string | number>>) => string;
4
+ export declare const messageOf: (rule: RuleDefinition, finding: Finding, language: string) => string;
5
+ export declare const MARK: Readonly<Record<string, string>>;
6
+ //# sourceMappingURL=text.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../src/render/text.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAEvE,eAAO,MAAM,SAAS,GAAI,OAAO,SAAS,EAAE,UAAU,MAAM,KAAG,MAAyE,CAAC;AAEzI,eAAO,MAAM,IAAI,GAAI,UAAU,MAAM,EAAE,QAAQ,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,KAAG,MAIvF,CAAC;AAEL,eAAO,MAAM,SAAS,GAAI,MAAM,cAAc,EAAE,SAAS,OAAO,EAAE,UAAU,MAAM,KAAG,MAAiE,CAAC;AAEvJ,eAAO,MAAM,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAA2C,CAAC"}
@@ -0,0 +1,8 @@
1
+ export const localized = (field, language) => field[language] ?? field["en"] ?? Object.values(field)[0] ?? "";
2
+ export const fill = (template, values) => template.replace(/\{(\w+)\}/gu, (whole, key) => {
3
+ const value = values[key];
4
+ return value === undefined ? whole : String(value);
5
+ });
6
+ export const messageOf = (rule, finding, language) => fill(localized(rule.message, language), finding.values);
7
+ export const MARK = { error: "✖", warning: "⚠", info: "·" };
8
+ //# sourceMappingURL=text.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"text.js","sourceRoot":"","sources":["../../src/render/text.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAgB,EAAE,QAAgB,EAAU,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAEzI,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,QAAgB,EAAE,MAAiD,EAAU,EAAE,CAClG,QAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,GAAW,EAAE,EAAE;IACrD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;IAC1B,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACrD,CAAC,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,IAAoB,EAAE,OAAgB,EAAE,QAAgB,EAAU,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;AAEvJ,MAAM,CAAC,MAAM,IAAI,GAAqC,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC"}
@@ -0,0 +1,3 @@
1
+ import type { RuleDefinition } from "./plugin.ts";
2
+ export declare const loadRules: (language: string, dir?: string) => RuleDefinition[];
3
+ //# sourceMappingURL=rule-load.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rule-load.d.ts","sourceRoot":"","sources":["../src/rule-load.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAc,cAAc,EAAY,MAAM,aAAa,CAAC;AAqExE,eAAO,MAAM,SAAS,GAAI,UAAU,MAAM,EAAE,MAAK,MAAkB,KAAG,cAAc,EAII,CAAC"}
@@ -0,0 +1,68 @@
1
+ import { readFileSync, readdirSync } from "node:fs";
2
+ import { fileURLToPath } from "node:url";
3
+ import { dirname, join } from "node:path";
4
+ import { parse } from "yaml";
5
+ const RULES_DIR = join(dirname(fileURLToPath(import.meta.url)), "..", "rules");
6
+ const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
7
+ const isLocalized = (value) => isRecord(value) && Object.values(value).every((entry) => typeof entry === "string");
8
+ const isLevelTable = (value) => isRecord(value) && Object.entries(value).every(([key, entry]) => ["strict", "normal", "relaxed"].includes(key) && typeof entry === "number");
9
+ /** 言語別の levels を、その言語のぶんだけに平坦化する。単位が言語で違う rule のため。 */
10
+ const flattenLevels = (raw, language) => {
11
+ if (isLevelTable(raw))
12
+ return raw;
13
+ if (!isRecord(raw))
14
+ return undefined;
15
+ const forLanguage = raw[language] ?? raw["default"];
16
+ return isLevelTable(forLanguage) ? forLanguage : undefined;
17
+ };
18
+ const SEVERITIES = ["error", "warning", "info"];
19
+ const isSeverity = (value) => SEVERITIES.some((entry) => entry === value);
20
+ const LAYERS = ["L1", "L2", "L3", "L4"];
21
+ const STATUSES = ["experimental", "stable", "deprecated"];
22
+ const pick = (value, allowed) => allowed.find((entry) => entry === value);
23
+ /**
24
+ * 必須フィールドが欠けた rule は読み込まない。spec §18.2。
25
+ * message だけでは、非エンジニアは何が悪いのか分からない。why と how_to_fix を必須にする。
26
+ */
27
+ const REQUIRED_TEXT = ["name", "why", "how_to_fix", "message"];
28
+ const missingFields = (raw, levels) => [
29
+ ...(typeof raw["id"] === "string" ? [] : ["id"]),
30
+ ...(pick(raw["layer"], LAYERS) === undefined ? ["layer"] : []),
31
+ ...(pick(raw["status"], STATUSES) === undefined ? ["status"] : []),
32
+ ...REQUIRED_TEXT.filter((field) => !isLocalized(raw[field])),
33
+ ...(levels?.normal === undefined ? ["levels.normal"] : []),
34
+ ...(typeof raw["how_to_find"] === "string" ? [] : ["how_to_find"]),
35
+ ...(Array.isArray(raw["use_for"]) ? [] : ["use_for"]),
36
+ ...(isSeverity(raw["severity"]) ? [] : ["severity"]),
37
+ ];
38
+ const localizedOf = (value) => (isLocalized(value) ? value : {});
39
+ const toRule = (raw, language, file) => {
40
+ if (!isRecord(raw))
41
+ throw new Error(`${file}: rule は object であること`);
42
+ const levels = flattenLevels(raw["levels"], language);
43
+ const missing = missingFields(raw, levels);
44
+ if (missing.length > 0)
45
+ throw new Error(`${file}: 必須フィールドがありません: ${missing.join(", ")}`);
46
+ if (levels === undefined)
47
+ throw new Error(`${file}: levels を解決できません`);
48
+ return {
49
+ id: String(raw["id"]),
50
+ layer: pick(raw["layer"], LAYERS) ?? "L1",
51
+ status: pick(raw["status"], STATUSES) ?? "experimental",
52
+ name: localizedOf(raw["name"]),
53
+ why: localizedOf(raw["why"]),
54
+ how_to_fix: localizedOf(raw["how_to_fix"]),
55
+ message: localizedOf(raw["message"]),
56
+ levels,
57
+ how_to_find: String(raw["how_to_find"]),
58
+ word_list: typeof raw["word_list"] === "string" ? raw["word_list"] : undefined,
59
+ where: typeof raw["where"] === "string" ? raw["where"] : undefined,
60
+ use_for: Array.isArray(raw["use_for"]) ? raw["use_for"].map((entry) => String(entry)) : [],
61
+ severity: isSeverity(raw["severity"]) ? raw["severity"] : "warning",
62
+ };
63
+ };
64
+ export const loadRules = (language, dir = RULES_DIR) => readdirSync(dir)
65
+ .filter((file) => file.endsWith(".yaml"))
66
+ .sort((left, right) => left.localeCompare(right, "en"))
67
+ .map((file) => toRule(parse(readFileSync(join(dir, file), "utf8")), language, file));
68
+ //# sourceMappingURL=rule-load.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rule-load.js","sourceRoot":"","sources":["../src/rule-load.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAG7B,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AAE/E,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAoC,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAE5I,MAAM,WAAW,GAAG,CAAC,KAAc,EAAmC,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC;AAE7J,MAAM,YAAY,GAAG,CAAC,KAAc,EAAuB,EAAE,CAC3D,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC;AAE/I,uDAAuD;AACvD,MAAM,aAAa,GAAG,CAAC,GAAY,EAAE,QAAgB,EAA0B,EAAE;IAC/E,IAAI,YAAY,CAAC,GAAG,CAAC;QAAE,OAAO,GAAG,CAAC;IAClC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IACrC,MAAM,WAAW,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;IACpD,OAAO,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7D,CAAC,CAAC;AAEF,MAAM,UAAU,GAAwB,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;AACrE,MAAM,UAAU,GAAG,CAAC,KAAc,EAAqB,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;AAEtG,MAAM,MAAM,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAU,CAAC;AACjD,MAAM,QAAQ,GAAG,CAAC,cAAc,EAAE,QAAQ,EAAE,YAAY,CAAU,CAAC;AAEnE,MAAM,IAAI,GAAG,CAAI,KAAc,EAAE,OAAqB,EAAiB,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;AAEnH;;;GAGG;AACH,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,CAAU,CAAC;AAExE,MAAM,aAAa,GAAG,CAAC,GAA4B,EAAE,MAA8B,EAAY,EAAE,CAAC;IAChG,GAAG,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAChD,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9D,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAClE,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5D,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1D,GAAG,CAAC,OAAO,GAAG,CAAC,aAAa,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;IAClE,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACrD,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;CACrD,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,KAAc,EAA0B,EAAE,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AAElG,MAAM,MAAM,GAAG,CAAC,GAAY,EAAE,QAAgB,EAAE,IAAY,EAAkB,EAAE;IAC9E,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,uBAAuB,CAAC,CAAC;IACpE,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC3C,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,oBAAoB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACzF,IAAI,MAAM,KAAK,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,mBAAmB,CAAC,CAAC;IACtE,OAAO;QACL,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACrB,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,IAAI,IAAI;QACzC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,IAAI,cAAc;QACvD,IAAI,EAAE,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC9B,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,UAAU,EAAE,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAC1C,OAAO,EAAE,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACpC,MAAM;QACN,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACvC,SAAS,EAAE,OAAO,GAAG,CAAC,WAAW,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;QAC9E,KAAK,EAAE,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;QAClE,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;QAC1F,QAAQ,EAAE,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;KACpE,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,QAAgB,EAAE,MAAc,SAAS,EAAoB,EAAE,CACvF,WAAW,CAAC,GAAG,CAAC;KACb,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;KACxC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;KACtD,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC"}
package/dist/run.d.ts ADDED
@@ -0,0 +1,14 @@
1
+ import type { Finding, Level, ProseDocument, RuleDefinition } from "./plugin.ts";
2
+ export type Skipped = {
3
+ readonly rule: string;
4
+ readonly why: string;
5
+ };
6
+ export type RunResult = {
7
+ readonly findings: readonly Finding[];
8
+ readonly skipped: readonly Skipped[];
9
+ /** 設定で明示的に有効にした experimental な rule。実行ごとに一度報告する。spec §18.4。 */
10
+ readonly forcedExperimental: readonly string[];
11
+ };
12
+ export type Settings = Readonly<Record<string, Level>>;
13
+ export declare const runRules: (doc: ProseDocument, rules: readonly RuleDefinition[], settings: Settings, experimental: boolean, genre: string) => RunResult;
14
+ //# sourceMappingURL=run.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAGjF,MAAM,MAAM,OAAO,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtE,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE,CAAC;IACtC,QAAQ,CAAC,OAAO,EAAE,SAAS,OAAO,EAAE,CAAC;IACrC,+DAA+D;IAC/D,QAAQ,CAAC,kBAAkB,EAAE,SAAS,MAAM,EAAE,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;AAgBvD,eAAO,MAAM,QAAQ,GAAI,KAAK,aAAa,EAAE,OAAO,SAAS,cAAc,EAAE,EAAE,UAAU,QAAQ,EAAE,cAAc,OAAO,EAAE,OAAO,MAAM,KAAG,SA8BzI,CAAC"}
package/dist/run.js ADDED
@@ -0,0 +1,47 @@
1
+ import { DETECTORS } from "./detectors/index.js";
2
+ import { resolve } from "./levels.js";
3
+ import { lineStarts, placeOf } from "./position.js";
4
+ const levelFor = (rule, settings, experimental) => {
5
+ const explicit = settings[rule.id];
6
+ // 明示設定は status の既定に勝つ。名指しで有効にしたものを黙って無効にしない。
7
+ if (explicit !== undefined)
8
+ return explicit;
9
+ if (rule.status === "experimental" && !experimental)
10
+ return "off";
11
+ return "normal";
12
+ };
13
+ const place = (starts, finding) => {
14
+ const offset = finding.values["offset"];
15
+ const at = placeOf(starts, typeof offset === "number" ? offset : 0);
16
+ return { ...finding, line: at.line, column: at.column };
17
+ };
18
+ export const runRules = (doc, rules, settings, experimental, genre) => {
19
+ const starts = lineStarts(doc.source);
20
+ const applicable = rules.filter((rule) => rule.use_for.some((target) => genre.startsWith(target)));
21
+ const forced = applicable
22
+ .filter((rule) => rule.status === "experimental" && settings[rule.id] !== undefined && settings[rule.id] !== "off")
23
+ .map((rule) => rule.id);
24
+ const outcome = applicable.reduce((acc, rule) => {
25
+ const level = levelFor(rule, settings, experimental);
26
+ if (level === "off") {
27
+ const why = rule.status === "experimental" && settings[rule.id] === undefined ? "まだ試験中のため" : "設定で止めているため";
28
+ return { findings: acc.findings, skipped: [...acc.skipped, { rule: rule.id, why }] };
29
+ }
30
+ const detector = DETECTORS[rule.how_to_find];
31
+ if (detector === undefined)
32
+ return { findings: acc.findings, skipped: [...acc.skipped, { rule: rule.id, why: `検出器 ${rule.how_to_find} がないため` }] };
33
+ const options = {
34
+ limit: resolve(rule, level).limit,
35
+ lexicon: rule.word_list === undefined ? undefined : doc.lexicons[rule.word_list],
36
+ where: rule.where,
37
+ };
38
+ // 語彙表を要求する rule で、その言語に語彙表が無ければ動かせない。黙って通さない。
39
+ if (rule.word_list !== undefined && options.lexicon === undefined) {
40
+ return { findings: acc.findings, skipped: [...acc.skipped, { rule: rule.id, why: `${doc.language} の語彙表 ${rule.word_list} が無いため` }] };
41
+ }
42
+ const found = detector(doc, options).map((finding) => place(starts, { ...finding, rule: rule.id, severity: rule.severity }));
43
+ return { findings: [...acc.findings, ...found], skipped: acc.skipped };
44
+ }, { findings: [], skipped: [] });
45
+ return { ...outcome, findings: [...outcome.findings].sort((left, right) => left.line - right.line), forcedExperimental: forced };
46
+ };
47
+ //# sourceMappingURL=run.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"run.js","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEtC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAapD,MAAM,QAAQ,GAAG,CAAC,IAAoB,EAAE,QAAkB,EAAE,YAAqB,EAAS,EAAE;IAC1F,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACnC,6CAA6C;IAC7C,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC;IAC5C,IAAI,IAAI,CAAC,MAAM,KAAK,cAAc,IAAI,CAAC,YAAY;QAAE,OAAO,KAAK,CAAC;IAClE,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,KAAK,GAAG,CAAC,MAAyB,EAAE,OAAgB,EAAW,EAAE;IACrE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACxC,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACpE,OAAO,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC;AAC1D,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,GAAkB,EAAE,KAAgC,EAAE,QAAkB,EAAE,YAAqB,EAAE,KAAa,EAAa,EAAE;IACpJ,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACnG,MAAM,MAAM,GAAG,UAAU;SACtB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,cAAc,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,SAAS,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,KAAK,CAAC;SAClH,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1B,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAC/B,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;QACZ,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;QACrD,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;YACpB,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,KAAK,cAAc,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC;YAC1G,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,GAAG,GAAG,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;QACvF,CAAC;QACD,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC7C,IAAI,QAAQ,KAAK,SAAS;YAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,GAAG,GAAG,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,OAAO,IAAI,CAAC,WAAW,QAAQ,EAAE,CAAC,EAAE,CAAC;QAClJ,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,KAAK;YACjC,OAAO,EAAE,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;YAChF,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC;QACF,8CAA8C;QAC9C,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClE,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,GAAG,GAAG,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,QAAQ,SAAS,IAAI,CAAC,SAAS,QAAQ,EAAE,CAAC,EAAE,CAAC;QACvI,CAAC;QACD,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QAC7H,OAAO,EAAE,QAAQ,EAAE,CAAC,GAAG,GAAG,CAAC,QAAQ,EAAE,GAAG,KAAK,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC;IACzE,CAAC,EACD,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAC9B,CAAC;IACF,OAAO,EAAE,GAAG,OAAO,EAAE,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC;AACnI,CAAC,CAAC"}
package/dist/stet.d.ts ADDED
@@ -0,0 +1,19 @@
1
+ import type { Finding, Span } from "./plugin.ts";
2
+ export type Suppression = {
3
+ readonly rules: readonly string[];
4
+ readonly reason: string | undefined;
5
+ readonly line: number;
6
+ readonly scope: "next" | "section" | "file";
7
+ };
8
+ export declare const parseSuppressions: (source: string) => Suppression[];
9
+ export type Suppressed = {
10
+ readonly finding: Finding;
11
+ readonly suppression: Suppression;
12
+ };
13
+ export type Applied = {
14
+ readonly kept: readonly Finding[];
15
+ readonly suppressed: readonly Suppressed[];
16
+ readonly unusedReasonless: readonly Suppression[];
17
+ };
18
+ export declare const applySuppressions: (source: string, findings: readonly Finding[], sections: readonly Span[]) => Applied;
19
+ //# sourceMappingURL=stet.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"stet.d.ts","sourceRoot":"","sources":["../src/stet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAEjD,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAAC;CAC7C,CAAC;AAsCF,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,KAAG,WAAW,EAKzD,CAAC;AAcN,MAAM,MAAM,UAAU,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAA;CAAE,CAAC;AAE1F,MAAM,MAAM,OAAO,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,OAAO,EAAE,CAAC;IAAC,QAAQ,CAAC,UAAU,EAAE,SAAS,UAAU,EAAE,CAAC;IAAC,QAAQ,CAAC,gBAAgB,EAAE,SAAS,WAAW,EAAE,CAAA;CAAE,CAAC;AAE3J,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,EAAE,UAAU,SAAS,OAAO,EAAE,EAAE,UAAU,SAAS,IAAI,EAAE,KAAG,OAU3G,CAAC"}
package/dist/stet.js ADDED
@@ -0,0 +1,61 @@
1
+ /**
2
+ * 校正記号 stet(ラテン語で「そのままにせよ」)。
3
+ * 指摘は一般には正しいが、この箇所は意図的だ、と書く手段。
4
+ * これが無いと、残された手は「ルールごと切る」しかなくなる。workflow spec §7.1。
5
+ *
6
+ * 中身の切り分けは正規表現でやらない。入れ子の量指定子はバックトラックが超線形になり、
7
+ * 長い HTML コメントを 1 つ置かれるだけで検査が止まる。ここは ">" を含まない塊として
8
+ * 取り出し、あとはコードで割る。
9
+ */
10
+ const PATTERN = /<!--\s*(stet|stet-section|stet-file)\s*:([^>]*)-->/gu;
11
+ const SCOPE = { stet: "next", "stet-section": "section", "stet-file": "file" };
12
+ /** 理由は em dash のあと。書かなくてもよいが、書かないと chaff suppressions に並ぶ。 */
13
+ const REASON_MARK = "\u2014";
14
+ const RULE_ID = /^[a-z][a-z0-9-]*$/u;
15
+ const lineOf = (source, offset) => source.slice(0, offset).split("\n").length;
16
+ const splitBody = (body) => {
17
+ const at = body.indexOf(REASON_MARK);
18
+ const head = at === -1 ? body : body.slice(0, at);
19
+ // 残っているのはコメント終端の "--" だけ。正規表現で任意個の "-" を剥がすと、
20
+ // 長いダッシュ列でバックトラックする(そして著者が書いたダッシュまで消す)。
21
+ const raw = at === -1 ? "" : body.slice(at + REASON_MARK.length);
22
+ const tail = (raw.endsWith("--") ? raw.slice(0, -2) : raw).trim();
23
+ return {
24
+ rules: head
25
+ .split(",")
26
+ .map((rule) => rule.trim())
27
+ .filter((rule) => RULE_ID.test(rule)),
28
+ reason: tail.length === 0 ? undefined : tail,
29
+ };
30
+ };
31
+ export const parseSuppressions = (source) => [...source.matchAll(PATTERN)].map((match) => ({
32
+ ...splitBody(match[2] ?? ""),
33
+ line: lineOf(source, match.index),
34
+ scope: SCOPE[match[1] ?? "stet"] ?? "next",
35
+ }));
36
+ /** stet が効く範囲。next は直後の塊、section は次の見出しまで、file は全体。 */
37
+ const NEXT_LINES = 6;
38
+ const covers = (suppression, finding, sectionEnds, lastLine) => {
39
+ if (!suppression.rules.includes(finding.rule))
40
+ return false;
41
+ if (suppression.scope === "file")
42
+ return true;
43
+ // 抑制は「この先の箇所」に対して書く。遡って効くと、意図せず黙る範囲が広がる。
44
+ if (finding.line < suppression.line)
45
+ return false;
46
+ if (suppression.scope === "next")
47
+ return finding.line - suppression.line <= NEXT_LINES;
48
+ return finding.line <= (sectionEnds.find((line) => line > suppression.line) ?? lastLine);
49
+ };
50
+ export const applySuppressions = (source, findings, sections) => {
51
+ const suppressions = parseSuppressions(source);
52
+ const sectionEnds = sections.map((span) => lineOf(source, span.end));
53
+ const lastLine = source.split("\n").length;
54
+ const matched = findings.map((finding) => ({ finding, suppression: suppressions.find((entry) => covers(entry, finding, sectionEnds, lastLine)) }));
55
+ return {
56
+ kept: matched.filter((entry) => entry.suppression === undefined).map((entry) => entry.finding),
57
+ suppressed: matched.flatMap((entry) => (entry.suppression === undefined ? [] : [{ finding: entry.finding, suppression: entry.suppression }])),
58
+ unusedReasonless: suppressions.filter((entry) => entry.reason === undefined),
59
+ };
60
+ };
61
+ //# sourceMappingURL=stet.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"stet.js","sourceRoot":"","sources":["../src/stet.ts"],"names":[],"mappings":"AASA;;;;;;;;GAQG;AACH,MAAM,OAAO,GAAG,sDAAsD,CAAC;AAEvE,MAAM,KAAK,GAAmD,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC;AAE/H,8DAA8D;AAC9D,MAAM,WAAW,GAAG,QAAQ,CAAC;AAE7B,MAAM,OAAO,GAAG,oBAAoB,CAAC;AAErC,MAAM,MAAM,GAAG,CAAC,MAAc,EAAE,MAAc,EAAU,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;AAEtG,MAAM,SAAS,GAAG,CAAC,IAAY,EAAmD,EAAE;IAClF,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACrC,MAAM,IAAI,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAClD,8CAA8C;IAC9C,wCAAwC;IACxC,MAAM,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IACjE,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IAClE,OAAO;QACL,KAAK,EAAE,IAAI;aACR,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;aAC1B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,MAAM,EAAE,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI;KAC7C,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,MAAc,EAAiB,EAAE,CACjE,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5C,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC;IACjC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,MAAM;CAC3C,CAAC,CAAC,CAAC;AAEN,uDAAuD;AACvD,MAAM,UAAU,GAAG,CAAC,CAAC;AAErB,MAAM,MAAM,GAAG,CAAC,WAAwB,EAAE,OAAgB,EAAE,WAA8B,EAAE,QAAgB,EAAW,EAAE;IACvH,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAC5D,IAAI,WAAW,CAAC,KAAK,KAAK,MAAM;QAAE,OAAO,IAAI,CAAC;IAC9C,yCAAyC;IACzC,IAAI,OAAO,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IAClD,IAAI,WAAW,CAAC,KAAK,KAAK,MAAM;QAAE,OAAO,OAAO,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,IAAI,UAAU,CAAC;IACvF,OAAO,OAAO,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,CAAC;AAC3F,CAAC,CAAC;AAMF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,MAAc,EAAE,QAA4B,EAAE,QAAyB,EAAW,EAAE;IACpH,MAAM,YAAY,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACrE,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;IAC3C,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACnJ,OAAO;QACL,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;QAC9F,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC7I,gBAAgB,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC;KAC7E,CAAC;AACJ,CAAC,CAAC"}
@@ -0,0 +1,12 @@
1
+ import type { Finding } from "./plugin.ts";
2
+ export type Snapshot = Readonly<Record<string, number>>;
3
+ export declare const snapshotOf: (findings: readonly Finding[]) => Snapshot;
4
+ /**
5
+ * 差分だけを出す。書いている最中に全件を出し直されると、何が変わったのか分からない。
6
+ * workflow spec §11。
7
+ */
8
+ export declare const describeChange: (before: Snapshot, after: Snapshot) => string | undefined;
9
+ export declare const clock: () => string;
10
+ /** 変更が落ち着いてから 1 度だけ呼ぶ。 */
11
+ export declare const watchPaths: (paths: readonly string[], onChange: (path: string) => void) => (() => void);
12
+ //# sourceMappingURL=watch.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["../src/watch.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAK3C,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAExD,eAAO,MAAM,UAAU,GAAI,UAAU,SAAS,OAAO,EAAE,KAAG,QACiE,CAAC;AAI5H;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,QAAQ,EAAE,OAAO,QAAQ,KAAG,MAAM,GAAG,SAU3E,CAAC;AAEF,eAAO,MAAM,KAAK,QAAO,MAA+C,CAAC;AAEzE,0BAA0B;AAC1B,eAAO,MAAM,UAAU,GAAI,OAAO,SAAS,MAAM,EAAE,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,KAAG,CAAC,MAAM,IAAI,CAmBlG,CAAC"}
package/dist/watch.js ADDED
@@ -0,0 +1,40 @@
1
+ import { watch } from "node:fs";
2
+ /** 保存は 1 回でも複数イベントになる。まとめて 1 回だけ走らせる。 */
3
+ const SETTLE_MS = 120;
4
+ export const snapshotOf = (findings) => findings.reduce((acc, finding) => ({ ...acc, [finding.rule]: (acc[finding.rule] ?? 0) + 1 }), {});
5
+ const total = (snapshot) => Object.values(snapshot).reduce((sum, count) => sum + count, 0);
6
+ /**
7
+ * 差分だけを出す。書いている最中に全件を出し直されると、何が変わったのか分からない。
8
+ * workflow spec §11。
9
+ */
10
+ export const describeChange = (before, after) => {
11
+ const rules = [...new Set([...Object.keys(before), ...Object.keys(after)])];
12
+ const moved = rules
13
+ .map((rule) => ({ rule, delta: (after[rule] ?? 0) - (before[rule] ?? 0) }))
14
+ .filter((entry) => entry.delta !== 0)
15
+ .sort((left, right) => left.rule.localeCompare(right.rule, "en"));
16
+ if (moved.length === 0)
17
+ return undefined;
18
+ const detail = moved.map((entry) => `${entry.delta > 0 ? "+" : ""}${entry.delta} ${entry.rule}`).join(", ");
19
+ const mark = total(after) < total(before) ? "✓" : "✗";
20
+ return `${mark} ${total(before)} → ${total(after)} 件 (${detail})`;
21
+ };
22
+ export const clock = () => new Date().toTimeString().slice(0, 8);
23
+ /** 変更が落ち着いてから 1 度だけ呼ぶ。 */
24
+ export const watchPaths = (paths, onChange) => {
25
+ const timers = new Map();
26
+ const watchers = paths.map((path) => watch(path, () => {
27
+ const pending = timers.get(path);
28
+ if (pending !== undefined)
29
+ clearTimeout(pending);
30
+ timers.set(path, setTimeout(() => {
31
+ timers.delete(path);
32
+ onChange(path);
33
+ }, SETTLE_MS));
34
+ }));
35
+ return () => {
36
+ timers.forEach((timer) => clearTimeout(timer));
37
+ watchers.forEach((watcher) => watcher.close());
38
+ };
39
+ };
40
+ //# sourceMappingURL=watch.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"watch.js","sourceRoot":"","sources":["../src/watch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAGhC,yCAAyC;AACzC,MAAM,SAAS,GAAG,GAAG,CAAC;AAItB,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,QAA4B,EAAY,EAAE,CACnE,QAAQ,CAAC,MAAM,CAAyB,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;AAE5H,MAAM,KAAK,GAAG,CAAC,QAAkB,EAAU,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC;AAE7G;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAAgB,EAAE,KAAe,EAAsB,EAAE;IACtF,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5E,MAAM,KAAK,GAAG,KAAK;SAChB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;SAC1E,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC,CAAC;SACpC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IACpE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACzC,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5G,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;IACtD,OAAO,GAAG,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,MAAM,GAAG,CAAC;AACtE,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,KAAK,GAAG,GAAW,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAEzE,0BAA0B;AAC1B,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAwB,EAAE,QAAgC,EAAgB,EAAE;IACrG,MAAM,MAAM,GAAG,IAAI,GAAG,EAA0B,CAAC;IACjD,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAClC,KAAK,CAAC,IAAI,EAAE,GAAG,EAAE;QACf,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,OAAO,KAAK,SAAS;YAAE,YAAY,CAAC,OAAO,CAAC,CAAC;QACjD,MAAM,CAAC,GAAG,CACR,IAAI,EACJ,UAAU,CAAC,GAAG,EAAE;YACd,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACpB,QAAQ,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC,EAAE,SAAS,CAAC,CACd,CAAC;IACJ,CAAC,CAAC,CACH,CAAC;IACF,OAAO,GAAS,EAAE;QAChB,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;QAC/C,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IACjD,CAAC,CAAC;AACJ,CAAC,CAAC"}
package/package.json ADDED
@@ -0,0 +1,63 @@
1
+ {
2
+ "name": "chaffjs",
3
+ "version": "0.0.1",
4
+ "description": "Prose validation harness. Finds what is hard to read, and never rewrites it for you.",
5
+ "keywords": [
6
+ "chaff",
7
+ "lint",
8
+ "prose",
9
+ "writing",
10
+ "textlint",
11
+ "style-guide",
12
+ "japanese",
13
+ "ci"
14
+ ],
15
+ "homepage": "https://github.com/isamu/lab/tree/main/text",
16
+ "repository": {
17
+ "type": "git",
18
+ "url": "git+https://github.com/isamu/lab.git",
19
+ "directory": "text/packages/chaff"
20
+ },
21
+ "license": "MIT",
22
+ "author": "isamu",
23
+ "type": "module",
24
+ "bin": {
25
+ "chaffjs": "./bin/chaff.js",
26
+ "chaff": "./bin/chaff.js"
27
+ },
28
+ "exports": {
29
+ ".": {
30
+ "types": "./src/index.ts",
31
+ "import": "./dist/index.js"
32
+ },
33
+ "./plugin": {
34
+ "types": "./src/plugin.ts",
35
+ "import": "./dist/plugin.js"
36
+ }
37
+ },
38
+ "files": [
39
+ "LICENSE",
40
+ "README.md",
41
+ "bin",
42
+ "dist",
43
+ "rules",
44
+ "src"
45
+ ],
46
+ "engines": {
47
+ "node": ">=24"
48
+ },
49
+ "scripts": {
50
+ "build": "tsc -p tsconfig.build.json",
51
+ "prepack": "yarn build"
52
+ },
53
+ "dependencies": {
54
+ "@chaffjs/lang-en": "0.0.1",
55
+ "@chaffjs/lang-ja": "0.0.1",
56
+ "mdast-util-from-markdown": "^2.0.3",
57
+ "mdast-util-frontmatter": "^2.0.1",
58
+ "mdast-util-gfm-table": "^2.0.0",
59
+ "micromark-extension-frontmatter": "^2.0.0",
60
+ "micromark-extension-gfm-table": "^2.1.1",
61
+ "yaml": "^2.9.0"
62
+ }
63
+ }
@@ -0,0 +1,28 @@
1
+ id: bold-density
2
+ layer: L1
3
+ status: stable
4
+ how_to_find: count-per-section
5
+ severity: warning
6
+
7
+ name:
8
+ ja: 太字の使いすぎ
9
+ en: Too much bold
10
+
11
+ why:
12
+ ja: 太字は読者の目を止める道具です。多用すると、どこも目立たなくなります。
13
+ en: Bold marks what matters. Used everywhere, it marks nothing.
14
+
15
+ message:
16
+ ja: このセクションに太字が {count} 箇所あります({limit} 箇所まで)
17
+ en: "{count} bold spans in this section (limit {limit})"
18
+
19
+ how_to_fix:
20
+ ja: 本当に強調したい 1〜2 箇所だけ残して、ほかは普通の文にしてください。
21
+ en: Keep one or two, unbold the rest.
22
+
23
+ levels:
24
+ strict: 1
25
+ normal: 2
26
+ relaxed: 4
27
+
28
+ use_for: [blog, business]