chaffjs 0.21.0 → 0.23.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 +9 -2
- package/dist/api.d.ts +14 -0
- package/dist/api.d.ts.map +1 -1
- package/dist/api.js.map +1 -1
- package/dist/cli-args.d.ts +2 -0
- package/dist/cli-args.d.ts.map +1 -1
- package/dist/cli-args.js +2 -0
- package/dist/cli-args.js.map +1 -1
- package/dist/cli-text.d.ts.map +1 -1
- package/dist/cli-text.js +6 -0
- package/dist/cli-text.js.map +1 -1
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +17 -30
- package/dist/cli.js.map +1 -1
- package/dist/commands/feedback.d.ts +3 -0
- package/dist/commands/feedback.d.ts.map +1 -1
- package/dist/commands/feedback.js.map +1 -1
- package/dist/commands/fix-plan.d.ts.map +1 -1
- package/dist/commands/fix-plan.js +5 -0
- package/dist/commands/fix-plan.js.map +1 -1
- package/dist/commands/init-command.d.ts +4 -0
- package/dist/commands/init-command.d.ts.map +1 -0
- package/dist/commands/init-command.js +15 -0
- package/dist/commands/init-command.js.map +1 -0
- package/dist/commands/plugin-init.d.ts +20 -0
- package/dist/commands/plugin-init.d.ts.map +1 -0
- package/dist/commands/plugin-init.js +129 -0
- package/dist/commands/plugin-init.js.map +1 -0
- package/dist/commands/plugin-test.d.ts +11 -0
- package/dist/commands/plugin-test.d.ts.map +1 -0
- package/dist/commands/plugin-test.js +81 -0
- package/dist/commands/plugin-test.js.map +1 -0
- package/dist/commands/rules.d.ts +9 -0
- package/dist/commands/rules.d.ts.map +1 -0
- package/dist/commands/rules.js +26 -0
- package/dist/commands/rules.js.map +1 -0
- package/dist/config/load.d.ts +6 -1
- package/dist/config/load.d.ts.map +1 -1
- package/dist/config/load.js +1 -0
- package/dist/config/load.js.map +1 -1
- package/dist/config/style.js +1 -1
- package/dist/config/style.js.map +1 -1
- package/dist/config/warnings.d.ts +1 -1
- package/dist/config/warnings.d.ts.map +1 -1
- package/dist/config/warnings.js +3 -1
- package/dist/config/warnings.js.map +1 -1
- package/dist/custom/problems.d.ts.map +1 -1
- package/dist/custom/problems.js +1 -2
- package/dist/custom/problems.js.map +1 -1
- package/dist/detectors/amount-for-count.d.ts +21 -0
- package/dist/detectors/amount-for-count.d.ts.map +1 -0
- package/dist/detectors/amount-for-count.js +55 -0
- package/dist/detectors/amount-for-count.js.map +1 -0
- package/dist/detectors/currency-notation.d.ts +29 -0
- package/dist/detectors/currency-notation.d.ts.map +1 -0
- package/dist/detectors/currency-notation.js +58 -0
- package/dist/detectors/currency-notation.js.map +1 -0
- package/dist/detectors/dangling-opener.d.ts +14 -0
- package/dist/detectors/dangling-opener.d.ts.map +1 -0
- package/dist/detectors/dangling-opener.js +55 -0
- package/dist/detectors/dangling-opener.js.map +1 -0
- package/dist/detectors/ellipsis.d.ts +10 -0
- package/dist/detectors/ellipsis.d.ts.map +1 -0
- package/dist/detectors/ellipsis.js +56 -0
- package/dist/detectors/ellipsis.js.map +1 -0
- package/dist/detectors/footnote-mismatch.d.ts +11 -0
- package/dist/detectors/footnote-mismatch.d.ts.map +1 -0
- package/dist/detectors/footnote-mismatch.js +55 -0
- package/dist/detectors/footnote-mismatch.js.map +1 -0
- package/dist/detectors/form-minority.d.ts +13 -0
- package/dist/detectors/form-minority.d.ts.map +1 -0
- package/dist/detectors/form-minority.js +19 -0
- package/dist/detectors/form-minority.js.map +1 -0
- package/dist/detectors/heading-end-mark.d.ts +10 -0
- package/dist/detectors/heading-end-mark.d.ts.map +1 -0
- package/dist/detectors/heading-end-mark.js +59 -0
- package/dist/detectors/heading-end-mark.js.map +1 -0
- package/dist/detectors/list-marker.d.ts +7 -0
- package/dist/detectors/list-marker.d.ts.map +1 -0
- package/dist/detectors/list-marker.js +50 -0
- package/dist/detectors/list-marker.js.map +1 -0
- package/dist/detectors/markdown-slip.d.ts +19 -0
- package/dist/detectors/markdown-slip.d.ts.map +1 -0
- package/dist/detectors/markdown-slip.js +122 -0
- package/dist/detectors/markdown-slip.js.map +1 -0
- package/dist/detectors/numeral-opener.d.ts +10 -0
- package/dist/detectors/numeral-opener.d.ts.map +1 -0
- package/dist/detectors/numeral-opener.js +65 -0
- package/dist/detectors/numeral-opener.js.map +1 -0
- package/dist/detectors/ordinal-suffix.d.ts +12 -0
- package/dist/detectors/ordinal-suffix.d.ts.map +1 -0
- package/dist/detectors/ordinal-suffix.js +33 -0
- package/dist/detectors/ordinal-suffix.js.map +1 -0
- package/dist/detectors/range-notation.d.ts +15 -0
- package/dist/detectors/range-notation.d.ts.map +1 -0
- package/dist/detectors/range-notation.js +58 -0
- package/dist/detectors/range-notation.js.map +1 -0
- package/dist/detectors/registry/amount-for-count.d.ts +3 -0
- package/dist/detectors/registry/amount-for-count.d.ts.map +1 -0
- package/dist/detectors/registry/amount-for-count.js +3 -0
- package/dist/detectors/registry/amount-for-count.js.map +1 -0
- package/dist/detectors/registry/currency-notation.d.ts +3 -0
- package/dist/detectors/registry/currency-notation.d.ts.map +1 -0
- package/dist/detectors/registry/currency-notation.js +3 -0
- package/dist/detectors/registry/currency-notation.js.map +1 -0
- package/dist/detectors/registry/dangling-opener.d.ts +3 -0
- package/dist/detectors/registry/dangling-opener.d.ts.map +1 -0
- package/dist/detectors/registry/dangling-opener.js +3 -0
- package/dist/detectors/registry/dangling-opener.js.map +1 -0
- package/dist/detectors/registry/ellipsis-consistency.d.ts +3 -0
- package/dist/detectors/registry/ellipsis-consistency.d.ts.map +1 -0
- package/dist/detectors/registry/ellipsis-consistency.js +3 -0
- package/dist/detectors/registry/ellipsis-consistency.js.map +1 -0
- package/dist/detectors/registry/footnote-mismatch.d.ts +3 -0
- package/dist/detectors/registry/footnote-mismatch.d.ts.map +1 -0
- package/dist/detectors/registry/footnote-mismatch.js +3 -0
- package/dist/detectors/registry/footnote-mismatch.js.map +1 -0
- package/dist/detectors/registry/heading-end-punctuation.d.ts +3 -0
- package/dist/detectors/registry/heading-end-punctuation.d.ts.map +1 -0
- package/dist/detectors/registry/heading-end-punctuation.js +3 -0
- package/dist/detectors/registry/heading-end-punctuation.js.map +1 -0
- package/dist/detectors/registry/list-marker.d.ts +3 -0
- package/dist/detectors/registry/list-marker.d.ts.map +1 -0
- package/dist/detectors/registry/list-marker.js +3 -0
- package/dist/detectors/registry/list-marker.js.map +1 -0
- package/dist/detectors/registry/numeral-opener.d.ts +3 -0
- package/dist/detectors/registry/numeral-opener.d.ts.map +1 -0
- package/dist/detectors/registry/numeral-opener.js +3 -0
- package/dist/detectors/registry/numeral-opener.js.map +1 -0
- package/dist/detectors/registry/ordinal-suffix.d.ts +3 -0
- package/dist/detectors/registry/ordinal-suffix.d.ts.map +1 -0
- package/dist/detectors/registry/ordinal-suffix.js +3 -0
- package/dist/detectors/registry/ordinal-suffix.js.map +1 -0
- package/dist/detectors/registry/range-notation.d.ts +3 -0
- package/dist/detectors/registry/range-notation.d.ts.map +1 -0
- package/dist/detectors/registry/range-notation.js +3 -0
- package/dist/detectors/registry/range-notation.js.map +1 -0
- package/dist/detectors/registry/relative-pronoun-mix.d.ts +3 -0
- package/dist/detectors/registry/relative-pronoun-mix.d.ts.map +1 -0
- package/dist/detectors/registry/relative-pronoun-mix.js +3 -0
- package/dist/detectors/registry/relative-pronoun-mix.js.map +1 -0
- package/dist/detectors/registry/share-over-hundred.d.ts +3 -0
- package/dist/detectors/registry/share-over-hundred.d.ts.map +1 -0
- package/dist/detectors/registry/share-over-hundred.js +3 -0
- package/dist/detectors/registry/share-over-hundred.js.map +1 -0
- package/dist/detectors/registry/step-reference.d.ts +3 -0
- package/dist/detectors/registry/step-reference.d.ts.map +1 -0
- package/dist/detectors/registry/step-reference.js +3 -0
- package/dist/detectors/registry/step-reference.js.map +1 -0
- package/dist/detectors/registry/table-row-overflow.d.ts +3 -0
- package/dist/detectors/registry/table-row-overflow.d.ts.map +1 -0
- package/dist/detectors/registry/table-row-overflow.js +3 -0
- package/dist/detectors/registry/table-row-overflow.js.map +1 -0
- package/dist/detectors/registry/toc-heading.d.ts +3 -0
- package/dist/detectors/registry/toc-heading.d.ts.map +1 -0
- package/dist/detectors/registry/toc-heading.js +3 -0
- package/dist/detectors/registry/toc-heading.js.map +1 -0
- package/dist/detectors/registry/unclosed-code-fence.d.ts +3 -0
- package/dist/detectors/registry/unclosed-code-fence.d.ts.map +1 -0
- package/dist/detectors/registry/unclosed-code-fence.js +3 -0
- package/dist/detectors/registry/unclosed-code-fence.js.map +1 -0
- package/dist/detectors/registry/unrendered-emphasis.d.ts +3 -0
- package/dist/detectors/registry/unrendered-emphasis.d.ts.map +1 -0
- package/dist/detectors/registry/unrendered-emphasis.js +3 -0
- package/dist/detectors/registry/unrendered-emphasis.js.map +1 -0
- package/dist/detectors/relative-pronoun-mix.d.ts +19 -0
- package/dist/detectors/relative-pronoun-mix.d.ts.map +1 -0
- package/dist/detectors/relative-pronoun-mix.js +60 -0
- package/dist/detectors/relative-pronoun-mix.js.map +1 -0
- package/dist/detectors/share-over-hundred.d.ts +20 -0
- package/dist/detectors/share-over-hundred.d.ts.map +1 -0
- package/dist/detectors/share-over-hundred.js +55 -0
- package/dist/detectors/share-over-hundred.js.map +1 -0
- package/dist/detectors/step-reference.d.ts +20 -0
- package/dist/detectors/step-reference.d.ts.map +1 -0
- package/dist/detectors/step-reference.js +57 -0
- package/dist/detectors/step-reference.js.map +1 -0
- package/dist/detectors/toc-heading.d.ts +10 -0
- package/dist/detectors/toc-heading.d.ts.map +1 -0
- package/dist/detectors/toc-heading.js +99 -0
- package/dist/detectors/toc-heading.js.map +1 -0
- package/dist/extension/load.d.ts +3 -0
- package/dist/extension/load.d.ts.map +1 -1
- package/dist/extension/load.js +1 -0
- package/dist/extension/load.js.map +1 -1
- package/dist/extension/pack-read.d.ts.map +1 -1
- package/dist/extension/pack-read.js +1 -0
- package/dist/extension/pack-read.js.map +1 -1
- package/dist/extension/plugin-load.js.map +1 -1
- package/dist/extension/plugin-parse.d.ts +7 -0
- package/dist/extension/plugin-parse.d.ts.map +1 -1
- package/dist/extension/plugin-parse.js +18 -2
- package/dist/extension/plugin-parse.js.map +1 -1
- package/dist/extension/problem-text.d.ts.map +1 -1
- package/dist/extension/problem-text.js +5 -0
- package/dist/extension/problem-text.js.map +1 -1
- package/dist/fix-plan/plan.d.ts +4 -0
- package/dist/fix-plan/plan.d.ts.map +1 -1
- package/dist/fix-plan/plan.js +1 -0
- package/dist/fix-plan/plan.js.map +1 -1
- package/dist/fix-plan/render.d.ts.map +1 -1
- package/dist/fix-plan/render.js +9 -0
- package/dist/fix-plan/render.js.map +1 -1
- package/dist/fix-plan/text.d.ts +4 -0
- package/dist/fix-plan/text.d.ts.map +1 -1
- package/dist/fix-plan/text.js +8 -2
- package/dist/fix-plan/text.js.map +1 -1
- package/dist/genre-guide/key-rules.d.ts +10 -0
- package/dist/genre-guide/key-rules.d.ts.map +1 -0
- package/dist/genre-guide/key-rules.js +23 -0
- package/dist/genre-guide/key-rules.js.map +1 -0
- package/dist/genre-guide/layer.d.ts +44 -0
- package/dist/genre-guide/layer.d.ts.map +1 -0
- package/dist/genre-guide/layer.js +43 -0
- package/dist/genre-guide/layer.js.map +1 -0
- package/dist/genre-guide/lines.d.ts +15 -0
- package/dist/genre-guide/lines.d.ts.map +1 -0
- package/dist/genre-guide/lines.js +39 -0
- package/dist/genre-guide/lines.js.map +1 -0
- package/dist/genre-guide/of-config.d.ts +13 -0
- package/dist/genre-guide/of-config.d.ts.map +1 -0
- package/dist/genre-guide/of-config.js +18 -0
- package/dist/genre-guide/of-config.js.map +1 -0
- package/dist/genre-guide/problem-text.d.ts +5 -0
- package/dist/genre-guide/problem-text.d.ts.map +1 -0
- package/dist/genre-guide/problem-text.js +29 -0
- package/dist/genre-guide/problem-text.js.map +1 -0
- package/dist/genre-guide/render.d.ts +5 -0
- package/dist/genre-guide/render.d.ts.map +1 -0
- package/dist/genre-guide/render.js +38 -0
- package/dist/genre-guide/render.js.map +1 -0
- package/dist/genre-guide/report.d.ts +32 -0
- package/dist/genre-guide/report.d.ts.map +1 -0
- package/dist/genre-guide/report.js +42 -0
- package/dist/genre-guide/report.js.map +1 -0
- package/dist/genre-guide/resolve.d.ts +16 -0
- package/dist/genre-guide/resolve.d.ts.map +1 -0
- package/dist/genre-guide/resolve.js +31 -0
- package/dist/genre-guide/resolve.js.map +1 -0
- package/dist/genre-parse.d.ts +5 -1
- package/dist/genre-parse.d.ts.map +1 -1
- package/dist/genre-parse.js +8 -1
- package/dist/genre-parse.js.map +1 -1
- package/dist/init.d.ts.map +1 -1
- package/dist/init.js +14 -0
- package/dist/init.js.map +1 -1
- package/dist/list-marks.d.ts +21 -0
- package/dist/list-marks.d.ts.map +1 -0
- package/dist/list-marks.js +82 -0
- package/dist/list-marks.js.map +1 -0
- package/dist/render/rules-json.d.ts +2 -1
- package/dist/render/rules-json.d.ts.map +1 -1
- package/dist/render/rules-json.js +3 -1
- package/dist/render/rules-json.js.map +1 -1
- package/dist/render/sarif.d.ts +3 -1
- package/dist/render/sarif.d.ts.map +1 -1
- package/dist/render/sarif.js +3 -1
- package/dist/render/sarif.js.map +1 -1
- package/dist/rule-fields.d.ts +5 -0
- package/dist/rule-fields.d.ts.map +1 -1
- package/dist/rule-fields.js +21 -0
- package/dist/rule-fields.js.map +1 -1
- package/dist/style-parse.d.ts +3 -0
- package/dist/style-parse.d.ts.map +1 -1
- package/dist/style-parse.js +18 -2
- package/dist/style-parse.js.map +1 -1
- package/genres.yaml +329 -0
- package/package.json +3 -3
- package/rules/cliche.yaml +67 -0
- package/rules/currency-notation-consistency.yaml +77 -0
- package/rules/dangling-participle.yaml +58 -0
- package/rules/ellipsis-consistency.yaml +73 -0
- package/rules/figurative-density.yaml +84 -0
- package/rules/footnote-mismatch.yaml +91 -0
- package/rules/heading-end-punctuation-mix.yaml +158 -0
- package/rules/less-for-fewer.yaml +59 -0
- package/rules/list-marker-mix.yaml +111 -0
- package/rules/nonstandard-word.yaml +80 -0
- package/rules/numeral-sentence-start.yaml +56 -0
- package/rules/ordinal-suffix-mismatch.yaml +65 -0
- package/rules/range-notation-consistency.yaml +73 -0
- package/rules/share-over-hundred.yaml +65 -0
- package/rules/step-reference-missing.yaml +85 -0
- package/rules/table-row-overflow.yaml +90 -0
- package/rules/toc-heading-mismatch.yaml +136 -0
- package/rules/unclosed-code-fence.yaml +107 -0
- package/rules/uncomparable-graded.yaml +65 -0
- package/rules/unrendered-emphasis.yaml +73 -0
- package/rules/which-that-consistency.yaml +64 -0
- package/skills/chaff/SKILL.md +13 -7
- package/src/api.ts +13 -0
- package/src/cli-args.ts +3 -0
- package/src/cli-text.ts +6 -0
- package/src/cli.ts +21 -29
- package/src/commands/feedback.ts +3 -0
- package/src/commands/fix-plan.ts +8 -0
- package/src/commands/init-command.ts +13 -0
- package/src/commands/plugin-init.ts +150 -0
- package/src/commands/plugin-test.ts +111 -0
- package/src/commands/rules.ts +34 -0
- package/src/config/load.ts +7 -1
- package/src/config/style.ts +1 -1
- package/src/config/warnings.ts +3 -1
- package/src/custom/problems.ts +1 -3
- package/src/detectors/amount-for-count.ts +90 -0
- package/src/detectors/currency-notation.ts +90 -0
- package/src/detectors/dangling-opener.ts +74 -0
- package/src/detectors/ellipsis.ts +74 -0
- package/src/detectors/footnote-mismatch.ts +72 -0
- package/src/detectors/form-minority.ts +21 -0
- package/src/detectors/heading-end-mark.ts +82 -0
- package/src/detectors/list-marker.ts +60 -0
- package/src/detectors/markdown-slip.ts +140 -0
- package/src/detectors/numeral-opener.ts +72 -0
- package/src/detectors/ordinal-suffix.ts +40 -0
- package/src/detectors/range-notation.ts +76 -0
- package/src/detectors/registry/amount-for-count.ts +4 -0
- package/src/detectors/registry/currency-notation.ts +4 -0
- package/src/detectors/registry/dangling-opener.ts +4 -0
- package/src/detectors/registry/ellipsis-consistency.ts +4 -0
- package/src/detectors/registry/footnote-mismatch.ts +4 -0
- package/src/detectors/registry/heading-end-punctuation.ts +4 -0
- package/src/detectors/registry/list-marker.ts +4 -0
- package/src/detectors/registry/numeral-opener.ts +4 -0
- package/src/detectors/registry/ordinal-suffix.ts +4 -0
- package/src/detectors/registry/range-notation.ts +4 -0
- package/src/detectors/registry/relative-pronoun-mix.ts +4 -0
- package/src/detectors/registry/share-over-hundred.ts +4 -0
- package/src/detectors/registry/step-reference.ts +4 -0
- package/src/detectors/registry/table-row-overflow.ts +4 -0
- package/src/detectors/registry/toc-heading.ts +4 -0
- package/src/detectors/registry/unclosed-code-fence.ts +4 -0
- package/src/detectors/registry/unrendered-emphasis.ts +4 -0
- package/src/detectors/relative-pronoun-mix.ts +79 -0
- package/src/detectors/share-over-hundred.ts +75 -0
- package/src/detectors/step-reference.ts +83 -0
- package/src/detectors/toc-heading.ts +125 -0
- package/src/extension/load.ts +4 -0
- package/src/extension/pack-read.ts +1 -0
- package/src/extension/plugin-load.ts +1 -1
- package/src/extension/plugin-parse.ts +27 -4
- package/src/extension/problem-text.ts +7 -1
- package/src/fix-plan/plan.ts +5 -0
- package/src/fix-plan/render.ts +9 -0
- package/src/fix-plan/text.ts +12 -2
- package/src/genre-guide/key-rules.ts +37 -0
- package/src/genre-guide/layer.ts +77 -0
- package/src/genre-guide/lines.ts +41 -0
- package/src/genre-guide/of-config.ts +26 -0
- package/src/genre-guide/problem-text.ts +34 -0
- package/src/genre-guide/render.ts +50 -0
- package/src/genre-guide/report.ts +63 -0
- package/src/genre-guide/resolve.ts +36 -0
- package/src/genre-parse.ts +13 -3
- package/src/init.ts +14 -0
- package/src/list-marks.ts +106 -0
- package/src/render/rules-json.ts +4 -0
- package/src/render/sarif.ts +4 -1
- package/src/rule-fields.ts +28 -0
- package/src/style-parse.ts +19 -1
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { UiLanguage } from "../ui.ts";
|
|
2
|
+
export type PackName = {
|
|
3
|
+
readonly scope: string | undefined;
|
|
4
|
+
readonly name: string;
|
|
5
|
+
};
|
|
6
|
+
/** The name as written after --plugin, or undefined when it cannot be a plugin's name. "chaff-plugin-" in front is allowed and dropped. */
|
|
7
|
+
export declare const packNameOf: (written: string | undefined) => PackName | undefined;
|
|
8
|
+
/** The package's name and the folder it is made in: chaff-plugin-house, or @team/chaff-plugin-house in chaff-plugin-house. */
|
|
9
|
+
export declare const packageOf: (pack: PackName) => {
|
|
10
|
+
readonly packageName: string;
|
|
11
|
+
readonly folder: string;
|
|
12
|
+
};
|
|
13
|
+
/** Makes the pack in dir. Lines to print, and whether it was made; nothing is written when the folder is already there. */
|
|
14
|
+
export declare const initPlugin: (dir: string, written: string | undefined, ui: UiLanguage) => {
|
|
15
|
+
readonly ok: boolean;
|
|
16
|
+
readonly lines: readonly string[];
|
|
17
|
+
};
|
|
18
|
+
/** chaff init --plugin <name>: makes the pack in dir and says what it made, or why it did not. */
|
|
19
|
+
export declare const runInitPlugin: (dir: string, written: string | undefined, ui: UiLanguage) => number;
|
|
20
|
+
//# sourceMappingURL=plugin-init.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plugin-init.d.ts","sourceRoot":"","sources":["../../src/commands/plugin-init.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAS,UAAU,EAAE,MAAM,UAAU,CAAC;AAQlD,MAAM,MAAM,QAAQ,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAErF,2IAA2I;AAC3I,eAAO,MAAM,UAAU,GAAI,SAAS,MAAM,GAAG,SAAS,KAAG,QAAQ,GAAG,SAKnE,CAAC;AAEF,8HAA8H;AAC9H,eAAO,MAAM,SAAS,GAAI,MAAM,QAAQ,KAAG;IAAE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAGhG,CAAC;AAoGH,2HAA2H;AAC3H,eAAO,MAAM,UAAU,GAAI,KAAK,MAAM,EAAE,SAAS,MAAM,GAAG,SAAS,EAAE,IAAI,UAAU,KAAG;IAAE,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAA;CAe9I,CAAC;AAEF,kGAAkG;AAClG,eAAO,MAAM,aAAa,GAAI,KAAK,MAAM,EAAE,SAAS,MAAM,GAAG,SAAS,EAAE,IAAI,UAAU,KAAG,MAIxF,CAAC"}
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
import { existsSync, mkdirSync, writeFileSync } from "node:fs";
|
|
2
|
+
import { dirname, join } from "node:path";
|
|
3
|
+
import { API_VERSION } from "../api.js";
|
|
4
|
+
import { VERSION } from "../version.js";
|
|
5
|
+
// chaff init --plugin <name>: a rule pack to start from, written in YAML alone. One rule, its word list in Japanese and
|
|
6
|
+
// English, and a test command (chaff plugin-test) that checks each rule's example against the rule.
|
|
7
|
+
/** A pack's own name: lowercase letters, digits and hyphens, optionally under a scope (@team/house). */
|
|
8
|
+
const PACK_NAME = /^(?:(@[a-z0-9][a-z0-9._-]*)\/)?([a-z][a-z0-9-]*)$/u;
|
|
9
|
+
/** The name as written after --plugin, or undefined when it cannot be a plugin's name. "chaff-plugin-" in front is allowed and dropped. */
|
|
10
|
+
export const packNameOf = (written) => {
|
|
11
|
+
const match = PACK_NAME.exec((written ?? "").replace(/(^|\/)chaff-plugin-/u, "$1"));
|
|
12
|
+
if (match === null)
|
|
13
|
+
return undefined;
|
|
14
|
+
const [, scope, name] = match;
|
|
15
|
+
return name === undefined ? undefined : { scope, name };
|
|
16
|
+
};
|
|
17
|
+
/** The package's name and the folder it is made in: chaff-plugin-house, or @team/chaff-plugin-house in chaff-plugin-house. */
|
|
18
|
+
export const packageOf = (pack) => ({
|
|
19
|
+
packageName: pack.scope === undefined ? `chaff-plugin-${pack.name}` : `${pack.scope}/chaff-plugin-${pack.name}`,
|
|
20
|
+
folder: `chaff-plugin-${pack.name}`,
|
|
21
|
+
});
|
|
22
|
+
const RULE = `# One rule of the pack. It is written as a rule under custom_rules in chaff.yaml is; see
|
|
23
|
+
# https://isamu.github.io/lab/en/guide/adding-rules for every field.
|
|
24
|
+
id: avoid-words
|
|
25
|
+
type: words
|
|
26
|
+
# The words come from lexicons/<language>/avoid-words.yaml, in the document's language.
|
|
27
|
+
word_list: avoid-words
|
|
28
|
+
name: { ja: チームで使わない言葉, en: A word the team does not use }
|
|
29
|
+
why:
|
|
30
|
+
ja: このチームでは、同じものを決まった言葉で呼びます。別の言葉が混ざると、読む人は別のものかと迷います。
|
|
31
|
+
en: The team calls each thing by one word. Another word makes a reader wonder whether it is another thing.
|
|
32
|
+
how_to_fix: { ja: チームの言葉に置き換えます。, en: Use the team's word. }
|
|
33
|
+
message:
|
|
34
|
+
ja: 「{matched}」ではなく「{preferred}」と書きます
|
|
35
|
+
en: 'Write "{preferred}", not "{matched}"'
|
|
36
|
+
level: warning
|
|
37
|
+
example:
|
|
38
|
+
ja: { before: 弊社の新しい窓口をご案内します。, after: 当社の新しい窓口をご案内します。 }
|
|
39
|
+
en: { before: We utilize the new form for every request., after: We use the new form for every request. }
|
|
40
|
+
rewrite:
|
|
41
|
+
depth: light
|
|
42
|
+
ja:
|
|
43
|
+
direction: 指された言葉だけを、チームの言葉に置き換えます。
|
|
44
|
+
pairs:
|
|
45
|
+
- { before: 弊社の新しい窓口をご案内します。, after: 当社の新しい窓口をご案内します。 }
|
|
46
|
+
- { before: 弊社では毎月点検しています。, after: 当社では毎月点検しています。 }
|
|
47
|
+
keep: [文のほかの部分]
|
|
48
|
+
avoid: [言葉と一緒に文の意味を変える]
|
|
49
|
+
en:
|
|
50
|
+
direction: Replace only the flagged word with the team's word.
|
|
51
|
+
pairs:
|
|
52
|
+
- { before: We utilize the new form for every request., after: We use the new form for every request. }
|
|
53
|
+
- { before: Utilize the search box first., after: Use the search box first. }
|
|
54
|
+
keep: [the rest of the sentence]
|
|
55
|
+
avoid: [changing what the sentence says along with the word]
|
|
56
|
+
`;
|
|
57
|
+
const LEXICON_JA = `# 使わない言葉(pattern)と、使う言葉(rewrite)。
|
|
58
|
+
- { pattern: 弊社, rewrite: 当社 }
|
|
59
|
+
`;
|
|
60
|
+
const LEXICON_EN = `# The word not to use (pattern) and the word to use (rewrite).
|
|
61
|
+
- { pattern: utilize, rewrite: use }
|
|
62
|
+
`;
|
|
63
|
+
const packageJson = (packageName) => `${JSON.stringify({
|
|
64
|
+
name: packageName,
|
|
65
|
+
version: "0.1.0",
|
|
66
|
+
description: "Rules for chaff, written in YAML.",
|
|
67
|
+
files: ["rules", "lexicons", "styles"],
|
|
68
|
+
chaff: { apiVersion: API_VERSION },
|
|
69
|
+
scripts: { test: "chaffjs plugin-test ." },
|
|
70
|
+
peerDependencies: { chaffjs: `>=${VERSION}` },
|
|
71
|
+
}, null, 2)}\n`;
|
|
72
|
+
const FILES = (packageName) => ({
|
|
73
|
+
"package.json": packageJson(packageName),
|
|
74
|
+
"rules/avoid-words.yaml": RULE,
|
|
75
|
+
"lexicons/ja/avoid-words.yaml": LEXICON_JA,
|
|
76
|
+
"lexicons/en/avoid-words.yaml": LEXICON_EN,
|
|
77
|
+
});
|
|
78
|
+
const TEXT = {
|
|
79
|
+
ja: {
|
|
80
|
+
badName: (written) => `--plugin ${written}: プラグインの名前は英小文字・数字・ハイフンで書きます(house、@team/house)`,
|
|
81
|
+
exists: (folder) => `${folder} はもうあります。上書きしないので、別の名前にするか消してから実行してください`,
|
|
82
|
+
made: (folder, packageName) => `${folder}/ に YAML だけのルールの束 ${packageName} を作りました。`,
|
|
83
|
+
next: (folder, name) => [
|
|
84
|
+
"",
|
|
85
|
+
"次に:",
|
|
86
|
+
` cd ${folder} && npx chaffjs plugin-test . ルールの例をルールにかけて確かめる`,
|
|
87
|
+
` chaff.yaml に plugins: [./${folder}] と書くと、${name}/avoid-words として動きます`,
|
|
88
|
+
"",
|
|
89
|
+
],
|
|
90
|
+
},
|
|
91
|
+
en: {
|
|
92
|
+
badName: (written) => `--plugin ${written}: a plugin's name is lowercase letters, digits and hyphens (house, @team/house)`,
|
|
93
|
+
exists: (folder) => `${folder} already exists. Nothing is overwritten; choose another name or remove it first`,
|
|
94
|
+
made: (folder, packageName) => `Made the YAML rule pack ${packageName} in ${folder}/.`,
|
|
95
|
+
next: (folder, name) => [
|
|
96
|
+
"",
|
|
97
|
+
"Next:",
|
|
98
|
+
` cd ${folder} && npx chaffjs plugin-test . check each rule against its own example`,
|
|
99
|
+
` add plugins: [./${folder}] to chaff.yaml and it runs as ${name}/avoid-words`,
|
|
100
|
+
"",
|
|
101
|
+
],
|
|
102
|
+
},
|
|
103
|
+
};
|
|
104
|
+
/** Makes the pack in dir. Lines to print, and whether it was made; nothing is written when the folder is already there. */
|
|
105
|
+
export const initPlugin = (dir, written, ui) => {
|
|
106
|
+
const text = TEXT[ui];
|
|
107
|
+
const pack = packNameOf(written);
|
|
108
|
+
if (pack === undefined)
|
|
109
|
+
return { ok: false, lines: [text.badName(written ?? "")] };
|
|
110
|
+
const { packageName, folder } = packageOf(pack);
|
|
111
|
+
if (existsSync(join(dir, folder)))
|
|
112
|
+
return { ok: false, lines: [text.exists(folder)] };
|
|
113
|
+
Object.entries(FILES(packageName)).forEach(([path, body]) => {
|
|
114
|
+
mkdirSync(dirname(join(dir, folder, path)), { recursive: true });
|
|
115
|
+
writeFileSync(join(dir, folder, path), body, "utf8");
|
|
116
|
+
});
|
|
117
|
+
const name = pack.scope === undefined ? pack.name : `${pack.scope}/${pack.name}`;
|
|
118
|
+
return {
|
|
119
|
+
ok: true,
|
|
120
|
+
lines: [text.made(folder, packageName), ...Object.keys(FILES(packageName)).map((path) => ` ${folder}/${path}`), ...text.next(folder, name)],
|
|
121
|
+
};
|
|
122
|
+
};
|
|
123
|
+
/** chaff init --plugin <name>: makes the pack in dir and says what it made, or why it did not. */
|
|
124
|
+
export const runInitPlugin = (dir, written, ui) => {
|
|
125
|
+
const made = initPlugin(dir, written, ui);
|
|
126
|
+
made.lines.forEach((line) => (made.ok ? console.log(line) : console.error(line)));
|
|
127
|
+
return made.ok ? 0 : 1;
|
|
128
|
+
};
|
|
129
|
+
//# sourceMappingURL=plugin-init.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plugin-init.js","sourceRoot":"","sources":["../../src/commands/plugin-init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAGxC,wHAAwH;AACxH,oGAAoG;AAEpG,wGAAwG;AACxG,MAAM,SAAS,GAAG,oDAAoD,CAAC;AAIvE,2IAA2I;AAC3I,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,OAA2B,EAAwB,EAAE;IAC9E,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC,CAAC;IACpF,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,SAAS,CAAC;IACrC,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC;IAC9B,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAC1D,CAAC,CAAC;AAEF,8HAA8H;AAC9H,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,IAAc,EAA6D,EAAE,CAAC,CAAC;IACvG,WAAW,EAAE,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,gBAAgB,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,iBAAiB,IAAI,CAAC,IAAI,EAAE;IAC/G,MAAM,EAAE,gBAAgB,IAAI,CAAC,IAAI,EAAE;CACpC,CAAC,CAAC;AAEH,MAAM,IAAI,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkCZ,CAAC;AAEF,MAAM,UAAU,GAAG;;CAElB,CAAC;AAEF,MAAM,UAAU,GAAG;;CAElB,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,WAAmB,EAAU,EAAE,CAClD,GAAG,IAAI,CAAC,SAAS,CACf;IACE,IAAI,EAAE,WAAW;IACjB,OAAO,EAAE,OAAO;IAChB,WAAW,EAAE,mCAAmC;IAChD,KAAK,EAAE,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,CAAC;IACtC,KAAK,EAAE,EAAE,UAAU,EAAE,WAAW,EAAE;IAClC,OAAO,EAAE,EAAE,IAAI,EAAE,uBAAuB,EAAE;IAC1C,gBAAgB,EAAE,EAAE,OAAO,EAAE,KAAK,OAAO,EAAE,EAAE;CAC9C,EACD,IAAI,EACJ,CAAC,CACF,IAAI,CAAC;AAER,MAAM,KAAK,GAAG,CAAC,WAAmB,EAAoC,EAAE,CAAC,CAAC;IACxE,cAAc,EAAE,WAAW,CAAC,WAAW,CAAC;IACxC,wBAAwB,EAAE,IAAI;IAC9B,8BAA8B,EAAE,UAAU;IAC1C,8BAA8B,EAAE,UAAU;CAC3C,CAAC,CAAC;AAEH,MAAM,IAAI,GAKL;IACH,EAAE,EAAE;QACF,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,YAAY,OAAO,iDAAiD;QAC1F,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,MAAM,yCAAyC;QACtE,IAAI,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE,CAAC,GAAG,MAAM,qBAAqB,WAAW,UAAU;QAClF,IAAI,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC;YACtB,EAAE;YACF,KAAK;YACL,QAAQ,MAAM,oDAAoD;YAClE,8BAA8B,MAAM,UAAU,IAAI,sBAAsB;YACxE,EAAE;SACH;KACF;IACD,EAAE,EAAE;QACF,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,YAAY,OAAO,iFAAiF;QAC1H,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,MAAM,iFAAiF;QAC9G,IAAI,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE,CAAC,2BAA2B,WAAW,OAAO,MAAM,IAAI;QACtF,IAAI,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC;YACtB,EAAE;YACF,OAAO;YACP,QAAQ,MAAM,0EAA0E;YACxF,qBAAqB,MAAM,kCAAkC,IAAI,cAAc;YAC/E,EAAE;SACH;KACF;CACF,CAAC;AAEF,2HAA2H;AAC3H,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,OAA2B,EAAE,EAAc,EAA+D,EAAE;IAClJ,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;IACtB,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IACjC,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;IACnF,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAChD,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IACtF,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;QAC1D,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACjE,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;IACjF,OAAO;QACL,EAAE,EAAE,IAAI;QACR,KAAK,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,MAAM,IAAI,IAAI,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;KAC7I,CAAC;AACJ,CAAC,CAAC;AAEF,kGAAkG;AAClG,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,GAAW,EAAE,OAA2B,EAAE,EAAc,EAAU,EAAE;IAChG,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;IAC1C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClF,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACzB,CAAC,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { type Config } from "../config/load.ts";
|
|
2
|
+
import type { UiLanguage } from "../ui.ts";
|
|
3
|
+
import type { Checked } from "./feedback.ts";
|
|
4
|
+
export type PluginTestContext = {
|
|
5
|
+
readonly ui: UiLanguage;
|
|
6
|
+
/** Lints one file with these settings, as chaff on the command line does. */
|
|
7
|
+
readonly check: (path: string, config: Config, argv: readonly string[]) => Promise<Pick<Checked, "findings" | "skipped">>;
|
|
8
|
+
};
|
|
9
|
+
/** Exit 0 when every rule passes on every example; 1 when the plugin cannot be loaded or a rule fails. */
|
|
10
|
+
export declare const runPluginTest: (folder: string | undefined, context: PluginTestContext) => Promise<number>;
|
|
11
|
+
//# sourceMappingURL=plugin-test.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plugin-test.d.ts","sourceRoot":"","sources":["../../src/commands/plugin-test.ts"],"names":[],"mappings":"AAGA,OAAO,EAAS,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAMvD,OAAO,KAAK,EAAS,UAAU,EAAE,MAAM,UAAU,CAAC;AAClD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAM7C,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC;IACxB,6EAA6E;IAC7E,QAAQ,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,MAAM,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC;CAC3H,CAAC;AAkEF,0GAA0G;AAC1G,eAAO,MAAM,aAAa,GAAU,QAAQ,MAAM,GAAG,SAAS,EAAE,SAAS,iBAAiB,KAAG,OAAO,CAAC,MAAM,CAuB1G,CAAC"}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { mkdtempSync, writeFileSync } from "node:fs";
|
|
2
|
+
import { tmpdir } from "node:os";
|
|
3
|
+
import { join, resolve } from "node:path";
|
|
4
|
+
import { EMPTY } from "../config/load.js";
|
|
5
|
+
import { withExtensions } from "../extension/load.js";
|
|
6
|
+
import { extensionProblems } from "../extension/problem-text.js";
|
|
7
|
+
import { loadGenres } from "../genre-load.js";
|
|
8
|
+
const TEXT = {
|
|
9
|
+
ja: {
|
|
10
|
+
noRules: (dir) => `${dir} にルールがありません。`,
|
|
11
|
+
beforeQuiet: "例の before で指摘が出ません",
|
|
12
|
+
afterFlagged: (count) => `例の after で指摘が ${String(count)} 件出ます`,
|
|
13
|
+
notRun: (why) => `動きません(${why})`,
|
|
14
|
+
noExample: "例がありません",
|
|
15
|
+
summary: (passed, total) => `${String(total)} 件のうち ${String(passed)} 件が通りました。`,
|
|
16
|
+
},
|
|
17
|
+
en: {
|
|
18
|
+
noRules: (dir) => `${dir} has no rules.`,
|
|
19
|
+
beforeQuiet: "the example's before gets no finding",
|
|
20
|
+
afterFlagged: (count) => `the example's after gets ${String(count)} ${count === 1 ? "finding" : "findings"}`,
|
|
21
|
+
notRun: (why) => `it does not run (${why})`,
|
|
22
|
+
noExample: "it has no example",
|
|
23
|
+
summary: (passed, total) => `${String(passed)} of ${String(total)} passed.`,
|
|
24
|
+
},
|
|
25
|
+
};
|
|
26
|
+
/** The first genre the rule is for: the example runs where the rule does. */
|
|
27
|
+
const genreFor = (rule) => {
|
|
28
|
+
const genres = loadGenres().genres.map((genre) => genre.id);
|
|
29
|
+
return genres.find((genre) => rule.use_for.some((target) => genre === target || genre.startsWith(`${target}/`))) ?? genres[0] ?? "business/report";
|
|
30
|
+
};
|
|
31
|
+
const skippedWhy = (skipped, rule) => skipped.find((entry) => entry.rule === rule)?.why;
|
|
32
|
+
/** One rule in one language: before flagged, after clean. */
|
|
33
|
+
const testExample = async (rule, language, config, context) => {
|
|
34
|
+
const text = TEXT[context.ui];
|
|
35
|
+
const example = rule.guide?.examples[language];
|
|
36
|
+
if (example === undefined)
|
|
37
|
+
return { rule: rule.id, language, failure: text.noExample };
|
|
38
|
+
const dir = mkdtempSync(join(tmpdir(), "chaff-plugin-test-"));
|
|
39
|
+
const argv = ["--language", language, "--genre", genreFor(rule)];
|
|
40
|
+
const run = async (name, body) => {
|
|
41
|
+
writeFileSync(join(dir, name), `${body.trimEnd()}\n`, "utf8");
|
|
42
|
+
return context.check(join(dir, name), config, argv);
|
|
43
|
+
};
|
|
44
|
+
const before = await run("before.md", example.before);
|
|
45
|
+
const why = skippedWhy(before.skipped, rule.id);
|
|
46
|
+
if (why !== undefined)
|
|
47
|
+
return { rule: rule.id, language, failure: text.notRun(why) };
|
|
48
|
+
if (!before.findings.some((finding) => finding.rule === rule.id))
|
|
49
|
+
return { rule: rule.id, language, failure: text.beforeQuiet };
|
|
50
|
+
const after = (await run("after.md", example.after)).findings.filter((finding) => finding.rule === rule.id).length;
|
|
51
|
+
return { rule: rule.id, language, failure: after === 0 ? undefined : text.afterFlagged(after) };
|
|
52
|
+
};
|
|
53
|
+
const lineOf = (outcome) => outcome.failure === undefined ? ` ✓ ${outcome.rule} (${outcome.language})` : ` ✗ ${outcome.rule} (${outcome.language}): ${outcome.failure}`;
|
|
54
|
+
/** The languages a rule's example is written in, or the rule's languages when it has none, so a missing example is said. */
|
|
55
|
+
const languagesOf = (rule) => {
|
|
56
|
+
const written = Object.keys(rule.guide?.examples ?? {});
|
|
57
|
+
return written.length > 0 ? written : (rule.languages ?? ["ja", "en"]);
|
|
58
|
+
};
|
|
59
|
+
/** Exit 0 when every rule passes on every example; 1 when the plugin cannot be loaded or a rule fails. */
|
|
60
|
+
export const runPluginTest = async (folder, context) => {
|
|
61
|
+
const text = TEXT[context.ui];
|
|
62
|
+
const dir = resolve(folder ?? ".");
|
|
63
|
+
const config = await withExtensions({ ...EMPTY, plugins: [dir], baseDir: dir, path: dir });
|
|
64
|
+
const problems = extensionProblems(config, context.ui);
|
|
65
|
+
if (problems.length > 0) {
|
|
66
|
+
problems.forEach((problem) => console.error(problem));
|
|
67
|
+
return 1;
|
|
68
|
+
}
|
|
69
|
+
const rules = config.extensions?.rules ?? [];
|
|
70
|
+
if (rules.length === 0) {
|
|
71
|
+
console.error(text.noRules(dir));
|
|
72
|
+
return 1;
|
|
73
|
+
}
|
|
74
|
+
const cases = rules.flatMap((rule) => languagesOf(rule).map((language) => ({ rule, language })));
|
|
75
|
+
const outcomes = await cases.reduce(async (done, entry) => [...(await done), await testExample(entry.rule, entry.language, config, context)], Promise.resolve([]));
|
|
76
|
+
outcomes.map(lineOf).forEach((line) => console.log(line));
|
|
77
|
+
const passed = outcomes.filter((outcome) => outcome.failure === undefined).length;
|
|
78
|
+
console.log(`\n${text.summary(passed, outcomes.length)}`);
|
|
79
|
+
return passed === outcomes.length ? 0 : 1;
|
|
80
|
+
};
|
|
81
|
+
//# sourceMappingURL=plugin-test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plugin-test.js","sourceRoot":"","sources":["../../src/commands/plugin-test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAe,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAkB9C,MAAM,IAAI,GAOL;IACH,EAAE,EAAE;QACF,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,cAAc;QACtC,WAAW,EAAE,oBAAoB;QACjC,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,iBAAiB,MAAM,CAAC,KAAK,CAAC,OAAO;QAC9D,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,GAAG,GAAG;QAChC,SAAS,EAAE,SAAS;QACpB,OAAO,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,WAAW;KAC/E;IACD,EAAE,EAAE;QACF,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,gBAAgB;QACxC,WAAW,EAAE,sCAAsC;QACnD,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,4BAA4B,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,EAAE;QAC5G,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,oBAAoB,GAAG,GAAG;QAC3C,SAAS,EAAE,mBAAmB;QAC9B,OAAO,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,MAAM,CAAC,KAAK,CAAC,UAAU;KAC5E;CACF,CAAC;AAEF,6EAA6E;AAC7E,MAAM,QAAQ,GAAG,CAAC,IAAoB,EAAU,EAAE;IAChD,MAAM,MAAM,GAAG,UAAU,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC5D,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,KAAK,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC;AACrJ,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,OAA2B,EAAE,IAAY,EAAsB,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,GAAG,CAAC;AAExI,6DAA6D;AAC7D,MAAM,WAAW,GAAG,KAAK,EAAE,IAAoB,EAAE,QAAgB,EAAE,MAAc,EAAE,OAA0B,EAAoB,EAAE;IACjI,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC/C,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;IACvF,MAAM,GAAG,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAC9D,MAAM,IAAI,GAAG,CAAC,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IACjE,MAAM,GAAG,GAAG,KAAK,EAAE,IAAY,EAAE,IAAY,EAAkD,EAAE;QAC/F,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9D,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACtD,CAAC,CAAC;IACF,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACtD,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;IAChD,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;IACrF,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;IAChI,MAAM,KAAK,GAAG,CAAC,MAAM,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC;IACnH,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;AAClG,CAAC,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,OAAgB,EAAU,EAAE,CAC1C,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,OAAO,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,QAAQ,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;AAEhJ,4HAA4H;AAC5H,MAAM,WAAW,GAAG,CAAC,IAAoB,EAAqB,EAAE;IAC9D,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAC;IACxD,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AACzE,CAAC,CAAC;AAEF,0GAA0G;AAC1G,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAAE,MAA0B,EAAE,OAA0B,EAAmB,EAAE;IAC7G,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC9B,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC;IACnC,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;IAC3F,MAAM,QAAQ,GAAG,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;IACvD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACtD,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC;IAC7C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QACjC,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;IACjG,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,CACjC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,EAAE,MAAM,WAAW,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,EACxG,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CACpB,CAAC;IACF,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,MAAM,CAAC;IAClF,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC1D,OAAO,MAAM,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5C,CAAC,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { Config } from "../config/load.ts";
|
|
2
|
+
export type RulesContext = {
|
|
3
|
+
readonly flag: (argv: readonly string[], name: string) => string | undefined;
|
|
4
|
+
/** Says once, on stderr, what in the settings has no effect. */
|
|
5
|
+
readonly warn: (config: Config, language: string) => void;
|
|
6
|
+
};
|
|
7
|
+
/** `rules --json` for an AI to read, with the guide of a genre that was set; `rules` alone, a table for a person. */
|
|
8
|
+
export declare const showRules: (argv: readonly string[], written: Config, context: RulesContext) => number;
|
|
9
|
+
//# sourceMappingURL=rules.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rules.d.ts","sourceRoot":"","sources":["../../src/commands/rules.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAWhD,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;IAC7E,gEAAgE;IAChE,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;CAC3D,CAAC;AAEF,qHAAqH;AACrH,eAAO,MAAM,SAAS,GAAI,MAAM,SAAS,MAAM,EAAE,EAAE,SAAS,MAAM,EAAE,SAAS,YAAY,KAAG,MAc3F,CAAC"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { showsGuide, withExperimental } from "../cli-args.js";
|
|
2
|
+
import { optionLayersOf } from "../config/option-problems.js";
|
|
3
|
+
import { rulesOf } from "../custom/load.js";
|
|
4
|
+
import { reportedGuide } from "../genre-guide/report.js";
|
|
5
|
+
import { rulesJson } from "../render/rules-json.js";
|
|
6
|
+
import { rulesTable } from "../render/rules-table.js";
|
|
7
|
+
import { hostLanguage } from "../ui.js";
|
|
8
|
+
/** The genre the rules are shown for when none is set. */
|
|
9
|
+
const SHOWN_GENRE = "blog/tech";
|
|
10
|
+
/** `rules --json` for an AI to read, with the guide of a genre that was set; `rules` alone, a table for a person. */
|
|
11
|
+
export const showRules = (argv, written, context) => {
|
|
12
|
+
const config = withExperimental(written, argv);
|
|
13
|
+
const language = config.language ?? hostLanguage(undefined, process.env);
|
|
14
|
+
context.warn(config, language);
|
|
15
|
+
const setGenre = context.flag(argv, "--genre") ?? config.genre;
|
|
16
|
+
const genre = setGenre ?? SHOWN_GENRE;
|
|
17
|
+
const rules = rulesOf(language, config);
|
|
18
|
+
if (!argv.includes("--json")) {
|
|
19
|
+
console.log(rulesTable(rules, config, language, genre));
|
|
20
|
+
return 0;
|
|
21
|
+
}
|
|
22
|
+
const guide = setGenre !== undefined && showsGuide(argv) ? reportedGuide(config, genre, language, rules) : undefined;
|
|
23
|
+
console.log(rulesJson(rules, config, language, genre, optionLayersOf(config), guide));
|
|
24
|
+
return 0;
|
|
25
|
+
};
|
|
26
|
+
//# sourceMappingURL=rules.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rules.js","sourceRoot":"","sources":["../../src/commands/rules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAE9D,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAExC,0DAA0D;AAC1D,MAAM,WAAW,GAAG,WAAW,CAAC;AAQhC,qHAAqH;AACrH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,IAAuB,EAAE,OAAe,EAAE,OAAqB,EAAU,EAAE;IACnG,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC/C,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACzE,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC/B,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC;IAC/D,MAAM,KAAK,GAAG,QAAQ,IAAI,WAAW,CAAC;IACtC,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACxC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;QACxD,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,KAAK,GAAG,QAAQ,KAAK,SAAS,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACrH,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,cAAc,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IACtF,OAAO,CAAC,CAAC;AACX,CAAC,CAAC"}
|
package/dist/config/load.d.ts
CHANGED
|
@@ -3,6 +3,7 @@ import type { Level } from "../plugin.ts";
|
|
|
3
3
|
import type { PathRule } from "./by-path.ts";
|
|
4
4
|
import type { Extensions } from "../extension/load.ts";
|
|
5
5
|
import type { StyleLimits } from "../style-parse.ts";
|
|
6
|
+
import type { GuideLayer } from "../genre-guide/layer.ts";
|
|
6
7
|
export declare const CONFIG_FILE = "chaff.yaml";
|
|
7
8
|
export type Config = {
|
|
8
9
|
readonly genre: string | undefined;
|
|
@@ -43,7 +44,7 @@ export type Config = {
|
|
|
43
44
|
readonly unreadableOptions?: string | undefined;
|
|
44
45
|
/** The house style chaff.yaml names (styles/*.yaml), as written. A value that is not a name is kept printed, to be reported. */
|
|
45
46
|
readonly style?: string | undefined;
|
|
46
|
-
/** The style once applied (config/style.ts): its id, the rules whose level it decided, and its
|
|
47
|
+
/** The style once applied (config/style.ts): its id, the rules whose level it decided, its options and its guide. */
|
|
47
48
|
readonly applied?: AppliedStyle | undefined;
|
|
48
49
|
/** custom_rules as written: the team's own rules. custom/parse.ts reads and checks them. */
|
|
49
50
|
readonly customRules?: unknown;
|
|
@@ -51,6 +52,8 @@ export type Config = {
|
|
|
51
52
|
readonly grade?: unknown;
|
|
52
53
|
/** fix_plan as written: the depth chaff fix-plan rewrites to (fix-plan/chosen-depth.ts reads and checks it). */
|
|
53
54
|
readonly fixPlan?: unknown;
|
|
55
|
+
/** guide as written: the team's changes to the genre guides, or off (genre-guide/of-config.ts reads it). */
|
|
56
|
+
readonly guide?: unknown;
|
|
54
57
|
/** plugins as written: package names and paths. extension/plugin-load.ts reads and checks them. */
|
|
55
58
|
readonly plugins?: unknown;
|
|
56
59
|
/** The code chaff.yaml names, once loaded (extension/load.ts). Reading chaff.yaml does not load it. */
|
|
@@ -62,6 +65,8 @@ export type AppliedStyle = {
|
|
|
62
65
|
readonly options: Readonly<Record<string, unknown>>;
|
|
63
66
|
/** The style's numbers, by rule and language, for the rules whose level it decided. */
|
|
64
67
|
readonly limits: StyleLimits;
|
|
68
|
+
/** The style's changes to the genre guides, when it has any. */
|
|
69
|
+
readonly guide?: GuideLayer | undefined;
|
|
65
70
|
};
|
|
66
71
|
export declare const EMPTY: Config;
|
|
67
72
|
/** 設定ファイルが無くても動く。あっても、既定から変えたものだけが書かれている。spec §18。 */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../../src/config/load.ts"],"names":[],"mappings":"AAIA,OAAO,EAAa,KAAK,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../../src/config/load.ts"],"names":[],"mappings":"AAIA,OAAO,EAAa,KAAK,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D,eAAO,MAAM,WAAW,eAAe,CAAC;AAExC,MAAM,MAAM,MAAM,GAAG;IACnB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,oDAAoD;IACpD,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;IAChC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IAChD,2EAA2E;IAC3E,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAClD,0DAA0D;IAC1D,QAAQ,CAAC,eAAe,EAAE,SAAS;QAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACrF,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACrC,qCAAqC;IACrC,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,sDAAsD;IACtD,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAClD,mCAAmC;IACnC,QAAQ,CAAC,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAC;IAC7C,sDAAsD;IACtD,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,mEAAmE;IACnE,QAAQ,CAAC,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5C,iGAAiG;IACjG,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC,sCAAsC;IACtC,QAAQ,CAAC,MAAM,EAAE,SAAS,QAAQ,EAAE,CAAC;IACrC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,sIAAsI;IACtI,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACrD,mHAAmH;IACnH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChD,gIAAgI;IAChI,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,qHAAqH;IACrH,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAC5C,4FAA4F;IAC5F,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,0EAA0E;IAC1E,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB,gHAAgH;IAChH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,4GAA4G;IAC5G,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB,mGAAmG;IACnG,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,uGAAuG;IACvG,QAAQ,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACpD,uFAAuF;IACvF,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,gEAAgE;IAChE,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;CACzC,CAAC;AAMF,eAAO,MAAM,KAAK,EAAE,MAmBnB,CAAC;AA2EF,sDAAsD;AACtD,eAAO,MAAM,UAAU,GAAI,MAAM,MAAM,KAAG,MAoCzC,CAAC"}
|
package/dist/config/load.js
CHANGED
package/dist/config/load.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"load.js","sourceRoot":"","sources":["../../src/config/load.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAoB,MAAM,sBAAsB,CAAC;
|
|
1
|
+
{"version":3,"file":"load.js","sourceRoot":"","sources":["../../src/config/load.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAoB,MAAM,sBAAsB,CAAC;AAOnE,MAAM,CAAC,MAAM,WAAW,GAAG,YAAY,CAAC;AAgExC,yDAAyD;AACzD,2DAA2D;AAC3D,MAAM,eAAe,GAAgB,WAAW,CAAC;AAEjD,MAAM,CAAC,MAAM,KAAK,GAAW;IAC3B,KAAK,EAAE,SAAS;IAChB,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,SAAS;IACnB,KAAK,EAAE,EAAE;IACT,MAAM,EAAE,EAAE;IACV,eAAe,EAAE,EAAE;IACnB,YAAY,EAAE,KAAK;IACnB,IAAI,EAAE,SAAS;IACf,SAAS,EAAE,eAAe;IAC1B,OAAO,EAAE,YAAY,CAAC,eAAe,CAAC;IACtC,mBAAmB,EAAE,GAAG;IACxB,MAAM,EAAE,EAAE;IACV,MAAM,EAAE,EAAE;IACV,gBAAgB,EAAE,EAAE;IACpB,KAAK,EAAE,EAAE;IACT,eAAe,EAAE,EAAE;IACnB,MAAM,EAAE,EAAE;IACV,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE;CACvB,CAAC;AAEF,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,OAAO,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC;AAEtH,6DAA6D;AAC7D,MAAM,OAAO,GAAG,CAAC,GAAY,EAAyB,EAAE;IACtD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,EAAE,CAAC;IAC9B,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,EAAqB,EAAE;QAC7D,IAAI,OAAO,CAAC,KAAK,CAAC;YAAE,OAAO,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QACzC,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAChD,CAAC,CAAC,CACH,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,GAAY,EAA0B,EAAE,CACxD,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,EAAsB,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAEnJ,MAAM,YAAY,GAAG,CAAC,GAAY,EAAmC,EAAE,CACrE,QAAQ,CAAC,GAAG,CAAC;IACX,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;SAChB,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SACzD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAClF,CAAC,CAAC,EAAE,CAAC;AAET,MAAM,GAAG,GAAG,CAAC,KAAc,EAAsB,EAAE,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAEpG,gCAAgC;AAChC,MAAM,OAAO,GAAG,CAAC,KAAc,EAAY,EAAE;IAC3C,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IAC9C,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACzE,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,GAAY,EAAwB,EAAE;IACxD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IACrC,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC;IAC3B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAC7B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACzC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;AAClH,CAAC,CAAC;AAEF,8BAA8B;AAC9B,MAAM,OAAO,GAAG,CAAC,GAAY,EAAY,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AAErJ,yDAAyD;AACzD,MAAM,QAAQ,GAAG,CAAC,GAAY,EAA0B,EAAE,CACxD,QAAQ,CAAC,GAAG,CAAC;IACX,CAAC,CAAC,MAAM,CAAC,WAAW,CAChB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,EAAsB,EAAE;QAC/D,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAC1B,MAAM,EAAE,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrD,OAAO,IAAI,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACrE,CAAC,CAAC,CACH;IACH,CAAC,CAAC,EAAE,CAAC;AAET,MAAM,WAAW,GAAG,CAAC,KAAc,EAA4B,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AAEzH,MAAM,OAAO,GAAG,CAAC,KAAc,EAAU,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;AAEnF,iEAAiE;AACjE,MAAM,OAAO,GAAG,CAAC,GAAY,EAA+D,EAAE;IAC5F,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;IAC5E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;IAC1E,MAAM,OAAO,GAAc,GAAG,CAAC;IAC/B,OAAO;QACL,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC3C,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC;KACxE,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,GAAY,EAAc,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AAEpI,sDAAsD;AACtD,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAY,EAAU,EAAE;IACjD,MAAM,GAAG,GAAY,YAAY,CAAC,IAAI,CAAC,CAAC;IACxC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,CAAC;IAC9C,MAAM,QAAQ,GAAY,GAAG,CAAC,YAAY,CAAC,CAAC;IAC5C,MAAM,OAAO,GAAgB,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC;IAC9E,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;IACpC,MAAM,OAAO,GAAY,GAAG,CAAC,SAAS,CAAC,CAAC;IACxC,OAAO;QACL,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACxB,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC5B,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC9B,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC5B,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC9B,eAAe,EAAE,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC3C,YAAY,EAAE,GAAG,CAAC,cAAc,CAAC,KAAK,IAAI;QAC1C,IAAI;QACJ,SAAS,EAAE,OAAO;QAClB,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,YAAY,CAAC,OAAO,CAAC;QACtD,mBAAmB,EAAE,OAAO,GAAG,CAAC,sBAAsB,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAAG;QACxG,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9B,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC/B,gBAAgB,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QACnD,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,eAAe,EAAE,KAAK,CAAC,UAAU;QACjC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC;QACtB,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;QACzC,iBAAiB,EAAE,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,IAAI,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;QAChH,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,SAAS,IAAI,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;QACrH,WAAW,EAAE,GAAG,CAAC,cAAc,CAAC;QAChC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC;QACnB,OAAO,EAAE,GAAG,CAAC,UAAU,CAAC;QACxB,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC;QACnB,OAAO,EAAE,GAAG,CAAC,SAAS,CAAC;KACxB,CAAC;AACJ,CAAC,CAAC"}
|
package/dist/config/style.js
CHANGED
|
@@ -16,7 +16,7 @@ export const withStyle = (config, styles) => {
|
|
|
16
16
|
return {
|
|
17
17
|
...config,
|
|
18
18
|
rules: { ...style.rules, ...config.rules },
|
|
19
|
-
applied: { style: style.id, levelsFrom: fromStyle, options: style.options, limits },
|
|
19
|
+
applied: { style: style.id, levelsFrom: fromStyle, options: style.options, limits, guide: style.guide },
|
|
20
20
|
};
|
|
21
21
|
};
|
|
22
22
|
/**
|
package/dist/config/style.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"style.js","sourceRoot":"","sources":["../../src/config/style.ts"],"names":[],"mappings":"AAIA,sFAAsF;AACtF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,EAAU,EAAU,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC;AAElE,qHAAqH;AACrH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAA+B,EAAE,MAAc,EAAsB,EAAE,CACtG,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAEvG;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,MAAc,EAAE,MAAkC,EAAU,EAAE;IACtF,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,MAAM,CAAC,KAAK,CAAC,CAAC;IAChE,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IACvC,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC;IAC7H,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACzG,OAAO;QACL,GAAG,MAAM;QACT,KAAK,EAAE,EAAE,GAAG,KAAK,CAAC,KAAK,EAAE,GAAG,MAAM,CAAC,KAAK,EAAE;QAC1C,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE;
|
|
1
|
+
{"version":3,"file":"style.js","sourceRoot":"","sources":["../../src/config/style.ts"],"names":[],"mappings":"AAIA,sFAAsF;AACtF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,EAAU,EAAU,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC;AAElE,qHAAqH;AACrH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAA+B,EAAE,MAAc,EAAsB,EAAE,CACtG,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAEvG;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,MAAc,EAAE,MAAkC,EAAU,EAAE;IACtF,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,MAAM,CAAC,KAAK,CAAC,CAAC;IAChE,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IACvC,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC;IAC7H,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACzG,OAAO;QACL,GAAG,MAAM;QACT,KAAK,EAAE,EAAE,GAAG,KAAK,CAAC,KAAK,EAAE,GAAG,MAAM,CAAC,KAAK,EAAE;QAC1C,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE;KACxG,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,MAA0C,EAAE,QAAgB,EAAoC,EAAE;IAC1H,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,UAAU,CAAC,EAAsB,EAAE;QAC9G,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;QACnC,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IACH,OAAO,EAAE,GAAG,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;AAChE,CAAC,CAAC;AAEF,MAAM,IAAI,GAAyF;IACjG,EAAE,EAAE;QACF,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,YAAY,KAAK,wBAAwB,KAAK,KAAK;KAC9F;IACD,EAAE,EAAE;QACF,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,6BAA6B,KAAK,oBAAoB,KAAK,EAAE;KACxG;CACF,CAAC;AAEF,gIAAgI;AAChI,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAsC,EAAE,MAAkC,EAAE,EAAc,EAAY,EAAE;IACpI,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,IAAI,OAAO,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,OAAO,CAAC;QAAE,OAAO,EAAE,CAAC;IACrF,OAAO,CAAC,UAAU,IAAI,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,IAAI,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;AAC1H,CAAC,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { Config } from "./load.ts";
|
|
2
2
|
import type { RuleDefinition } from "../plugin.ts";
|
|
3
3
|
import type { UiLanguage } from "../ui.ts";
|
|
4
|
-
/** Everything in chaff.yaml that has no effect: unknown rules or levels, unreadable names, options that do not apply. Said before the results. */
|
|
4
|
+
/** Everything in chaff.yaml that has no effect: unknown rules or levels, unreadable names, options that do not apply, guides that cannot be read. Said before the results. */
|
|
5
5
|
export declare const settingWarnings: (config: Config, rules: readonly RuleDefinition[], ui: UiLanguage) => string[];
|
|
6
6
|
//# sourceMappingURL=warnings.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"warnings.d.ts","sourceRoot":"","sources":["../../src/config/warnings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"warnings.d.ts","sourceRoot":"","sources":["../../src/config/warnings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAM3C,8KAA8K;AAC9K,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,EAAE,OAAO,SAAS,cAAc,EAAE,EAAE,IAAI,UAAU,KAAG,MAAM,EAKxG,CAAC"}
|
package/dist/config/warnings.js
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { ruleProblems } from "./rule-problems.js";
|
|
2
2
|
import { nameProblems } from "./name-problems.js";
|
|
3
3
|
import { configOptionProblems } from "./option-problems.js";
|
|
4
|
-
|
|
4
|
+
import { configGuideProblems } from "../genre-guide/of-config.js";
|
|
5
|
+
/** Everything in chaff.yaml that has no effect: unknown rules or levels, unreadable names, options that do not apply, guides that cannot be read. Said before the results. */
|
|
5
6
|
export const settingWarnings = (config, rules, ui) => [
|
|
6
7
|
...ruleProblems(config, rules, ui),
|
|
7
8
|
...nameProblems(config, ui),
|
|
8
9
|
...configOptionProblems(config, rules, ui),
|
|
10
|
+
...configGuideProblems(config, ui),
|
|
9
11
|
];
|
|
10
12
|
//# sourceMappingURL=warnings.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"warnings.js","sourceRoot":"","sources":["../../src/config/warnings.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;
|
|
1
|
+
{"version":3,"file":"warnings.js","sourceRoot":"","sources":["../../src/config/warnings.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE,8KAA8K;AAC9K,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,KAAgC,EAAE,EAAc,EAAY,EAAE,CAAC;IAC7G,GAAG,YAAY,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;IAClC,GAAG,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC;IAC3B,GAAG,oBAAoB,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;IAC1C,GAAG,mBAAmB,CAAC,MAAM,EAAE,EAAE,CAAC;CACnC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"problems.d.ts","sourceRoot":"","sources":["../../src/custom/problems.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAS,UAAU,EAAE,MAAM,UAAU,CAAC;AAClD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"problems.d.ts","sourceRoot":"","sources":["../../src/custom/problems.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAS,UAAU,EAAE,MAAM,UAAU,CAAC;AAClD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAiHhD,yGAAyG;AACzG,eAAO,MAAM,qBAAqB,GAAI,SAAS,aAAa,EAAE,IAAI,UAAU,EAAE,cAAsB,KAAG,MAItG,CAAC;AAEF,iIAAiI;AACjI,eAAO,MAAM,kBAAkB,GAAI,QAAQ,IAAI,CAAC,MAAM,EAAE,aAAa,GAAG,MAAM,GAAG,SAAS,CAAC,EAAE,IAAI,UAAU,KAAG,MAAM,EACa,CAAC"}
|
package/dist/custom/problems.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { customRulesOf } from "./load.js";
|
|
2
2
|
import { MAX_PATTERN_LENGTH, MAX_REPEATS } from "./regex-safety.js";
|
|
3
3
|
import { POS_WRITTEN_NAMES } from "./token-pattern.js";
|
|
4
|
-
import { fieldProblemSentence } from "../rule-fields.js";
|
|
4
|
+
import { FIELD_KINDS, fieldProblemSentence } from "../rule-fields.js";
|
|
5
5
|
const TEXT = {
|
|
6
6
|
ja: {
|
|
7
7
|
modulePath: {
|
|
@@ -92,7 +92,6 @@ const valuesOf = (problem, text, scope) => ({
|
|
|
92
92
|
refusal: refusalOf(problem, text),
|
|
93
93
|
names: POS_WRITTEN_NAMES.join(" / "),
|
|
94
94
|
});
|
|
95
|
-
const FIELD_KINDS = new Set(["bad-depth", "bad-group", "bad-use-for", "bad-summary", "bad-example"]);
|
|
96
95
|
const isFieldProblem = (problem) => FIELD_KINDS.has(problem.kind);
|
|
97
96
|
/** One problem as a sentence. scope names the list the rule is in: custom_rules, or a plugin's rules. */
|
|
98
97
|
export const customProblemSentence = (problem, ui, scope = "custom_rules") => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"problems.js","sourceRoot":"","sources":["../../src/custom/problems.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAqB,MAAM,mBAAmB,CAAC;AACvF,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAEvD,OAAO,EAAE,oBAAoB,EAAqC,MAAM,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"problems.js","sourceRoot":"","sources":["../../src/custom/problems.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAqB,MAAM,mBAAmB,CAAC;AACvF,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAEvD,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAqC,MAAM,mBAAmB,CAAC;AAWzG,MAAM,IAAI,GAAgB;IACxB,EAAE,EAAE;QACF,UAAU,EAAE;YACV,OAAO,EAAE,8DAA8D;SACxE;QACD,OAAO,EAAE;YACP,UAAU,EAAE,GAAG,MAAM,CAAC,kBAAkB,CAAC,4BAA4B;YACrE,mBAAmB,EAAE,kDAAkD;YACvE,kBAAkB,EAAE,gCAAgC,MAAM,CAAC,WAAW,CAAC,8BAA8B;YACrG,aAAa,EAAE,sCAAsC;YACrD,aAAa,EAAE,+BAA+B;YAC9C,OAAO,EAAE,cAAc;SACxB;QACD,QAAQ,EAAE;YACR,YAAY,EAAE,kCAAkC;YAChD,WAAW,EAAE,2CAA2C;YACxD,QAAQ,EAAE,kEAAkE;YAC5E,cAAc,EAAE,qCAAqC;YACrD,aAAa,EAAE,mDAAmD;YAClE,cAAc,EAAE,2EAA2E;YAC3F,YAAY,EAAE,oDAAoD;YAClE,cAAc,EAAE,gEAAgE;YAChF,eAAe,EAAE,sDAAsD;YACvE,OAAO,EAAE,gCAAgC;YACzC,kBAAkB,EAAE,kEAAkE;YACtF,WAAW,EAAE,iEAAiE;YAC9E,eAAe,EAAE,2DAA2D;YAC5E,UAAU,EAAE,uDAAuD;YACnE,WAAW,EAAE,4DAA4D;YACzE,WAAW,EAAE,iEAAiE;YAC9E,aAAa,EAAE,8CAA8C;YAC7D,aAAa,EAAE,0CAA0C;YACzD,kBAAkB,EAAE,uDAAuD;YAC3E,YAAY,EACV,sIAAsI;SACzI;QACD,OAAO,EAAE,kBAAkB;KAC5B;IACD,EAAE,EAAE;QACF,UAAU,EAAE;YACV,OAAO,EAAE,wHAAwH;SAClI;QACD,OAAO,EAAE;YACP,UAAU,EAAE,qBAAqB,MAAM,CAAC,kBAAkB,CAAC,0CAA0C;YACrG,mBAAmB,EAAE,kGAAkG;YACvH,kBAAkB,EAAE,oBAAoB,MAAM,CAAC,WAAW,CAAC,qFAAqF;YAChJ,aAAa,EAAE,qFAAqF;YACpG,aAAa,EAAE,+DAA+D;YAC9E,OAAO,EAAE,gCAAgC;SAC1C;QACD,QAAQ,EAAE;YACR,YAAY,EAAE,4CAA4C;YAC1D,WAAW,EAAE,4DAA4D;YACzE,QAAQ,EAAE,qHAAqH;YAC/H,cAAc,EAAE,4CAA4C;YAC5D,aAAa,EAAE,6DAA6D;YAC5E,cAAc,EAAE,iFAAiF;YACjG,YAAY,EAAE,2DAA2D;YACzE,cAAc,EAAE,sEAAsE;YACtF,eAAe,EAAE,2EAA2E;YAC5F,OAAO,EAAE,kCAAkC;YAC3C,kBAAkB,EAAE,0FAA0F;YAC9G,WAAW,EAAE,qEAAqE;YAClF,eAAe,EAAE,4DAA4D;YAC7E,UAAU,EAAE,gEAAgE;YAC5E,WAAW,EAAE,oEAAoE;YACjF,WAAW,EAAE,+DAA+D;YAC5E,aAAa,EAAE,0DAA0D;YACzE,aAAa,EAAE,qDAAqD;YACpE,kBAAkB,EAAE,mDAAmD;YACvE,YAAY,EACV,iMAAiM;SACpM;QACD,OAAO,EAAE,gBAAgB;KAC1B;CACF,CAAC;AAEF,MAAM,WAAW,GAAG,oDAAoD,CAAC;AAEzE,MAAM,SAAS,GAAG,CAAC,OAAsB,EAAE,IAAU,EAAU,EAAE;IAC/D,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa;QAAE,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACzE,OAAO,OAAO,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC/E,CAAC,CAAC;AAEF,kFAAkF;AAClF,MAAM,QAAQ,GAAG,CAAC,OAAsB,EAAE,IAAU,EAAE,KAAa,EAAoC,EAAE,CAAC,CAAC;IACzG,KAAK;IACL,EAAE,EAAE,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;IACrC,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;IACpD,KAAK,EAAE,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;IAC9C,KAAK,EAAE,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;IACtD,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC;IACjC,KAAK,EAAE,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC;CACrC,CAAC,CAAC;AAEH,MAAM,cAAc,GAAG,CAAC,OAAsB,EAAqD,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEpI,yGAAyG;AACzG,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAAsB,EAAE,EAAc,EAAE,KAAK,GAAG,cAAc,EAAU,EAAE;IAC9G,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IAClD,MAAM,IAAI,GAAG,CAAC,QAAgB,EAAU,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,MAAM,EAAE,GAAW,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IACrH,OAAO,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,oBAAoB,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3I,CAAC,CAAC;AAEF,iIAAiI;AACjI,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,MAAwD,EAAE,EAAc,EAAY,EAAE,CACvH,aAAa,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,MAAM,CAAC,IAAI,IAAI,YAAY,KAAK,qBAAqB,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { Detector, Lexicon, Token } from "../plugin.ts";
|
|
2
|
+
/**
|
|
3
|
+
* 量を言う語を、数えられる名詞の複数に付けた所(less errors、less customer complaints)。語は語彙表 amount-quantifier が言う。
|
|
4
|
+
* 前が名詞か数なら「引く」の less(revenue less costs、$500 less fees)なので読まない。
|
|
5
|
+
*/
|
|
6
|
+
export type AmountLists = {
|
|
7
|
+
/** 量を言う語(less)と、数を言う語(fewer, rewrite)。 */
|
|
8
|
+
readonly quantifiers: Lexicon;
|
|
9
|
+
/** 複数の形でも数えない名詞。単数と複数が同じ綴りの語(series)と、金額を言う複数(earnings)。 */
|
|
10
|
+
readonly uncounted: ReadonlySet<string>;
|
|
11
|
+
/** 名詞にならない be / have の形。名詞句がそこで終わる。 */
|
|
12
|
+
readonly finite: ReadonlySet<string>;
|
|
13
|
+
};
|
|
14
|
+
export type AmountSlip = {
|
|
15
|
+
readonly quantifier: Token;
|
|
16
|
+
readonly noun: Token;
|
|
17
|
+
readonly rewrite: string;
|
|
18
|
+
};
|
|
19
|
+
export declare const amountSlipsIn: (source: string, tokens: readonly Token[], lists: AmountLists) => AmountSlip[];
|
|
20
|
+
export declare const amountForCount: Detector;
|
|
21
|
+
//# sourceMappingURL=amount-for-count.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"amount-for-count.d.ts","sourceRoot":"","sources":["../../src/detectors/amount-for-count.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAW,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAItE;;;GAGG;AAEH,MAAM,MAAM,WAAW,GAAG;IACxB,0CAA0C;IAC1C,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAC9B,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IACxC,uCAAuC;IACvC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IAAE,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AA0CxG,eAAO,MAAM,aAAa,GAAI,QAAQ,MAAM,EAAE,QAAQ,SAAS,KAAK,EAAE,EAAE,OAAO,WAAW,KAAG,UAAU,EACnC,CAAC;AAarE,eAAO,MAAM,cAAc,EAAE,QAe5B,CAAC"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { endsNounPhrase } from "./agreement-slip.js";
|
|
2
|
+
import { isPartOfLongerWord } from "./doubled-word.js";
|
|
3
|
+
const UPPER_START = /^\p{Lu}/u;
|
|
4
|
+
/** 前に立てば、量の語が限定詞として読める品詞。名詞・数・記号の後ろは「引く」の less。 */
|
|
5
|
+
const OPENS_PHRASE = new Set(["VERB", "AUX", "ADP", "CCONJ", "SCONJ", "ADV", "PART"]);
|
|
6
|
+
const OPENING_MARK = new Set(["(", "[", "{", '"', "'", "“", "‘"]);
|
|
7
|
+
const lower = (token) => token.surface.toLowerCase();
|
|
8
|
+
/** 解析器は三人称の動詞を複数の名詞と読むことがある(The parser reports less errors の reports)。 */
|
|
9
|
+
const mayBeVerb = (token) => token.pos === "NOUN" && token.features?.["AlsoVerb"] === "Yes" && token.features["Number"] === "Plur";
|
|
10
|
+
const opensPhrase = (previous) => previous === undefined || OPENS_PHRASE.has(previous.pos) || OPENING_MARK.has(previous.surface) || mayBeVerb(previous);
|
|
11
|
+
const isCommonNoun = (token) => token?.pos === "NOUN" && token.features?.["Guess"] !== "Yes" && !UPPER_START.test(token.surface);
|
|
12
|
+
const isPlural = (token) => token.features?.["Number"] === "Plur";
|
|
13
|
+
/** 複数の形がはっきりした、数えられる普通名詞。形から当てた語(stimuli)と、数えない語は読まない。 */
|
|
14
|
+
const isCountedPlural = (noun, uncounted) => isCommonNoun(noun) && isPlural(noun) && !uncounted.has(lower(noun));
|
|
15
|
+
/** less の後ろの名詞の頭。単数の名詞を一つ重ねた語(less customer complaints)は、その後ろの語。 */
|
|
16
|
+
const headAt = (tokens, at) => {
|
|
17
|
+
const next = tokens[at + 1];
|
|
18
|
+
return isCommonNoun(next) && !isPlural(next) ? at + 2 : at + 1;
|
|
19
|
+
};
|
|
20
|
+
const slipAt = (source, tokens, at, lists) => {
|
|
21
|
+
const quantifier = tokens[at];
|
|
22
|
+
const entry = quantifier === undefined ? undefined : lists.quantifiers.find((candidate) => candidate.pattern.toLowerCase() === lower(quantifier));
|
|
23
|
+
if (quantifier?.pos !== "ADJ" || entry === undefined || !opensPhrase(tokens[at - 1]))
|
|
24
|
+
return undefined;
|
|
25
|
+
const head = headAt(tokens, at);
|
|
26
|
+
const noun = tokens[head];
|
|
27
|
+
if (!isCountedPlural(noun, lists.uncounted) || !endsNounPhrase(tokens[head + 1], lists.finite) || isPartOfLongerWord(source, quantifier, noun))
|
|
28
|
+
return undefined;
|
|
29
|
+
return { quantifier, noun, rewrite: entry.rewrite ?? "" };
|
|
30
|
+
};
|
|
31
|
+
export const amountSlipsIn = (source, tokens, lists) => tokens.flatMap((_, at) => slipAt(source, tokens, at, lists) ?? []);
|
|
32
|
+
const patternsOf = (lexicon) => lexicon.map((entry) => entry.pattern.toLowerCase());
|
|
33
|
+
const listsOf = (lexicons) => {
|
|
34
|
+
const words = lexicons["amount-quantifier"] ?? [];
|
|
35
|
+
return {
|
|
36
|
+
quantifiers: words.filter((entry) => entry.group === "quantifier"),
|
|
37
|
+
uncounted: new Set([...patternsOf(lexicons["invariant-noun"] ?? []), ...patternsOf(words.filter((entry) => entry.group === "amount"))]),
|
|
38
|
+
finite: new Set(patternsOf(lexicons["finite-auxiliary"] ?? [])),
|
|
39
|
+
};
|
|
40
|
+
};
|
|
41
|
+
export const amountForCount = (doc) => {
|
|
42
|
+
const lists = listsOf(doc.lexicons);
|
|
43
|
+
return doc.sentences.flatMap((sentence) => amountSlipsIn(doc.source, sentence.tokens ?? [], lists).map((slip) => {
|
|
44
|
+
const rest = doc.source.slice(slip.quantifier.span.end, slip.noun.span.end).replace(/\s+/gu, " ");
|
|
45
|
+
return {
|
|
46
|
+
rule: "",
|
|
47
|
+
severity: "warning",
|
|
48
|
+
line: 0,
|
|
49
|
+
column: 0,
|
|
50
|
+
quote: sentence.text.trim(),
|
|
51
|
+
values: { word: `${slip.quantifier.surface}${rest}`, suggestion: `${slip.rewrite}${rest}`, offset: slip.quantifier.span.start },
|
|
52
|
+
};
|
|
53
|
+
}));
|
|
54
|
+
};
|
|
55
|
+
//# sourceMappingURL=amount-for-count.js.map
|