chaffjs 0.18.0 → 0.19.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 +52 -56
- package/bin/chaff.js +17 -2
- package/dist/acronym-expansions.d.ts +26 -0
- package/dist/acronym-expansions.d.ts.map +1 -0
- package/dist/acronym-expansions.js +88 -0
- package/dist/acronym-expansions.js.map +1 -0
- package/dist/announced-count.d.ts.map +1 -1
- package/dist/announced-count.js +44 -10
- package/dist/announced-count.js.map +1 -1
- package/dist/announced-list.d.ts +30 -0
- package/dist/announced-list.d.ts.map +1 -0
- package/dist/announced-list.js +95 -0
- package/dist/announced-list.js.map +1 -0
- package/dist/api.d.ts +168 -0
- package/dist/api.d.ts.map +1 -0
- package/dist/api.js +10 -0
- package/dist/api.js.map +1 -0
- package/dist/cli-text.d.ts +0 -1
- package/dist/cli-text.d.ts.map +1 -1
- package/dist/cli-text.js +6 -14
- package/dist/cli-text.js.map +1 -1
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +58 -62
- package/dist/cli.js.map +1 -1
- package/dist/closing-paragraph.d.ts +7 -0
- package/dist/closing-paragraph.d.ts.map +1 -0
- package/dist/closing-paragraph.js +22 -0
- package/dist/closing-paragraph.js.map +1 -0
- package/dist/commands/compare.d.ts +8 -1
- package/dist/commands/compare.d.ts.map +1 -1
- package/dist/commands/compare.js +9 -17
- package/dist/commands/compare.js.map +1 -1
- package/dist/commands/document-commands.d.ts +9 -0
- package/dist/commands/document-commands.d.ts.map +1 -0
- package/dist/commands/document-commands.js +17 -0
- package/dist/commands/document-commands.js.map +1 -0
- package/dist/commands/eval.d.ts.map +1 -1
- package/dist/commands/eval.js +3 -2
- package/dist/commands/eval.js.map +1 -1
- package/dist/commands/facts.d.ts +8 -0
- package/dist/commands/facts.d.ts.map +1 -0
- package/dist/commands/facts.js +30 -0
- package/dist/commands/facts.js.map +1 -0
- package/dist/commands/feedback.d.ts +10 -0
- package/dist/commands/feedback.d.ts.map +1 -1
- package/dist/commands/feedback.js +25 -1
- package/dist/commands/feedback.js.map +1 -1
- package/dist/commands/fix-plan.d.ts +13 -0
- package/dist/commands/fix-plan.d.ts.map +1 -0
- package/dist/commands/fix-plan.js +44 -0
- package/dist/commands/fix-plan.js.map +1 -0
- package/dist/commands/outline.d.ts +8 -0
- package/dist/commands/outline.d.ts.map +1 -0
- package/dist/commands/outline.js +43 -0
- package/dist/commands/outline.js.map +1 -0
- package/dist/commands/read-document.d.ts +14 -0
- package/dist/commands/read-document.d.ts.map +1 -0
- package/dist/commands/read-document.js +21 -0
- package/dist/commands/read-document.js.map +1 -0
- package/dist/commands/suppressions.d.ts +7 -0
- package/dist/commands/suppressions.d.ts.map +1 -0
- package/dist/commands/suppressions.js +9 -0
- package/dist/commands/suppressions.js.map +1 -0
- package/dist/commands/test.js +1 -1
- package/dist/commands/test.js.map +1 -1
- package/dist/compare/clock-time.d.ts.map +1 -1
- package/dist/compare/clock-time.js +5 -2
- package/dist/compare/clock-time.js.map +1 -1
- package/dist/compare/distinct.d.ts +9 -0
- package/dist/compare/distinct.d.ts.map +1 -0
- package/dist/compare/distinct.js +12 -0
- package/dist/compare/distinct.js.map +1 -0
- package/dist/compare/extract.d.ts.map +1 -1
- package/dist/compare/extract.js +7 -5
- package/dist/compare/extract.js.map +1 -1
- package/dist/compare/fact-key.d.ts +17 -0
- package/dist/compare/fact-key.d.ts.map +1 -0
- package/dist/compare/fact-key.js +25 -0
- package/dist/compare/fact-key.js.map +1 -0
- package/dist/compare/fact-text.d.ts +5 -0
- package/dist/compare/fact-text.d.ts.map +1 -1
- package/dist/compare/fact-text.js +16 -2
- package/dist/compare/fact-text.js.map +1 -1
- package/dist/compare/facts-render.d.ts +17 -0
- package/dist/compare/facts-render.d.ts.map +1 -0
- package/dist/compare/facts-render.js +43 -0
- package/dist/compare/facts-render.js.map +1 -0
- package/dist/compare/facts-text.d.ts +15 -0
- package/dist/compare/facts-text.d.ts.map +1 -0
- package/dist/compare/facts-text.js +27 -0
- package/dist/compare/facts-text.js.map +1 -0
- package/dist/compare/match.d.ts +1 -0
- package/dist/compare/match.d.ts.map +1 -1
- package/dist/compare/match.js +1 -1
- package/dist/compare/match.js.map +1 -1
- package/dist/compare/outcome.d.ts +4 -1
- package/dist/compare/outcome.d.ts.map +1 -1
- package/dist/compare/outcome.js +10 -4
- package/dist/compare/outcome.js.map +1 -1
- package/dist/compare/proper-nouns.d.ts +3 -3
- package/dist/compare/proper-nouns.d.ts.map +1 -1
- package/dist/compare/proper-nouns.js +2 -3
- package/dist/compare/proper-nouns.js.map +1 -1
- package/dist/compare/render.d.ts +4 -0
- package/dist/compare/render.d.ts.map +1 -1
- package/dist/compare/render.js +2 -2
- package/dist/compare/render.js.map +1 -1
- package/dist/compare/text-atoms.d.ts +5 -2
- package/dist/compare/text-atoms.d.ts.map +1 -1
- package/dist/compare/text-atoms.js +7 -5
- package/dist/compare/text-atoms.js.map +1 -1
- package/dist/compare/text.d.ts.map +1 -1
- package/dist/compare/text.js +2 -2
- package/dist/compare/text.js.map +1 -1
- package/dist/config/load.d.ts +8 -0
- 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/option-problems.d.ts +3 -2
- package/dist/config/option-problems.d.ts.map +1 -1
- package/dist/config/option-problems.js +4 -3
- package/dist/config/option-problems.js.map +1 -1
- package/dist/config/style.d.ts +5 -0
- package/dist/config/style.d.ts.map +1 -1
- package/dist/config/style.js +13 -1
- package/dist/config/style.js.map +1 -1
- package/dist/custom/load.d.ts +6 -3
- package/dist/custom/load.d.ts.map +1 -1
- package/dist/custom/load.js +10 -2
- package/dist/custom/load.js.map +1 -1
- package/dist/custom/module-path.d.ts +11 -0
- package/dist/custom/module-path.d.ts.map +1 -0
- package/dist/custom/module-path.js +15 -0
- package/dist/custom/module-path.js.map +1 -0
- package/dist/custom/parse.d.ts +17 -3
- package/dist/custom/parse.d.ts.map +1 -1
- package/dist/custom/parse.js +57 -14
- package/dist/custom/parse.js.map +1 -1
- package/dist/custom/problems.d.ts +4 -1
- package/dist/custom/problems.d.ts.map +1 -1
- package/dist/custom/problems.js +56 -39
- package/dist/custom/problems.js.map +1 -1
- package/dist/detect-language.js +1 -1
- package/dist/detect.d.ts.map +1 -1
- package/dist/detect.js +9 -3
- package/dist/detect.js.map +1 -1
- package/dist/detectors/ai-phrasing.d.ts +4 -1
- package/dist/detectors/ai-phrasing.d.ts.map +1 -1
- package/dist/detectors/ai-phrasing.js +6 -2
- package/dist/detectors/ai-phrasing.js.map +1 -1
- package/dist/detectors/bold-label.d.ts +10 -0
- package/dist/detectors/bold-label.d.ts.map +1 -0
- package/dist/detectors/bold-label.js +44 -0
- package/dist/detectors/bold-label.js.map +1 -0
- package/dist/detectors/dangling-figure.d.ts +5 -2
- package/dist/detectors/dangling-figure.d.ts.map +1 -1
- package/dist/detectors/dangling-figure.js +5 -3
- package/dist/detectors/dangling-figure.js.map +1 -1
- package/dist/detectors/definition-use.d.ts +8 -0
- package/dist/detectors/definition-use.d.ts.map +1 -0
- package/dist/detectors/definition-use.js +32 -0
- package/dist/detectors/definition-use.js.map +1 -0
- package/dist/detectors/doubled-punctuation.d.ts.map +1 -1
- package/dist/detectors/doubled-punctuation.js +4 -2
- package/dist/detectors/doubled-punctuation.js.map +1 -1
- package/dist/detectors/duplicate-heading.d.ts +14 -0
- package/dist/detectors/duplicate-heading.d.ts.map +1 -0
- package/dist/detectors/duplicate-heading.js +39 -0
- package/dist/detectors/duplicate-heading.js.map +1 -0
- package/dist/detectors/empty-section.d.ts +8 -0
- package/dist/detectors/empty-section.d.ts.map +1 -0
- package/dist/detectors/empty-section.js +16 -0
- package/dist/detectors/empty-section.js.map +1 -0
- package/dist/detectors/fullwidth-alnum.d.ts +24 -0
- package/dist/detectors/fullwidth-alnum.d.ts.map +1 -0
- package/dist/detectors/fullwidth-alnum.js +88 -0
- package/dist/detectors/fullwidth-alnum.js.map +1 -0
- package/dist/detectors/hankaku-kana.d.ts +9 -0
- package/dist/detectors/hankaku-kana.d.ts.map +1 -0
- package/dist/detectors/hankaku-kana.js +27 -0
- package/dist/detectors/hankaku-kana.js.map +1 -0
- package/dist/detectors/heading-code-words.js +2 -2
- package/dist/detectors/heading-code-words.js.map +1 -1
- package/dist/detectors/index.d.ts.map +1 -1
- package/dist/detectors/index.js +36 -0
- package/dist/detectors/index.js.map +1 -1
- package/dist/detectors/invisible-character.d.ts +20 -0
- package/dist/detectors/invisible-character.d.ts.map +1 -0
- package/dist/detectors/invisible-character.js +143 -0
- package/dist/detectors/invisible-character.js.map +1 -0
- package/dist/detectors/kutoten-consistency.js +2 -2
- package/dist/detectors/kutoten-consistency.js.map +1 -1
- package/dist/detectors/lexicon-match.d.ts +10 -1
- package/dist/detectors/lexicon-match.d.ts.map +1 -1
- package/dist/detectors/lexicon-match.js +26 -1
- package/dist/detectors/lexicon-match.js.map +1 -1
- package/dist/detectors/lexicon.d.ts +6 -1
- package/dist/detectors/lexicon.d.ts.map +1 -1
- package/dist/detectors/lexicon.js +31 -13
- package/dist/detectors/lexicon.js.map +1 -1
- package/dist/detectors/list-sentence.d.ts +3 -1
- package/dist/detectors/list-sentence.d.ts.map +1 -1
- package/dist/detectors/list-sentence.js +26 -1
- package/dist/detectors/list-sentence.js.map +1 -1
- package/dist/detectors/long-vowel.d.ts.map +1 -1
- package/dist/detectors/long-vowel.js +18 -4
- package/dist/detectors/long-vowel.js.map +1 -1
- package/dist/detectors/markup-finding.d.ts +3 -1
- package/dist/detectors/markup-finding.d.ts.map +1 -1
- package/dist/detectors/markup-finding.js +10 -0
- package/dist/detectors/markup-finding.js.map +1 -1
- package/dist/detectors/modal-conflict.d.ts +4 -0
- package/dist/detectors/modal-conflict.d.ts.map +1 -0
- package/dist/detectors/modal-conflict.js +22 -0
- package/dist/detectors/modal-conflict.js.map +1 -0
- package/dist/detectors/name-variant.d.ts +4 -0
- package/dist/detectors/name-variant.d.ts.map +1 -0
- package/dist/detectors/name-variant.js +13 -0
- package/dist/detectors/name-variant.js.map +1 -0
- package/dist/detectors/nominalization.d.ts +11 -0
- package/dist/detectors/nominalization.d.ts.map +1 -0
- package/dist/detectors/nominalization.js +56 -0
- package/dist/detectors/nominalization.js.map +1 -0
- package/dist/detectors/orthography.d.ts.map +1 -1
- package/dist/detectors/orthography.js +59 -28
- package/dist/detectors/orthography.js.map +1 -1
- package/dist/detectors/outside-announced-list.d.ts +4 -0
- package/dist/detectors/outside-announced-list.d.ts.map +1 -0
- package/dist/detectors/outside-announced-list.js +24 -0
- package/dist/detectors/outside-announced-list.js.map +1 -0
- package/dist/detectors/oxford-comma.d.ts.map +1 -1
- package/dist/detectors/oxford-comma.js +1 -0
- package/dist/detectors/oxford-comma.js.map +1 -1
- package/dist/detectors/phrase-match.d.ts +4 -1
- package/dist/detectors/phrase-match.d.ts.map +1 -1
- package/dist/detectors/phrase-match.js +26 -7
- package/dist/detectors/phrase-match.js.map +1 -1
- package/dist/detectors/ra-nuki.d.ts +9 -0
- package/dist/detectors/ra-nuki.d.ts.map +1 -0
- package/dist/detectors/ra-nuki.js +30 -0
- package/dist/detectors/ra-nuki.js.map +1 -0
- package/dist/detectors/requirement-modal.d.ts +5 -0
- package/dist/detectors/requirement-modal.d.ts.map +1 -0
- package/dist/detectors/requirement-modal.js +54 -0
- package/dist/detectors/requirement-modal.js.map +1 -0
- package/dist/detectors/requirement-smell.d.ts +4 -0
- package/dist/detectors/requirement-smell.d.ts.map +1 -0
- package/dist/detectors/requirement-smell.js +41 -0
- package/dist/detectors/requirement-smell.js.map +1 -0
- package/dist/detectors/space-before-punctuation.d.ts +8 -0
- package/dist/detectors/space-before-punctuation.d.ts.map +1 -0
- package/dist/detectors/space-before-punctuation.js +24 -0
- package/dist/detectors/space-before-punctuation.js.map +1 -0
- package/dist/detectors/spelling-variety.d.ts +23 -0
- package/dist/detectors/spelling-variety.d.ts.map +1 -0
- package/dist/detectors/spelling-variety.js +59 -0
- package/dist/detectors/spelling-variety.js.map +1 -0
- package/dist/detectors/structure-tree.d.ts.map +1 -1
- package/dist/detectors/structure-tree.js +3 -1
- package/dist/detectors/structure-tree.js.map +1 -1
- package/dist/detectors/structure.d.ts.map +1 -1
- package/dist/detectors/structure.js +16 -2
- package/dist/detectors/structure.js.map +1 -1
- package/dist/detectors/superlative-comparison.d.ts +20 -0
- package/dist/detectors/superlative-comparison.d.ts.map +1 -0
- package/dist/detectors/superlative-comparison.js +32 -0
- package/dist/detectors/superlative-comparison.js.map +1 -0
- package/dist/detectors/url-run-on.d.ts.map +1 -1
- package/dist/detectors/url-run-on.js +6 -1
- package/dist/detectors/url-run-on.js.map +1 -1
- package/dist/detectors/vague-figure-pointer.d.ts +10 -0
- package/dist/detectors/vague-figure-pointer.d.ts.map +1 -0
- package/dist/detectors/vague-figure-pointer.js +46 -0
- package/dist/detectors/vague-figure-pointer.js.map +1 -0
- package/dist/detectors/word-list.d.ts +2 -0
- package/dist/detectors/word-list.d.ts.map +1 -1
- package/dist/detectors/word-list.js +4 -1
- package/dist/detectors/word-list.js.map +1 -1
- package/dist/document.d.ts +9 -3
- package/dist/document.d.ts.map +1 -1
- package/dist/document.js +55 -32
- package/dist/document.js.map +1 -1
- package/dist/extension/document-view.d.ts +7 -0
- package/dist/extension/document-view.d.ts.map +1 -0
- package/dist/extension/document-view.js +91 -0
- package/dist/extension/document-view.js.map +1 -0
- package/dist/extension/failure-text.d.ts +5 -0
- package/dist/extension/failure-text.d.ts.map +1 -0
- package/dist/extension/failure-text.js +33 -0
- package/dist/extension/failure-text.js.map +1 -0
- package/dist/extension/import-default.d.ts +7 -0
- package/dist/extension/import-default.d.ts.map +1 -0
- package/dist/extension/import-default.js +21 -0
- package/dist/extension/import-default.js.map +1 -0
- package/dist/extension/load.d.ts +28 -0
- package/dist/extension/load.d.ts.map +1 -0
- package/dist/extension/load.js +51 -0
- package/dist/extension/load.js.map +1 -0
- package/dist/extension/module-detector.d.ts +21 -0
- package/dist/extension/module-detector.d.ts.map +1 -0
- package/dist/extension/module-detector.js +49 -0
- package/dist/extension/module-detector.js.map +1 -0
- package/dist/extension/plugin-load.d.ts +9 -0
- package/dist/extension/plugin-load.d.ts.map +1 -0
- package/dist/extension/plugin-load.js +68 -0
- package/dist/extension/plugin-load.js.map +1 -0
- package/dist/extension/plugin-name.d.ts +8 -0
- package/dist/extension/plugin-name.d.ts.map +1 -0
- package/dist/extension/plugin-name.js +22 -0
- package/dist/extension/plugin-name.js.map +1 -0
- package/dist/extension/plugin-parse.d.ts +41 -0
- package/dist/extension/plugin-parse.d.ts.map +1 -0
- package/dist/extension/plugin-parse.js +156 -0
- package/dist/extension/plugin-parse.js.map +1 -0
- package/dist/extension/problem-text.d.ts +5 -0
- package/dist/extension/problem-text.d.ts.map +1 -0
- package/dist/extension/problem-text.js +74 -0
- package/dist/extension/problem-text.js.map +1 -0
- package/dist/extension/real-path.d.ts +3 -0
- package/dist/extension/real-path.d.ts.map +1 -0
- package/dist/extension/real-path.js +8 -0
- package/dist/extension/real-path.js.map +1 -0
- package/dist/extension/returned-findings.d.ts +17 -0
- package/dist/extension/returned-findings.d.ts.map +1 -0
- package/dist/extension/returned-findings.js +48 -0
- package/dist/extension/returned-findings.js.map +1 -0
- package/dist/extension/rule-export.d.ts +13 -0
- package/dist/extension/rule-export.d.ts.map +1 -0
- package/dist/extension/rule-export.js +16 -0
- package/dist/extension/rule-export.js.map +1 -0
- package/dist/feedback/draft.d.ts +2 -0
- package/dist/feedback/draft.d.ts.map +1 -1
- package/dist/feedback/draft.js +3 -0
- package/dist/feedback/draft.js.map +1 -1
- package/dist/figure-references.d.ts +11 -2
- package/dist/figure-references.d.ts.map +1 -1
- package/dist/figure-references.js +50 -13
- package/dist/figure-references.js.map +1 -1
- package/dist/finding-order.d.ts +9 -0
- package/dist/finding-order.d.ts.map +1 -0
- package/dist/finding-order.js +3 -0
- package/dist/finding-order.js.map +1 -0
- package/dist/fix-plan/mode.d.ts +21 -0
- package/dist/fix-plan/mode.d.ts.map +1 -0
- package/dist/fix-plan/mode.js +16 -0
- package/dist/fix-plan/mode.js.map +1 -0
- package/dist/fix-plan/plan.d.ts +77 -0
- package/dist/fix-plan/plan.d.ts.map +1 -0
- package/dist/fix-plan/plan.js +100 -0
- package/dist/fix-plan/plan.js.map +1 -0
- package/dist/fix-plan/render.d.ts +6 -0
- package/dist/fix-plan/render.d.ts.map +1 -0
- package/dist/fix-plan/render.js +101 -0
- package/dist/fix-plan/render.js.map +1 -0
- package/dist/fix-plan/text.d.ts +35 -0
- package/dist/fix-plan/text.d.ts.map +1 -0
- package/dist/fix-plan/text.js +95 -0
- package/dist/fix-plan/text.js.map +1 -0
- package/dist/language-sample.d.ts +2 -0
- package/dist/language-sample.d.ts.map +1 -0
- package/dist/language-sample.js +41 -0
- package/dist/language-sample.js.map +1 -0
- package/dist/link-line.d.ts +8 -0
- package/dist/link-line.d.ts.map +1 -0
- package/dist/link-line.js +12 -0
- package/dist/link-line.js.map +1 -0
- package/dist/long-vowel.d.ts +9 -6
- package/dist/long-vowel.d.ts.map +1 -1
- package/dist/long-vowel.js +15 -8
- package/dist/long-vowel.js.map +1 -1
- package/dist/markup.d.ts.map +1 -1
- package/dist/markup.js +4 -2
- package/dist/markup.js.map +1 -1
- package/dist/name-variants.d.ts +25 -0
- package/dist/name-variants.d.ts.map +1 -0
- package/dist/name-variants.js +181 -0
- package/dist/name-variants.js.map +1 -0
- package/dist/node-version.d.ts +7 -0
- package/dist/node-version.d.ts.map +1 -0
- package/dist/node-version.js +19 -0
- package/dist/node-version.js.map +1 -0
- package/dist/not-run.d.ts +14 -0
- package/dist/not-run.d.ts.map +1 -0
- package/dist/not-run.js +12 -0
- package/dist/not-run.js.map +1 -0
- package/dist/orthography.d.ts +8 -1
- package/dist/orthography.d.ts.map +1 -1
- package/dist/orthography.js +33 -12
- package/dist/orthography.js.map +1 -1
- package/dist/outline/render.d.ts +18 -0
- package/dist/outline/render.d.ts.map +1 -0
- package/dist/outline/render.js +60 -0
- package/dist/outline/render.js.map +1 -0
- package/dist/outline/shape.d.ts +26 -0
- package/dist/outline/shape.d.ts.map +1 -0
- package/dist/outline/shape.js +37 -0
- package/dist/outline/shape.js.map +1 -0
- package/dist/outline/text.d.ts +21 -0
- package/dist/outline/text.d.ts.map +1 -0
- package/dist/outline/text.js +30 -0
- package/dist/outline/text.js.map +1 -0
- package/dist/plugin.d.ts +24 -2
- package/dist/plugin.d.ts.map +1 -1
- package/dist/reasons.d.ts +1 -0
- package/dist/reasons.d.ts.map +1 -1
- package/dist/reasons.js +2 -0
- package/dist/reasons.js.map +1 -1
- package/dist/render/compact.d.ts +3 -1
- package/dist/render/compact.d.ts.map +1 -1
- package/dist/render/compact.js +8 -2
- package/dist/render/compact.js.map +1 -1
- package/dist/render/explain.d.ts +3 -1
- package/dist/render/explain.d.ts.map +1 -1
- package/dist/render/explain.js +32 -15
- package/dist/render/explain.js.map +1 -1
- package/dist/render/rules-json.d.ts.map +1 -1
- package/dist/render/rules-json.js +16 -12
- package/dist/render/rules-json.js.map +1 -1
- package/dist/render/suppressions.d.ts +3 -0
- package/dist/render/suppressions.d.ts.map +1 -1
- package/dist/render/suppressions.js +20 -1
- package/dist/render/suppressions.js.map +1 -1
- package/dist/rule-guide.d.ts +19 -0
- package/dist/rule-guide.d.ts.map +1 -1
- package/dist/rule-guide.js +14 -0
- package/dist/rule-guide.js.map +1 -1
- package/dist/run-semantic.d.ts.map +1 -1
- package/dist/run-semantic.js +2 -1
- package/dist/run-semantic.js.map +1 -1
- package/dist/run.d.ts +5 -1
- package/dist/run.d.ts.map +1 -1
- package/dist/run.js +31 -14
- package/dist/run.js.map +1 -1
- package/dist/setting-problems.d.ts.map +1 -1
- package/dist/setting-problems.js +3 -1
- package/dist/setting-problems.js.map +1 -1
- package/dist/spacing-minority.d.ts +16 -0
- package/dist/spacing-minority.d.ts.map +1 -0
- package/dist/spacing-minority.js +23 -0
- package/dist/spacing-minority.js.map +1 -0
- package/dist/stet-block.d.ts +5 -0
- package/dist/stet-block.d.ts.map +1 -0
- package/dist/stet-block.js +59 -0
- package/dist/stet-block.js.map +1 -0
- package/dist/stet.d.ts +4 -0
- package/dist/stet.d.ts.map +1 -1
- package/dist/stet.js +31 -11
- package/dist/stet.js.map +1 -1
- package/dist/structure/date-range.d.ts +10 -0
- package/dist/structure/date-range.d.ts.map +1 -1
- package/dist/structure/date-range.js +33 -1
- package/dist/structure/date-range.js.map +1 -1
- package/dist/structure/definition-use.d.ts +32 -0
- package/dist/structure/definition-use.d.ts.map +1 -0
- package/dist/structure/definition-use.js +102 -0
- package/dist/structure/definition-use.js.map +1 -0
- package/dist/structure/lazy-tree.d.ts +8 -0
- package/dist/structure/lazy-tree.d.ts.map +1 -0
- package/dist/structure/lazy-tree.js +14 -0
- package/dist/structure/lazy-tree.js.map +1 -0
- package/dist/structure/modal-conflict.d.ts +28 -0
- package/dist/structure/modal-conflict.d.ts.map +1 -0
- package/dist/structure/modal-conflict.js +74 -0
- package/dist/structure/modal-conflict.js.map +1 -0
- package/dist/structure/numbered-clauses.d.ts +4 -0
- package/dist/structure/numbered-clauses.d.ts.map +1 -0
- package/dist/structure/numbered-clauses.js +9 -0
- package/dist/structure/numbered-clauses.js.map +1 -0
- package/dist/structure/universal.d.ts.map +1 -1
- package/dist/structure/universal.js +8 -2
- package/dist/structure/universal.js.map +1 -1
- package/dist/style-parse.d.ts +6 -0
- package/dist/style-parse.d.ts.map +1 -1
- package/dist/style-parse.js +32 -4
- package/dist/style-parse.js.map +1 -1
- package/dist/subheading-line.d.ts +19 -2
- package/dist/subheading-line.d.ts.map +1 -1
- package/dist/subheading-line.js +39 -11
- package/dist/subheading-line.js.map +1 -1
- package/dist/tag-coverage.d.ts +8 -0
- package/dist/tag-coverage.d.ts.map +1 -0
- package/dist/tag-coverage.js +7 -0
- package/dist/tag-coverage.js.map +1 -0
- package/genres.yaml +42 -0
- package/package.json +7 -3
- package/rules/acronym-expansion-conflict.yaml +82 -0
- package/rules/adverb-overuse.yaml +2 -2
- package/rules/agentless-passive.yaml +28 -0
- package/rules/ai-tell.yaml +34 -0
- package/rules/announced-count-mismatch.yaml +2 -2
- package/rules/announcing-opener.yaml +31 -0
- package/rules/assistant-residue.yaml +30 -0
- package/rules/bold-density.yaml +28 -0
- package/rules/bold-label-list.yaml +81 -0
- package/rules/closing-cliche.yaml +27 -2
- package/rules/colon-lead-in.yaml +28 -4
- package/rules/contrast-framing.yaml +33 -2
- package/rules/cushion-phrase-density.yaml +32 -5
- package/rules/dangling-reference.yaml +1 -0
- package/rules/date-order.yaml +1 -0
- package/rules/date-range-reversed.yaml +2 -2
- package/rules/double-negative.yaml +51 -0
- package/rules/doubled-punctuation.yaml +2 -2
- package/rules/doubled-word.yaml +2 -2
- package/rules/duplicate-heading.yaml +78 -0
- package/rules/emoji-density.yaml +5 -4
- package/rules/empty-intensifier.yaml +25 -0
- package/rules/empty-section.yaml +74 -0
- package/rules/excessive-hedging.yaml +32 -4
- package/rules/fullwidth-alnum-consistency.yaml +53 -0
- package/rules/hankaku-kana.yaml +41 -0
- package/rules/image-alt-text.yaml +1 -1
- package/rules/invisible-character.yaml +63 -0
- package/rules/katakana-long-vowel.yaml +10 -9
- package/rules/latin-spacing.yaml +12 -5
- package/rules/max-kanji-continuous.yaml +1 -0
- package/rules/max-paragraph-length.yaml +1 -0
- package/rules/max-sentence-length.yaml +26 -0
- package/rules/modal-conflict.yaml +106 -0
- package/rules/name-variant.yaml +88 -0
- package/rules/no-doubled-joshi.yaml +1 -0
- package/rules/no-em-dash.yaml +26 -2
- package/rules/no-mixed-desumasu.yaml +1 -0
- package/rules/nominalization.yaml +89 -0
- package/rules/outside-announced-list.yaml +80 -0
- package/rules/padded-intro.yaml +25 -0
- package/rules/paragraph-length-variance.yaml +26 -2
- package/rules/preferred-term.yaml +1 -0
- package/rules/proper-noun-density.yaml +14 -5
- package/rules/ra-nuki.yaml +43 -0
- package/rules/requirement-modal.yaml +94 -0
- package/rules/requirement-smell.yaml +70 -0
- package/rules/rule-of-three.yaml +46 -0
- package/rules/section-length-uniformity.yaml +26 -2
- package/rules/sentence-rhythm.yaml +26 -0
- package/rules/space-before-punctuation.yaml +41 -0
- package/rules/spelling-consistency.yaml +47 -0
- package/rules/stock-transition.yaml +33 -2
- package/rules/taigen-dome-in-prose.yaml +14 -0
- package/rules/total-mismatch.yaml +1 -0
- package/rules/undefined-acronym.yaml +1 -0
- package/rules/unqualified-superlative.yaml +5 -4
- package/rules/unused-definition.yaml +75 -0
- package/rules/use-before-definition.yaml +77 -0
- package/rules/vague-figure-reference.yaml +66 -0
- package/skills/chaff/SKILL.md +108 -8
- package/src/acronym-expansions.ts +106 -0
- package/src/announced-count.ts +53 -11
- package/src/announced-list.ts +120 -0
- package/src/api.ts +154 -0
- package/src/cli-text.ts +6 -11
- package/src/cli.ts +64 -63
- package/src/closing-paragraph.ts +24 -0
- package/src/commands/compare.ts +11 -18
- package/src/commands/document-commands.ts +19 -0
- package/src/commands/eval.ts +3 -2
- package/src/commands/facts.ts +33 -0
- package/src/commands/feedback.ts +33 -1
- package/src/commands/fix-plan.ts +53 -0
- package/src/commands/outline.ts +49 -0
- package/src/commands/read-document.ts +24 -0
- package/src/commands/suppressions.ts +19 -0
- package/src/commands/test.ts +1 -1
- package/src/compare/clock-time.ts +5 -2
- package/src/compare/distinct.ts +13 -0
- package/src/compare/extract.ts +7 -5
- package/src/compare/fact-key.ts +31 -0
- package/src/compare/fact-text.ts +21 -2
- package/src/compare/facts-render.ts +63 -0
- package/src/compare/facts-text.ts +41 -0
- package/src/compare/match.ts +1 -1
- package/src/compare/outcome.ts +14 -4
- package/src/compare/proper-nouns.ts +4 -4
- package/src/compare/render.ts +2 -2
- package/src/compare/text-atoms.ts +7 -6
- package/src/compare/text.ts +3 -2
- package/src/config/load.ts +9 -0
- package/src/config/option-problems.ts +6 -4
- package/src/config/style.ts +14 -1
- package/src/custom/load.ts +11 -3
- package/src/custom/module-path.ts +23 -0
- package/src/custom/parse.ts +67 -18
- package/src/custom/problems.ts +63 -41
- package/src/detect-language.ts +1 -1
- package/src/detect.ts +10 -3
- package/src/detectors/ai-phrasing.ts +6 -2
- package/src/detectors/bold-label.ts +55 -0
- package/src/detectors/dangling-figure.ts +8 -4
- package/src/detectors/definition-use.ts +41 -0
- package/src/detectors/doubled-punctuation.ts +5 -2
- package/src/detectors/duplicate-heading.ts +47 -0
- package/src/detectors/empty-section.ts +21 -0
- package/src/detectors/fullwidth-alnum.ts +118 -0
- package/src/detectors/hankaku-kana.ts +38 -0
- package/src/detectors/heading-code-words.ts +2 -2
- package/src/detectors/index.ts +36 -0
- package/src/detectors/invisible-character.ts +190 -0
- package/src/detectors/kutoten-consistency.ts +2 -2
- package/src/detectors/lexicon-match.ts +33 -1
- package/src/detectors/lexicon.ts +40 -13
- package/src/detectors/list-sentence.ts +45 -4
- package/src/detectors/long-vowel.ts +20 -4
- package/src/detectors/markup-finding.ts +16 -1
- package/src/detectors/modal-conflict.ts +26 -0
- package/src/detectors/name-variant.ts +15 -0
- package/src/detectors/nominalization.ts +73 -0
- package/src/detectors/orthography.ts +77 -27
- package/src/detectors/outside-announced-list.ts +25 -0
- package/src/detectors/oxford-comma.ts +1 -0
- package/src/detectors/phrase-match.ts +27 -7
- package/src/detectors/ra-nuki.ts +38 -0
- package/src/detectors/requirement-modal.ts +67 -0
- package/src/detectors/requirement-smell.ts +52 -0
- package/src/detectors/space-before-punctuation.ts +32 -0
- package/src/detectors/spelling-variety.ts +81 -0
- package/src/detectors/structure-tree.ts +3 -1
- package/src/detectors/structure.ts +17 -3
- package/src/detectors/superlative-comparison.ts +47 -0
- package/src/detectors/url-run-on.ts +7 -1
- package/src/detectors/vague-figure-pointer.ts +58 -0
- package/src/detectors/word-list.ts +6 -1
- package/src/document.ts +88 -41
- package/src/extension/document-view.ts +109 -0
- package/src/extension/failure-text.ts +46 -0
- package/src/extension/import-default.ts +13 -0
- package/src/extension/load.ts +97 -0
- package/src/extension/module-detector.ts +61 -0
- package/src/extension/plugin-load.ts +82 -0
- package/src/extension/plugin-name.ts +26 -0
- package/src/extension/plugin-parse.ts +229 -0
- package/src/extension/problem-text.ts +103 -0
- package/src/extension/real-path.ts +10 -0
- package/src/extension/returned-findings.ts +62 -0
- package/src/extension/rule-export.ts +23 -0
- package/src/feedback/draft.ts +6 -0
- package/src/figure-references.ts +73 -12
- package/src/finding-order.ts +3 -0
- package/src/fix-plan/mode.ts +34 -0
- package/src/fix-plan/plan.ts +181 -0
- package/src/fix-plan/render.ts +128 -0
- package/src/fix-plan/text.ts +133 -0
- package/src/language-sample.ts +48 -0
- package/src/link-line.ts +13 -0
- package/src/long-vowel.ts +18 -8
- package/src/markup.ts +4 -2
- package/src/name-variants.ts +217 -0
- package/src/node-version.ts +22 -0
- package/src/not-run.ts +16 -0
- package/src/orthography.ts +40 -11
- package/src/outline/render.ts +85 -0
- package/src/outline/shape.ts +72 -0
- package/src/outline/text.ts +50 -0
- package/src/plugin.ts +21 -4
- package/src/reasons.ts +3 -0
- package/src/render/compact.ts +13 -3
- package/src/render/explain.ts +47 -20
- package/src/render/rules-json.ts +18 -12
- package/src/render/suppressions.ts +30 -2
- package/src/rule-guide.ts +38 -0
- package/src/run-semantic.ts +2 -1
- package/src/run.ts +37 -17
- package/src/setting-problems.ts +3 -1
- package/src/spacing-minority.ts +27 -0
- package/src/stet-block.ts +60 -0
- package/src/stet.ts +41 -15
- package/src/structure/date-range.ts +49 -1
- package/src/structure/definition-use.ts +130 -0
- package/src/structure/lazy-tree.ts +15 -0
- package/src/structure/modal-conflict.ts +86 -0
- package/src/structure/numbered-clauses.ts +11 -0
- package/src/structure/universal.ts +10 -2
- package/src/style-parse.ts +38 -3
- package/src/subheading-line.ts +51 -13
- package/src/tag-coverage.ts +13 -0
- package/styles/ieice.yaml +5 -4
- package/styles/jis-z8301-2011.yaml +5 -2
- package/styles/jis-z8301-2019.yaml +31 -0
- package/styles/koyobun.yaml +35 -0
- package/dist/legal-address.d.ts +0 -2
- package/dist/legal-address.d.ts.map +0 -1
- package/dist/legal-address.js +0 -16
- package/dist/legal-address.js.map +0 -1
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
id: name-variant
|
|
2
|
+
layer: L3
|
|
3
|
+
status: experimental
|
|
4
|
+
how_to_find: name-variant
|
|
5
|
+
requires: [pos]
|
|
6
|
+
severity: warning
|
|
7
|
+
|
|
8
|
+
name:
|
|
9
|
+
ja: 同じ名前の書き分け
|
|
10
|
+
en: One name written two ways
|
|
11
|
+
|
|
12
|
+
why:
|
|
13
|
+
ja: 人や会社や製品の名前を、ある所では「山田太郎」、別の所では「山田太朗」と書くと、読み手は同じ人か別の人か分かりません。契約書なら当事者の特定が揺らぎます。多いのは打ち間違いと、別の文書から写した段落です。どちらの形が正しいかは決めず、文書の中で少ないほうを指します。
|
|
14
|
+
en: A person, company or product written as "GitHub" in one place and "Github" in another leaves the reader unsure whether they are the same. In a contract it blurs who the party is. The usual causes are a typo and a paragraph pasted from another document. chaff does not decide which form is right; it points at the one the document uses less.
|
|
15
|
+
|
|
16
|
+
message:
|
|
17
|
+
ja: 「{name}」は、ほかの所では「{usual}」と書いています
|
|
18
|
+
en: '"{name}" is written "{usual}" elsewhere in the document'
|
|
19
|
+
|
|
20
|
+
messages:
|
|
21
|
+
spelling:
|
|
22
|
+
ja: 「{name}」は、ほかの所では「{usual}」と書いています(字の大小・幅・記号の違い)
|
|
23
|
+
en: '"{name}" is written "{usual}" elsewhere in the document (case, width or punctuation)'
|
|
24
|
+
reading:
|
|
25
|
+
ja: 「{name}」は、ほかの所では同じ読みの「{usual}」と書いています
|
|
26
|
+
en: '"{name}" is written "{usual}", read the same, elsewhere in the document'
|
|
27
|
+
near:
|
|
28
|
+
ja: 「{name}」は、ほかの所で何度も書いた「{usual}」と一字違いです
|
|
29
|
+
en: '"{name}" is one letter away from "{usual}", which the document uses more than once'
|
|
30
|
+
|
|
31
|
+
how_to_fix:
|
|
32
|
+
ja: 正しい形を確かめ、一つに揃えてください。本当に別の人や会社なら、そのままで構いません。
|
|
33
|
+
en: Check the right form and use it throughout. If they really are different people or companies, leave them.
|
|
34
|
+
|
|
35
|
+
placeholders:
|
|
36
|
+
name:
|
|
37
|
+
ja: 名前
|
|
38
|
+
en: the name
|
|
39
|
+
usual:
|
|
40
|
+
ja: 別の形
|
|
41
|
+
en: another form
|
|
42
|
+
|
|
43
|
+
levels: { strict: error, normal: warning, relaxed: info }
|
|
44
|
+
|
|
45
|
+
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
46
|
+
|
|
47
|
+
group: consistency
|
|
48
|
+
summary:
|
|
49
|
+
ja: 同じ人・会社・製品の名前を、少しだけ違う形で書いている所(山田太郎 と 山田太朗、GitHub と Github)
|
|
50
|
+
en: The same person, company or product written in slightly different forms (GitHub and Github, Acme, Inc. and Acme Inc.)
|
|
51
|
+
example:
|
|
52
|
+
ja:
|
|
53
|
+
before: |
|
|
54
|
+
担当は山田太郎です。見積もりは山田太郎が作り、請求書は山田太朗が送ります。
|
|
55
|
+
after: |
|
|
56
|
+
担当は山田太郎です。見積もりは山田太郎が作り、請求書も山田太郎が送ります。
|
|
57
|
+
en:
|
|
58
|
+
before: |
|
|
59
|
+
The code lives on GitHub. Reviews happen on GitHub, and releases are tagged on Github.
|
|
60
|
+
after: |
|
|
61
|
+
The code lives on GitHub. Reviews happen on GitHub, and releases are tagged on GitHub.
|
|
62
|
+
|
|
63
|
+
not_flagged:
|
|
64
|
+
ja: 品詞解析が固有名詞と読んだ語だけを見ます。大文字だけの名前(ACME INC、NASA)は見ません。一字違いの英字の名前は、6 字以上で、多いほうが二度以上、少ないほうが一度だけのときに限ります(Iran と Iraq は別の名前)。
|
|
65
|
+
en: Only words the tagger reads as proper nouns are checked. Names in capitals only (ACME INC, NASA) are left out. Names one letter apart are reported only when six letters or longer, with the usual form used at least twice and the other once (Iran and Iraq are different names).
|
|
66
|
+
rewrite:
|
|
67
|
+
ja:
|
|
68
|
+
direction: 少ないほうの形を、多いほうの形に替えてください。どちらが正しいか本文から分からなければ、書き手に聞きます。別の人や会社なら替えません。
|
|
69
|
+
pairs:
|
|
70
|
+
- before: 見積もりは山田太郎が作り、請求書は山田太朗が送ります。
|
|
71
|
+
after: 見積もりは山田太郎が作り、請求書も山田太郎が送ります。
|
|
72
|
+
- before: 発注先は株式会社ミナト商事です。納品はミナト商時が行います。
|
|
73
|
+
after: 発注先は株式会社ミナト商事です。納品はミナト商事が行います。
|
|
74
|
+
keep:
|
|
75
|
+
- 名前の正しい形
|
|
76
|
+
avoid:
|
|
77
|
+
- 別の人や会社の名前を一つにまとめる
|
|
78
|
+
en:
|
|
79
|
+
direction: Replace the less frequent form with the usual one. If the text does not show which is right, ask the writer. Leave names that belong to different people or companies.
|
|
80
|
+
pairs:
|
|
81
|
+
- before: Reviews happen on GitHub, and releases are tagged on Github.
|
|
82
|
+
after: Reviews happen on GitHub, and releases are tagged on GitHub.
|
|
83
|
+
- before: Acme Inc. signs the order. Payment goes to Acme, Inc. within thirty days.
|
|
84
|
+
after: Acme Inc. signs the order. Payment goes to Acme Inc. within thirty days.
|
|
85
|
+
keep:
|
|
86
|
+
- the name's right form
|
|
87
|
+
avoid:
|
|
88
|
+
- merging the names of two different people or companies
|
package/rules/no-em-dash.yaml
CHANGED
|
@@ -30,6 +30,7 @@ levels:
|
|
|
30
30
|
en: { strict: 3, normal: 8, relaxed: 20 }
|
|
31
31
|
|
|
32
32
|
use_for: [blog, business, technical, legal, docs, academic, literature, speech]
|
|
33
|
+
sources: [freeburg-2026]
|
|
33
34
|
|
|
34
35
|
group: ai-tells
|
|
35
36
|
summary:
|
|
@@ -53,5 +54,28 @@ not_flagged:
|
|
|
53
54
|
ja: 短い文書は測りません。英語では、ダッシュそのものを誤りとは言いません。
|
|
54
55
|
en: Short documents are not measured. In English a dash is not called wrong; only a heavy hand is.
|
|
55
56
|
level_meaning:
|
|
56
|
-
ja: 1000
|
|
57
|
-
en: up to {limit} per 1000 words
|
|
57
|
+
ja: 1000 字あたりダッシュ {limit} 個まで
|
|
58
|
+
en: up to {limit} dashes per 1000 words
|
|
59
|
+
rewrite:
|
|
60
|
+
ja:
|
|
61
|
+
direction: 挟み込みのダッシュは括弧に、言い換えや補足のダッシュは読点に替えるか、二文に分けてください。
|
|
62
|
+
pairs:
|
|
63
|
+
- before: この設定——とくに保存期間——は慎重に決めてください。
|
|
64
|
+
after: この設定(とくに保存期間)は慎重に決めてください。
|
|
65
|
+
- before: 答えは一つ——締め切りを守ることです。
|
|
66
|
+
after: 答えは一つ、締め切りを守ることです。
|
|
67
|
+
keep:
|
|
68
|
+
- 挟み込んだ中身と、それが掛かる語
|
|
69
|
+
avoid:
|
|
70
|
+
- ダッシュを全角コロンや別の線の記号に替えるだけで済ませる
|
|
71
|
+
en:
|
|
72
|
+
direction: Turn an aside between dashes into commas or brackets, and a dash before an explanation into a comma, a colon or a new sentence.
|
|
73
|
+
pairs:
|
|
74
|
+
- before: The setting — especially retention — needs care.
|
|
75
|
+
after: The setting, especially retention, needs care.
|
|
76
|
+
- before: There is one answer — meet the deadline.
|
|
77
|
+
after: There is one answer. Meet the deadline.
|
|
78
|
+
keep:
|
|
79
|
+
- the aside and what it belongs to
|
|
80
|
+
avoid:
|
|
81
|
+
- swapping every dash for a colon or a semicolon
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
id: nominalization
|
|
2
|
+
layer: L3
|
|
3
|
+
status: experimental
|
|
4
|
+
how_to_find: nominalization
|
|
5
|
+
# 動詞を名詞にして別の動詞に運ばせる言い方。英語は語の並び(nominalization-phrase)、日本語はサ変名詞(品詞の VerbForm=Vnoun)と、
|
|
6
|
+
# その後ろの「を実施する」(nominalization-light-verb)で見る。片方しか持たない言語があるので word_list には書かない(書くと、無い言語で動かなくなる)。
|
|
7
|
+
requires: [pos]
|
|
8
|
+
severity: info
|
|
9
|
+
|
|
10
|
+
name:
|
|
11
|
+
ja: 動詞を名詞にして回りくどく書いている
|
|
12
|
+
en: Verbs hidden in nouns
|
|
13
|
+
|
|
14
|
+
why:
|
|
15
|
+
ja: 「調査を実施した」は「調査した」で、「確認を行う」は「確認する」で足ります。動詞を名詞にして別の動詞に運ばせると、文が長くなり、誰が何をしたのかが遠くなります。在留支援のためのやさしい日本語ガイドラインが「調査を実施した」を「調査した」に直す例を挙げ、米国連邦政府の Plain Language Guidelines と英国政府(GOV.UK)の書き方の手引きも、"make a decision" ではなく "decide" と書くよう求めています。一つ二つは普通の言い方なので、文書の長さに対して多いときだけ指します。
|
|
16
|
+
en: '"Make a decision" says in three words what "decide" says in one. A verb turned into a noun and carried by another verb makes the sentence longer and the action harder to see. The Federal Plain Language Guidelines call these hidden verbs, and GOV.UK asks for the verb; the Japanese guideline for plain Japanese rewrites 調査を実施した as 調査した. One or two are ordinary, so chaff speaks only when they are dense for the document''s length.'
|
|
17
|
+
|
|
18
|
+
message:
|
|
19
|
+
ja: 「{matched}」は「{preferred}」で足ります(動詞を名詞にした言い方が 1000 字あたり {density} 個、{limit} 個まで)
|
|
20
|
+
en: '"{matched}" can be "{preferred}" ({density} hidden verbs per 1000 words, limit {limit})'
|
|
21
|
+
|
|
22
|
+
how_to_fix:
|
|
23
|
+
ja: 名詞を動詞に戻してください。「調査を実施した」は「調査した」、「確認を行います」は「確認します」に。
|
|
24
|
+
en: 'Use the verb: "made a decision" becomes "decided", "conduct an analysis" becomes "analyze".'
|
|
25
|
+
|
|
26
|
+
placeholders:
|
|
27
|
+
matched:
|
|
28
|
+
ja: 見つけた言い方
|
|
29
|
+
en: the phrase found
|
|
30
|
+
preferred:
|
|
31
|
+
ja: 動詞にした形
|
|
32
|
+
en: the verb
|
|
33
|
+
|
|
34
|
+
levels: { strict: 1, normal: 2, relaxed: 4 }
|
|
35
|
+
|
|
36
|
+
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
37
|
+
sources: [yasashii-nihongo-2020, plain-2011, gov-uk-clear-language, reinhart-2025]
|
|
38
|
+
|
|
39
|
+
group: wording
|
|
40
|
+
summary:
|
|
41
|
+
ja: 「調査を実施した」「確認を行う」のように、動詞を名詞にして別の動詞に運ばせた言い方が、文書の長さに対して多い所
|
|
42
|
+
en: Verbs hidden in nouns ("make a decision", "conduct an analysis"), many for the document's length
|
|
43
|
+
example:
|
|
44
|
+
ja:
|
|
45
|
+
pad: true
|
|
46
|
+
before: |
|
|
47
|
+
先月、顧客の満足度の調査を実施しました。結果の確認を行い、改善の検討を行います。
|
|
48
|
+
after: |
|
|
49
|
+
先月、顧客の満足度を調査しました。結果を確認し、改善を検討します。
|
|
50
|
+
en:
|
|
51
|
+
pad: true
|
|
52
|
+
before: |
|
|
53
|
+
We will conduct an analysis of the results and make a decision next week.
|
|
54
|
+
after: |
|
|
55
|
+
We will analyze the results and decide next week.
|
|
56
|
+
|
|
57
|
+
not_flagged:
|
|
58
|
+
ja: 「する」を付けても動詞にならない名詞(イベントを行う)、「を実施する」が催す意味になる語(研修を実施する、試験を行う)、「勉強をする」のような「〜をする」、文書の長さに対して少ないものは見ません。短すぎる文書も測りません。
|
|
59
|
+
en: Phrases not on chaff's list, and a document where they are few for its length, are not reported. Very short documents are not measured.
|
|
60
|
+
level_meaning:
|
|
61
|
+
ja: 1000 字あたり「〜を実施する」のような名詞化した動詞 {limit} 個まで
|
|
62
|
+
en: up to {limit} nominalized verbs ("make a decision") per 1000 words
|
|
63
|
+
rewrite:
|
|
64
|
+
ja:
|
|
65
|
+
direction: 「〜を実施する」「〜を行う」の名詞を動詞に戻し、運び役の動詞を消してください。誰がしたのかが書かれていれば、その人を主語に残します。
|
|
66
|
+
pairs:
|
|
67
|
+
- before: 先月、顧客満足度の調査を実施しました。
|
|
68
|
+
after: 先月、顧客満足度を調査しました。
|
|
69
|
+
- before: 結果の確認を行い、改善の検討を行います。
|
|
70
|
+
after: 結果を確認し、改善を検討します。
|
|
71
|
+
keep:
|
|
72
|
+
- 何を、いつ、誰がしたのか
|
|
73
|
+
- 催す意味の「実施する」(研修を実施する、試験を行う)
|
|
74
|
+
avoid:
|
|
75
|
+
- 「実施する」を「行う」「図る」のような別の運び役に替える
|
|
76
|
+
- 動詞に戻すときに目的語や時期を落とす
|
|
77
|
+
en:
|
|
78
|
+
direction: Turn the noun back into its verb and drop the verb that was carrying it ("make a decision" becomes "decide"). Keep who acted as the subject.
|
|
79
|
+
pairs:
|
|
80
|
+
- before: We will conduct an analysis of the results next week.
|
|
81
|
+
after: We will analyze the results next week.
|
|
82
|
+
- before: The board made a decision to postpone the launch.
|
|
83
|
+
after: The board decided to postpone the launch.
|
|
84
|
+
keep:
|
|
85
|
+
- what was done, to what, and when
|
|
86
|
+
- who acted
|
|
87
|
+
avoid:
|
|
88
|
+
- swapping one carrying verb for another ("perform", "carry out")
|
|
89
|
+
- dropping the object or the time while making the verb
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
id: outside-announced-list
|
|
2
|
+
layer: L3
|
|
3
|
+
status: experimental
|
|
4
|
+
how_to_find: outside-announced-list
|
|
5
|
+
requires: [pos]
|
|
6
|
+
severity: warning
|
|
7
|
+
|
|
8
|
+
name:
|
|
9
|
+
ja: 挙げた一覧に無い名前
|
|
10
|
+
en: A name outside the announced list
|
|
11
|
+
|
|
12
|
+
why:
|
|
13
|
+
ja: 「対応 OS は Windows と macOS です」と挙げたあとに「Linux にも対応しています」と書くと、どちらが本当の一覧なのか読み手は決められません。対応先を足したときに最初の一覧を直し忘れたか、別の製品の文を写したことが多いです。chaff はどちらが正しいかを決めず、一覧に無い名前を指します。一覧を言う語は言語ごとの語彙表にあり、同じ組(対応する OS、対応する言語)の語どうしだけを比べます。
|
|
14
|
+
en: Listing "supported on Windows and macOS" and later writing "also runs on Linux" leaves the reader unable to tell which list is true. Usually a platform was added and the first list was not updated, or a sentence came from another product's page. chaff does not decide which is right; it points at the name the first list does not have. The words that announce a list are in each language's lexicon, and only words of the same group (platforms, languages) are compared.
|
|
15
|
+
|
|
16
|
+
message:
|
|
17
|
+
ja: 「{name}」は、{listLine} 行目で挙げた一覧({list})にありません
|
|
18
|
+
en: '"{name}" is not in the list given on line {listLine} ({list})'
|
|
19
|
+
|
|
20
|
+
how_to_fix:
|
|
21
|
+
ja: 一覧が古いなら一覧に足し、後の文が誤りなら直してください。
|
|
22
|
+
en: If the list is out of date, add the name to it; if the later sentence is wrong, correct it.
|
|
23
|
+
|
|
24
|
+
placeholders:
|
|
25
|
+
name:
|
|
26
|
+
ja: 名前
|
|
27
|
+
en: the name
|
|
28
|
+
list:
|
|
29
|
+
ja: 一覧
|
|
30
|
+
en: the list
|
|
31
|
+
listLine:
|
|
32
|
+
ja: 〇
|
|
33
|
+
en: N
|
|
34
|
+
|
|
35
|
+
levels: { strict: error, normal: warning, relaxed: info }
|
|
36
|
+
|
|
37
|
+
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
38
|
+
|
|
39
|
+
group: consistency
|
|
40
|
+
summary:
|
|
41
|
+
ja: 「対応 OS は Windows と macOS」と挙げたあとで、一覧に無い「Linux」に対応すると書いている所
|
|
42
|
+
en: A later sentence naming a platform or language that the list given earlier does not have
|
|
43
|
+
example:
|
|
44
|
+
ja:
|
|
45
|
+
before: |
|
|
46
|
+
対応OSはWindowsとmacOSです。インストールは五分で終わります。Linuxにも対応しています。
|
|
47
|
+
after: |
|
|
48
|
+
対応OSはWindowsとmacOSとLinuxです。インストールは五分で終わります。Linuxにも対応しています。
|
|
49
|
+
en:
|
|
50
|
+
before: |
|
|
51
|
+
The app is supported on Windows and macOS. Setup takes five minutes. It is also supported on Linux.
|
|
52
|
+
after: |
|
|
53
|
+
The app is supported on Windows, macOS and Linux. Setup takes five minutes. It is also supported on Linux.
|
|
54
|
+
|
|
55
|
+
not_flagged:
|
|
56
|
+
ja: 一覧を言う語(対応OSは、に対応、版)のすぐ隣に並べた固有名詞だけを読みます。最初に二つ以上の名前を挙げた文を一覧とし、それより前の文は見ません。組の違う語(対応する OS と、対応する言語)は比べません。
|
|
57
|
+
en: Only proper nouns right next to a listing word (supported on, available in, version) are read. The first sentence naming two or more is the list, and earlier sentences are not checked. Words of different groups (platforms and languages) are not compared.
|
|
58
|
+
rewrite:
|
|
59
|
+
ja:
|
|
60
|
+
direction: 一覧と後の文のどちらが正しいかを書き手に確かめてください。後の文が正しければ一覧に名前を足し、一覧が正しければ後の文を直すか消します。
|
|
61
|
+
pairs:
|
|
62
|
+
- before: 対応OSはWindowsとmacOSです。(中略)Linuxにも対応しています。
|
|
63
|
+
after: 対応OSはWindowsとmacOSとLinuxです。(中略)Linuxにも対応しています。(Linux に対応しているとき)
|
|
64
|
+
- before: 本製品はiOSとAndroidに対応しています。(中略)Windows版では設定画面が違います。
|
|
65
|
+
after: 本製品はiOSとAndroidに対応しています。(中略の後の文を消す。Windows 版が無いとき)
|
|
66
|
+
keep:
|
|
67
|
+
- 一覧の名前と、それぞれの文の中身
|
|
68
|
+
avoid:
|
|
69
|
+
- 書き手に確かめずに一覧を足したり減らしたりする
|
|
70
|
+
en:
|
|
71
|
+
direction: Ask the writer whether the list or the later sentence is right. If the later sentence is right, add the name to the list; if the list is right, correct or delete the later sentence.
|
|
72
|
+
pairs:
|
|
73
|
+
- before: The app is supported on Windows and macOS. (...) It is also supported on Linux.
|
|
74
|
+
after: The app is supported on Windows, macOS and Linux. (...) It is also supported on Linux. (when Linux is supported)
|
|
75
|
+
- before: The guide is available in English and French. (...) It is also available in German.
|
|
76
|
+
after: The guide is available in English and French. (the later sentence deleted, when there is no German edition)
|
|
77
|
+
keep:
|
|
78
|
+
- the names in the list and what each sentence says
|
|
79
|
+
avoid:
|
|
80
|
+
- adding to or trimming the list without asking the writer
|
package/rules/padded-intro.yaml
CHANGED
|
@@ -49,3 +49,28 @@ not_flagged:
|
|
|
49
49
|
level_meaning:
|
|
50
50
|
ja: 当てはまる書き出しが {limit} 箇所あれば指摘
|
|
51
51
|
en: reported once there are {limit}
|
|
52
|
+
rewrite:
|
|
53
|
+
ja:
|
|
54
|
+
direction: どの文書にも当てはまる書き出し(「近年、〜が注目されています」)を消し、この文書だけが扱う状況か主張から始めてください。それが本文に無ければ書き手に聞きます。
|
|
55
|
+
pairs:
|
|
56
|
+
- before: 近年、生成 AI が注目されています。本記事では、社内での使い方を紹介します。
|
|
57
|
+
after: 社内で生成 AI を使うときの手順を紹介します。
|
|
58
|
+
- before: テレワークが普及する中、会議の進め方が見直されています。当社では週次会議を 30 分に短くしました。
|
|
59
|
+
after: 当社では週次会議を 30 分に短くしました。
|
|
60
|
+
keep:
|
|
61
|
+
- この文書だけの状況と主張
|
|
62
|
+
avoid:
|
|
63
|
+
- 書き出しを別の一般論(「今や〜は欠かせません」)に替える
|
|
64
|
+
- 本文に無い場面や逸話を作る
|
|
65
|
+
en:
|
|
66
|
+
direction: Delete the opening that fits any document ("In recent years, X has gained attention") and start from the situation or the claim only this piece has. If the body has none, ask the writer.
|
|
67
|
+
pairs:
|
|
68
|
+
- before: In recent years, generative AI has gained attention. This article shows how we use it internally.
|
|
69
|
+
after: This article shows how we use generative AI internally.
|
|
70
|
+
- before: As remote work spreads, meetings are being rethought. We cut our weekly meeting to 30 minutes.
|
|
71
|
+
after: We cut our weekly meeting to 30 minutes.
|
|
72
|
+
keep:
|
|
73
|
+
- the situation and claim only this piece has
|
|
74
|
+
avoid:
|
|
75
|
+
- swapping the opening for another generality ("X is now essential")
|
|
76
|
+
- inventing a scene or an anecdote that is not in the body
|
|
@@ -22,6 +22,14 @@ how_to_fix:
|
|
|
22
22
|
|
|
23
23
|
levels: { strict: 40, normal: 30, relaxed: 20 }
|
|
24
24
|
|
|
25
|
+
options:
|
|
26
|
+
min_paragraphs:
|
|
27
|
+
kind: count
|
|
28
|
+
default: 6
|
|
29
|
+
about:
|
|
30
|
+
ja: 測る段落の数の下限。段落が少ないと長さのばらつきは偶然で小さく出て、人の書いた文書でも揃って見えます
|
|
31
|
+
en: The fewest paragraphs measured. With few paragraphs, the variation is small by chance, and a person's writing looks uniform too
|
|
32
|
+
|
|
25
33
|
use_for: [blog, legal, docs, academic, literature, speech]
|
|
26
34
|
|
|
27
35
|
group: ai-tells
|
|
@@ -38,6 +46,10 @@ example:
|
|
|
38
46
|
|
|
39
47
|
続けて、仲間を招きます。左の端にある招待の画面で、相手の宛先を入れて送ってください。
|
|
40
48
|
|
|
49
|
+
それから、規則を選びます。設定の画面の中ほどで、使いたい規則の段階を一つずつ決めてください。
|
|
50
|
+
|
|
51
|
+
そのあとで、記録を残します。どの設定を変えたかを、仲間が読める場所に書き留めてください。
|
|
52
|
+
|
|
41
53
|
最後に、動きを確かめます。試しの文書を一つ置いて、指摘が画面に出ることを見てください。
|
|
42
54
|
after: |
|
|
43
55
|
最初に、道具を手元に入れます。
|
|
@@ -46,6 +58,10 @@ example:
|
|
|
46
58
|
|
|
47
59
|
続けて、仲間を招きます。
|
|
48
60
|
|
|
61
|
+
それから、規則を選びます。
|
|
62
|
+
|
|
63
|
+
そのあとで、記録を残します。どの設定を変えたかを、仲間が読める場所に書き留めてください。変えた理由も一言添えておくと、半年後の自分が助かります。
|
|
64
|
+
|
|
49
65
|
最後に、動きを確かめます。試しの文書を一つ置いて、指摘が画面に出ることを見てください。
|
|
50
66
|
en:
|
|
51
67
|
config: { genre: blog/tech }
|
|
@@ -56,6 +72,10 @@ example:
|
|
|
56
72
|
|
|
57
73
|
Then, invite your team. Enter their addresses on the invite page on the left and press send.
|
|
58
74
|
|
|
75
|
+
After that, choose the rules. In the middle of the settings page, set the level of each rule you want.
|
|
76
|
+
|
|
77
|
+
Then, write it down. Note which settings you changed in a place where your team can read it.
|
|
78
|
+
|
|
59
79
|
Finally, check that it works. Add a sample document and look for the findings on the screen.
|
|
60
80
|
after: |
|
|
61
81
|
First, install the tool.
|
|
@@ -64,11 +84,15 @@ example:
|
|
|
64
84
|
|
|
65
85
|
Then, invite your team.
|
|
66
86
|
|
|
87
|
+
After that, choose the rules.
|
|
88
|
+
|
|
89
|
+
Then, write it down. Note which settings you changed in a place where your team can read it. Add a line on why, too; it will help you in six months.
|
|
90
|
+
|
|
67
91
|
Finally, check that it works. Add a sample document and look for the findings on the screen.
|
|
68
92
|
|
|
69
93
|
not_flagged:
|
|
70
|
-
ja:
|
|
71
|
-
en: Business and technical genres do not run this rule.
|
|
94
|
+
ja: 段落が 6 より少ない文書は見ません(min_paragraphs で変えられます)。ビジネス文書と技術文書のジャンルでは見ません。
|
|
95
|
+
en: Documents with fewer than 6 paragraphs are not checked (min_paragraphs changes it). Business and technical genres do not run this rule.
|
|
72
96
|
level_meaning:
|
|
73
97
|
ja: 段落の長さのばらつきが {limit}% 未満なら指摘
|
|
74
98
|
en: reported when paragraph length varies by less than {limit}%
|
|
@@ -15,14 +15,18 @@ why:
|
|
|
15
15
|
en: A run of product, company and person names hides the shape of the sentence from anyone who does not already know them. It reads fine to the person who wrote it.
|
|
16
16
|
|
|
17
17
|
message:
|
|
18
|
-
ja: 1000
|
|
18
|
+
ja: 1000 字あたり {density} 個の固有名詞があります({limit} 個まで)
|
|
19
19
|
en: "{density} proper {density|noun|nouns} per 1000 words (limit {limit})"
|
|
20
20
|
|
|
21
21
|
how_to_fix:
|
|
22
22
|
ja: 2 度目からは「その製品」「そのチーム」のように受けてください。初出で何者かを一言添えると、知らない人も読めます。
|
|
23
23
|
en: After first use, refer back to it. One phrase saying what it is lets a stranger keep reading.
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
# 英語は 1000 語あたり。英語の人の書いた文書(コーパスと Project Gutenberg の小説・随筆)で測ると、名前の多さの分布の
|
|
26
|
+
# 95 パーセンタイルあたりに normal を置く。測り方とその値は PR に残した(数字はここに書かない)。
|
|
27
|
+
levels:
|
|
28
|
+
ja: { strict: 20, normal: 40, relaxed: 80 }
|
|
29
|
+
en: { strict: 150, normal: 200, relaxed: 260 }
|
|
26
30
|
|
|
27
31
|
use_for: [blog, business, technical, legal, docs, academic, literature, speech]
|
|
28
32
|
|
|
@@ -39,15 +43,20 @@ example:
|
|
|
39
43
|
after: |
|
|
40
44
|
営業部の二人が、取引先三社の展示を見てから、大阪で別の取引先の担当者と会いました。翌日は関西の二社を回り、名古屋に戻って取引先二社に報告しました。
|
|
41
45
|
en:
|
|
46
|
+
config: { rules: { proper-noun-density: strict } }
|
|
42
47
|
pad: true
|
|
43
48
|
before: |
|
|
44
|
-
Alice and Bob from Contoso met Carol from Fabrikam in Seattle, then flew with Dave from Northwind to Boston to see Erin at Tailspin and Frank at Litware.
|
|
49
|
+
Alice Moreno and Bob Tanaka from Contoso met Carol Diaz from Fabrikam in Seattle, then flew with Dave Okafor from Northwind to Boston to see Erin Walsh at Tailspin and Frank Liu at Litware.
|
|
50
|
+
In Chicago, Grace Kim of Proseware and Henry Park of Wingtip joined Ivan Petrov of Adatum, and Julia Rossi of Contoso brought Kevin Shah of Fabrikam.
|
|
51
|
+
From Denver, Laura Chen of Northwind and Mark Evans of Tailspin called Nina Alvarez of Litware, Oscar Grant of Proseware and Paula Novak of Wingtip.
|
|
45
52
|
after: |
|
|
46
53
|
Two of our sales team met three customers on the West Coast, then flew to Boston to meet two more.
|
|
54
|
+
In Chicago, three partners joined them, and our account lead brought a fourth.
|
|
55
|
+
From Denver, two of the team called the remaining customers.
|
|
47
56
|
|
|
48
57
|
not_flagged:
|
|
49
58
|
ja: chaff.yaml の names に書いた名前は、何語に分かれても 1 つと数えます。短い文書(日本語 500 字、英語 200 語より短いもの)は測りません。
|
|
50
59
|
en: A name listed under names in chaff.yaml counts as one, however many words it has. Short documents (under 200 words) are not measured.
|
|
51
60
|
level_meaning:
|
|
52
|
-
ja: 1000
|
|
53
|
-
en: up to {limit} per 1000 words
|
|
61
|
+
ja: 1000 字あたり固有名詞 {limit} 個まで
|
|
62
|
+
en: up to {limit} proper nouns per 1000 words
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
id: ra-nuki
|
|
2
|
+
layer: L2
|
|
3
|
+
status: experimental
|
|
4
|
+
how_to_find: ra-nuki
|
|
5
|
+
# 一段動詞かどうかは品詞解析で読む。品詞が無ければ動かない。
|
|
6
|
+
requires: [pos]
|
|
7
|
+
languages: [ja]
|
|
8
|
+
severity: warning
|
|
9
|
+
|
|
10
|
+
name:
|
|
11
|
+
ja: ら抜き言葉
|
|
12
|
+
en: Potential form without ra
|
|
13
|
+
|
|
14
|
+
why:
|
|
15
|
+
ja: 一段動詞とカ変動詞の可能の形は「られる」です(見られる・食べられる・来られる)。「見れる」「食べれる」「来れる」は話し言葉では広く使われますが、書き言葉では誤りと読まれます。五段動詞の可能の形(走れる・帰れる)は正しいので指しません。どの動詞が一段動詞かは品詞解析で読みます。鉤括弧や引用符で引いた言葉(話した言葉をそのまま引いたもの)は数えません。話し言葉と文学のジャンルでは既定で止めています。
|
|
16
|
+
en: The potential form of an ichidan verb or of 来る takes られる (見られる, 食べられる, 来られる). 見れる, 食べれる and 来れる are common in speech but read as mistakes in writing. The potential of a godan verb (走れる, 帰れる) is correct and is not reported. Which verbs are ichidan is read by the morphological analyser. Words quoted in brackets or quotation marks (speech quoted as spoken) are not counted. The speech and literature presets turn it off.
|
|
17
|
+
|
|
18
|
+
message:
|
|
19
|
+
ja: 「{matched}」は「ら」の抜けた形です
|
|
20
|
+
en: '"{matched}" drops the ら of the potential form'
|
|
21
|
+
|
|
22
|
+
how_to_fix:
|
|
23
|
+
ja: 「ら」を入れてください(見れる → 見られる、食べれる → 食べられる、来れる → 来られる)。
|
|
24
|
+
en: Put the ら back (見れる → 見られる, 食べれる → 食べられる, 来れる → 来られる).
|
|
25
|
+
|
|
26
|
+
levels: { strict: error, normal: warning, relaxed: info }
|
|
27
|
+
|
|
28
|
+
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
29
|
+
|
|
30
|
+
group: wording
|
|
31
|
+
summary:
|
|
32
|
+
ja: 「見れる」「食べれる」「来れる」のような、ら抜き言葉
|
|
33
|
+
en: A Japanese potential form without ら, such as 見れる for 見られる
|
|
34
|
+
example:
|
|
35
|
+
ja:
|
|
36
|
+
before: |
|
|
37
|
+
資料は明日から見れます。
|
|
38
|
+
after: |
|
|
39
|
+
資料は明日から見られます。
|
|
40
|
+
|
|
41
|
+
not_flagged:
|
|
42
|
+
ja: 五段動詞の可能の形(走れる・帰れる)、鉤括弧や引用符で引いた言葉は指しません。話し言葉と文学のジャンルでは既定で止めています。
|
|
43
|
+
en: The potential of godan verbs (走れる, 帰れる) and quoted words are not reported. The speech and literature presets turn it off.
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
id: requirement-modal
|
|
2
|
+
layer: L2
|
|
3
|
+
status: experimental
|
|
4
|
+
how_to_find: requirement-modal
|
|
5
|
+
# 何を見るかは options で決める。決めなければ何も見ない。語は言語ごとの語彙表 requirement-modal-<standard> と requirement-modal-must にある。
|
|
6
|
+
uses: [pos]
|
|
7
|
+
severity: warning
|
|
8
|
+
|
|
9
|
+
name:
|
|
10
|
+
ja: 規定の文末が、決めた書き方と違う
|
|
11
|
+
en: A provision's verb form is not the one the house rule uses
|
|
12
|
+
|
|
13
|
+
why:
|
|
14
|
+
ja: 規格や規程は、要求・推奨・許容を文末の形で書き分けます。読み手は文末で、守らなければならないのか、望ましいだけなのか、してもよいのかを読み取ります。JIS Z 8301:2019 は、推奨に「…すべきである」を、許容と可能性に文末の「…できる」を使わないと決め、「…することが望ましい」「…してもよい」「…可能である」を使います。英語では、米国連邦政府の Plain Language Guidelines が、義務には曖昧な "shall" ではなく "must" を使うとしています。どちらもチームが選ぶ決まりなので、options で決めたときだけ見ます。
|
|
15
|
+
en: 'A standard or a set of rules tells a requirement from a recommendation and a permission by the form of the verb, and the reader takes from it whether something must be done, should be done or may be done. JIS Z 8301:2019 does not use 「…すべきである」 for a recommendation or a closing 「…できる」 for a permission or a possibility; it uses 「…することが望ましい」, 「…してもよい」 and 「…可能である」. In English, the Federal Plain Language Guidelines use "must" for an obligation instead of "shall", which readers and courts take in more than one way. Both are a team''s choice, so the rule checks only what options turn on.'
|
|
16
|
+
|
|
17
|
+
message:
|
|
18
|
+
ja: 「{matched}」は使わない形です。「{preferred}」と書きます
|
|
19
|
+
en: 'Write "{preferred}" instead of "{matched}"'
|
|
20
|
+
|
|
21
|
+
how_to_fix:
|
|
22
|
+
ja: 文が言っていることが要求・推奨・許容・可能性のどれかを決めて、その形に直してください。推奨なら「…することが望ましい」、許容なら「…してもよい」、可能性なら「…可能である」「…場合がある」です。
|
|
23
|
+
en: 'Decide whether the sentence states an obligation and write "must" ("must not" for a prohibition). Keep "shall" only where a law you quote uses it.'
|
|
24
|
+
|
|
25
|
+
placeholders:
|
|
26
|
+
matched:
|
|
27
|
+
ja: 見つけた形
|
|
28
|
+
en: the form found
|
|
29
|
+
preferred:
|
|
30
|
+
ja: 使う形
|
|
31
|
+
en: the form to use
|
|
32
|
+
|
|
33
|
+
levels: { strict: error, normal: warning, relaxed: info }
|
|
34
|
+
|
|
35
|
+
options:
|
|
36
|
+
standard:
|
|
37
|
+
kind: choice
|
|
38
|
+
default: none
|
|
39
|
+
about:
|
|
40
|
+
ja: 規定の文末を、どの規格の決まりで見るか(日本語)
|
|
41
|
+
en: Which standard's verbal forms a Japanese provision is checked against
|
|
42
|
+
choices:
|
|
43
|
+
none:
|
|
44
|
+
ja: 見ない
|
|
45
|
+
en: Not checked
|
|
46
|
+
jis-z8301-2019:
|
|
47
|
+
ja: JIS Z 8301:2019 の 7.3〜7.5。文末の「すべきである」「すべきでない」「できる」「できない」を指す
|
|
48
|
+
en: "JIS Z 8301:2019, 7.3 to 7.5: a closing すべきである, すべきでない, できる or できない"
|
|
49
|
+
shall:
|
|
50
|
+
kind: choice
|
|
51
|
+
default: allow
|
|
52
|
+
about:
|
|
53
|
+
ja: 英語の "shall" を見るか
|
|
54
|
+
en: Whether "shall" is checked in English
|
|
55
|
+
choices:
|
|
56
|
+
allow:
|
|
57
|
+
ja: 見ない
|
|
58
|
+
en: Not checked
|
|
59
|
+
must:
|
|
60
|
+
ja: '"shall" を指し、"must" と書かせる(Federal Plain Language Guidelines)'
|
|
61
|
+
en: 'Point at "shall" and ask for "must" (Federal Plain Language Guidelines)'
|
|
62
|
+
|
|
63
|
+
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
64
|
+
sources: [jis-z8301-2019, plain-2011]
|
|
65
|
+
|
|
66
|
+
group: team
|
|
67
|
+
summary:
|
|
68
|
+
ja: 規格・規程の文末が、チームの選んだ決まり(JIS Z 8301:2019 など)と違う所。options で決めたときだけ見ます
|
|
69
|
+
en: A provision's verb form that the house rule the team picked does not use ("shall" under the Federal Plain Language Guidelines); checked only when options pick one
|
|
70
|
+
example:
|
|
71
|
+
ja:
|
|
72
|
+
before: |
|
|
73
|
+
試験の前に、試料を乾燥させるべきである。
|
|
74
|
+
after: |
|
|
75
|
+
試験の前に、試料を乾燥させることが望ましい。
|
|
76
|
+
config:
|
|
77
|
+
genre: technical/spec
|
|
78
|
+
options:
|
|
79
|
+
requirement-modal:
|
|
80
|
+
standard: jis-z8301-2019
|
|
81
|
+
en:
|
|
82
|
+
before: |
|
|
83
|
+
The supplier shall deliver the goods within 30 days.
|
|
84
|
+
after: |
|
|
85
|
+
The supplier must deliver the goods within 30 days.
|
|
86
|
+
config:
|
|
87
|
+
genre: technical/spec
|
|
88
|
+
options:
|
|
89
|
+
requirement-modal:
|
|
90
|
+
shall: must
|
|
91
|
+
|
|
92
|
+
not_flagged:
|
|
93
|
+
ja: options で決めなければ何も見ません。「できる」は文の終わりだけを見ます(JIS は能力を示す「できる」を文の途中で使うのを認めています)。
|
|
94
|
+
en: Nothing is checked until options pick a standard. In Japanese, できる is checked only at the end of a sentence, since JIS allows it mid-sentence for an ability.
|