chaffjs 0.17.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 +26 -0
- package/dist/announced-count.d.ts.map +1 -0
- package/dist/announced-count.js +138 -0
- package/dist/announced-count.js.map +1 -0
- 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/bare-url.d.ts +14 -0
- package/dist/bare-url.d.ts.map +1 -0
- package/dist/bare-url.js +28 -0
- package/dist/bare-url.js.map +1 -0
- package/dist/baseline.d.ts +5 -0
- package/dist/baseline.d.ts.map +1 -1
- package/dist/baseline.js +16 -1
- package/dist/baseline.js.map +1 -1
- package/dist/body-section.d.ts +7 -0
- package/dist/body-section.d.ts.map +1 -0
- package/dist/body-section.js +6 -0
- package/dist/body-section.js.map +1 -0
- package/dist/calendar-number.d.ts +2 -0
- package/dist/calendar-number.d.ts.map +1 -1
- package/dist/calendar-number.js +9 -2
- package/dist/calendar-number.js.map +1 -1
- package/dist/cli-args.d.ts +4 -0
- package/dist/cli-args.d.ts.map +1 -1
- package/dist/cli-args.js +5 -0
- package/dist/cli-args.js.map +1 -1
- package/dist/cli-text.d.ts +0 -1
- package/dist/cli-text.d.ts.map +1 -1
- package/dist/cli-text.js +14 -18
- package/dist/cli-text.js.map +1 -1
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +83 -84
- 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 +15 -0
- package/dist/commands/compare.d.ts.map +1 -0
- package/dist/commands/compare.js +64 -0
- package/dist/commands/compare.js.map +1 -0
- 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 +19 -10
- 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 +15 -2
- package/dist/commands/feedback.d.ts.map +1 -1
- package/dist/commands/feedback.js +36 -6
- 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.d.ts.map +1 -1
- package/dist/commands/test.js +3 -5
- package/dist/commands/test.js.map +1 -1
- package/dist/commands/tree.d.ts +13 -0
- package/dist/commands/tree.d.ts.map +1 -1
- package/dist/commands/tree.js +35 -5
- package/dist/commands/tree.js.map +1 -1
- package/dist/compare/atom.d.ts +31 -0
- package/dist/compare/atom.d.ts.map +1 -0
- package/dist/compare/atom.js +4 -0
- package/dist/compare/atom.js.map +1 -0
- package/dist/compare/clock-time.d.ts +8 -0
- package/dist/compare/clock-time.d.ts.map +1 -0
- package/dist/compare/clock-time.js +68 -0
- package/dist/compare/clock-time.js.map +1 -0
- 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 +15 -0
- package/dist/compare/extract.d.ts.map +1 -0
- package/dist/compare/extract.js +60 -0
- package/dist/compare/extract.js.map +1 -0
- 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 +28 -0
- package/dist/compare/fact-text.d.ts.map +1 -0
- package/dist/compare/fact-text.js +61 -0
- package/dist/compare/fact-text.js.map +1 -0
- 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/markup-atoms.d.ts +11 -0
- package/dist/compare/markup-atoms.d.ts.map +1 -0
- package/dist/compare/markup-atoms.js +23 -0
- package/dist/compare/markup-atoms.js.map +1 -0
- package/dist/compare/match.d.ts +20 -0
- package/dist/compare/match.d.ts.map +1 -0
- package/dist/compare/match.js +84 -0
- package/dist/compare/match.js.map +1 -0
- package/dist/compare/outcome.d.ts +36 -0
- package/dist/compare/outcome.d.ts.map +1 -0
- package/dist/compare/outcome.js +46 -0
- package/dist/compare/outcome.js.map +1 -0
- package/dist/compare/proper-nouns.d.ts +19 -0
- package/dist/compare/proper-nouns.d.ts.map +1 -0
- package/dist/compare/proper-nouns.js +43 -0
- package/dist/compare/proper-nouns.js.map +1 -0
- package/dist/compare/render.d.ts +13 -0
- package/dist/compare/render.d.ts.map +1 -0
- package/dist/compare/render.js +64 -0
- package/dist/compare/render.js.map +1 -0
- package/dist/compare/spans.d.ts +9 -0
- package/dist/compare/spans.d.ts.map +1 -0
- package/dist/compare/spans.js +11 -0
- package/dist/compare/spans.js.map +1 -0
- package/dist/compare/text-atoms.d.ts +27 -0
- package/dist/compare/text-atoms.d.ts.map +1 -0
- package/dist/compare/text-atoms.js +69 -0
- package/dist/compare/text-atoms.js.map +1 -0
- package/dist/compare/text.d.ts +24 -0
- package/dist/compare/text.d.ts.map +1 -0
- package/dist/compare/text.js +90 -0
- package/dist/compare/text.js.map +1 -0
- package/dist/compare/tree-atoms.d.ts +20 -0
- package/dist/compare/tree-atoms.d.ts.map +1 -0
- package/dist/compare/tree-atoms.js +58 -0
- package/dist/compare/tree-atoms.js.map +1 -0
- package/dist/compare/written-names.d.ts +8 -0
- package/dist/compare/written-names.d.ts.map +1 -0
- package/dist/compare/written-names.js +24 -0
- package/dist/compare/written-names.js.map +1 -0
- package/dist/config/load.d.ts +23 -0
- package/dist/config/load.d.ts.map +1 -1
- package/dist/config/load.js +6 -0
- package/dist/config/load.js.map +1 -1
- package/dist/config/option-problems.d.ts +17 -0
- package/dist/config/option-problems.d.ts.map +1 -0
- package/dist/config/option-problems.js +59 -0
- package/dist/config/option-problems.js.map +1 -0
- package/dist/config/read.d.ts +4 -0
- package/dist/config/read.d.ts.map +1 -0
- package/dist/config/read.js +8 -0
- package/dist/config/read.js.map +1 -0
- package/dist/config/rule-problems.d.ts +2 -4
- package/dist/config/rule-problems.d.ts.map +1 -1
- package/dist/config/rule-problems.js +7 -1
- package/dist/config/rule-problems.js.map +1 -1
- package/dist/config/style.d.ts +21 -0
- package/dist/config/style.d.ts.map +1 -0
- package/dist/config/style.js +48 -0
- package/dist/config/style.js.map +1 -0
- package/dist/config/warnings.d.ts +6 -0
- package/dist/config/warnings.d.ts.map +1 -0
- package/dist/config/warnings.js +10 -0
- package/dist/config/warnings.js.map +1 -0
- package/dist/config/write.d.ts.map +1 -1
- package/dist/config/write.js +17 -4
- package/dist/config/write.js.map +1 -1
- package/dist/custom/bounded-match.d.ts +15 -0
- package/dist/custom/bounded-match.d.ts.map +1 -0
- package/dist/custom/bounded-match.js +43 -0
- package/dist/custom/bounded-match.js.map +1 -0
- package/dist/custom/load.d.ts +11 -0
- package/dist/custom/load.d.ts.map +1 -0
- package/dist/custom/load.js +19 -0
- package/dist/custom/load.js.map +1 -0
- 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 +84 -0
- package/dist/custom/parse.d.ts.map +1 -0
- package/dist/custom/parse.js +258 -0
- package/dist/custom/parse.js.map +1 -0
- package/dist/custom/problems.d.ts +8 -0
- package/dist/custom/problems.d.ts.map +1 -0
- package/dist/custom/problems.js +95 -0
- package/dist/custom/problems.js.map +1 -0
- package/dist/custom/regex-safety.d.ts +11 -0
- package/dist/custom/regex-safety.d.ts.map +1 -0
- package/dist/custom/regex-safety.js +110 -0
- package/dist/custom/regex-safety.js.map +1 -0
- package/dist/custom/token-pattern.d.ts +8 -0
- package/dist/custom/token-pattern.d.ts.map +1 -0
- package/dist/custom/token-pattern.js +75 -0
- package/dist/custom/token-pattern.js.map +1 -0
- package/dist/detect-language.js +1 -1
- package/dist/detect.d.ts.map +1 -1
- package/dist/detect.js +30 -2
- package/dist/detect.js.map +1 -1
- package/dist/detectors/acronym-context.d.ts +2 -0
- package/dist/detectors/acronym-context.d.ts.map +1 -1
- package/dist/detectors/acronym-context.js +12 -4
- package/dist/detectors/acronym-context.js.map +1 -1
- package/dist/detectors/ai-phrasing.d.ts +23 -0
- package/dist/detectors/ai-phrasing.d.ts.map +1 -0
- package/dist/detectors/ai-phrasing.js +116 -0
- package/dist/detectors/ai-phrasing.js.map +1 -0
- package/dist/detectors/announced-count.d.ts +4 -0
- package/dist/detectors/announced-count.d.ts.map +1 -0
- package/dist/detectors/announced-count.js +20 -0
- package/dist/detectors/announced-count.js.map +1 -0
- 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/broken-link.d.ts +17 -0
- package/dist/detectors/broken-link.d.ts.map +1 -0
- package/dist/detectors/broken-link.js +66 -0
- package/dist/detectors/broken-link.js.map +1 -0
- package/dist/detectors/cited-name.d.ts.map +1 -1
- package/dist/detectors/cited-name.js +4 -4
- package/dist/detectors/cited-name.js.map +1 -1
- package/dist/detectors/cited-title.d.ts +11 -0
- package/dist/detectors/cited-title.d.ts.map +1 -0
- package/dist/detectors/cited-title.js +75 -0
- package/dist/detectors/cited-title.js.map +1 -0
- package/dist/detectors/concrete-evidence.d.ts +1 -1
- package/dist/detectors/concrete-evidence.d.ts.map +1 -1
- package/dist/detectors/concrete-evidence.js +2 -1
- package/dist/detectors/concrete-evidence.js.map +1 -1
- package/dist/detectors/contrast-frame.d.ts +17 -0
- package/dist/detectors/contrast-frame.d.ts.map +1 -0
- package/dist/detectors/contrast-frame.js +32 -0
- package/dist/detectors/contrast-frame.js.map +1 -0
- package/dist/detectors/custom.d.ts +8 -0
- package/dist/detectors/custom.d.ts.map +1 -0
- package/dist/detectors/custom.js +71 -0
- package/dist/detectors/custom.js.map +1 -0
- package/dist/detectors/dangling-figure.d.ts +7 -0
- package/dist/detectors/dangling-figure.d.ts.map +1 -0
- package/dist/detectors/dangling-figure.js +20 -0
- package/dist/detectors/dangling-figure.js.map +1 -0
- 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 +9 -0
- package/dist/detectors/doubled-punctuation.d.ts.map +1 -0
- package/dist/detectors/doubled-punctuation.js +35 -0
- package/dist/detectors/doubled-punctuation.js.map +1 -0
- package/dist/detectors/doubled-word.d.ts +5 -0
- package/dist/detectors/doubled-word.d.ts.map +1 -1
- package/dist/detectors/doubled-word.js +24 -11
- package/dist/detectors/doubled-word.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/enumerated-runs.d.ts +1 -1
- package/dist/detectors/enumerated-runs.d.ts.map +1 -1
- package/dist/detectors/enumerated-runs.js +15 -4
- package/dist/detectors/enumerated-runs.js.map +1 -1
- 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/gram-furniture.d.ts +6 -0
- package/dist/detectors/gram-furniture.d.ts.map +1 -0
- package/dist/detectors/gram-furniture.js +21 -0
- package/dist/detectors/gram-furniture.js.map +1 -0
- package/dist/detectors/gram-place.d.ts +2 -0
- package/dist/detectors/gram-place.d.ts.map +1 -1
- package/dist/detectors/gram-place.js +9 -7
- package/dist/detectors/gram-place.js.map +1 -1
- package/dist/detectors/gram-windows.d.ts +9 -0
- package/dist/detectors/gram-windows.d.ts.map +1 -0
- package/dist/detectors/gram-windows.js +27 -0
- package/dist/detectors/gram-windows.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-case.d.ts +2 -0
- package/dist/detectors/heading-case.d.ts.map +1 -1
- package/dist/detectors/heading-case.js +29 -2
- package/dist/detectors/heading-case.js.map +1 -1
- package/dist/detectors/heading-code-words.d.ts +6 -0
- package/dist/detectors/heading-code-words.d.ts.map +1 -0
- package/dist/detectors/heading-code-words.js +29 -0
- package/dist/detectors/heading-code-words.js.map +1 -0
- package/dist/detectors/heading-echo.d.ts.map +1 -1
- package/dist/detectors/heading-echo.js +7 -4
- package/dist/detectors/heading-echo.js.map +1 -1
- package/dist/detectors/heading-level-skip.d.ts +12 -0
- package/dist/detectors/heading-level-skip.d.ts.map +1 -0
- package/dist/detectors/heading-level-skip.js +11 -0
- package/dist/detectors/heading-level-skip.js.map +1 -0
- package/dist/detectors/image-alt-text.d.ts +3 -0
- package/dist/detectors/image-alt-text.d.ts.map +1 -0
- package/dist/detectors/image-alt-text.js +9 -0
- package/dist/detectors/image-alt-text.js.map +1 -0
- package/dist/detectors/index.d.ts.map +1 -1
- package/dist/detectors/index.js +70 -1
- 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.d.ts +24 -0
- package/dist/detectors/kutoten-consistency.d.ts.map +1 -0
- package/dist/detectors/kutoten-consistency.js +77 -0
- package/dist/detectors/kutoten-consistency.js.map +1 -0
- package/dist/detectors/lead-in.d.ts +1 -0
- package/dist/detectors/lead-in.d.ts.map +1 -1
- package/dist/detectors/lead-in.js +2 -1
- package/dist/detectors/lead-in.js.map +1 -1
- package/dist/detectors/lexicon-match.d.ts +14 -1
- package/dist/detectors/lexicon-match.d.ts.map +1 -1
- package/dist/detectors/lexicon-match.js +32 -2
- 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-item.d.ts +45 -0
- package/dist/detectors/list-item.d.ts.map +1 -0
- package/dist/detectors/list-item.js +88 -0
- package/dist/detectors/list-item.js.map +1 -0
- package/dist/detectors/list-items.d.ts +31 -0
- package/dist/detectors/list-items.d.ts.map +1 -0
- package/dist/detectors/list-items.js +113 -0
- package/dist/detectors/list-items.js.map +1 -0
- package/dist/detectors/list-lead-in.d.ts +7 -0
- package/dist/detectors/list-lead-in.d.ts.map +1 -0
- package/dist/detectors/list-lead-in.js +28 -0
- package/dist/detectors/list-lead-in.js.map +1 -0
- package/dist/detectors/list-sentence.d.ts +67 -0
- package/dist/detectors/list-sentence.d.ts.map +1 -0
- package/dist/detectors/list-sentence.js +130 -0
- package/dist/detectors/list-sentence.js.map +1 -0
- package/dist/detectors/list-view.d.ts +34 -0
- package/dist/detectors/list-view.d.ts.map +1 -0
- package/dist/detectors/list-view.js +137 -0
- package/dist/detectors/list-view.js.map +1 -0
- package/dist/detectors/long-vowel.d.ts +7 -0
- package/dist/detectors/long-vowel.d.ts.map +1 -0
- package/dist/detectors/long-vowel.js +71 -0
- package/dist/detectors/long-vowel.js.map +1 -0
- package/dist/detectors/markup-finding.d.ts +8 -0
- package/dist/detectors/markup-finding.d.ts.map +1 -0
- package/dist/detectors/markup-finding.js +29 -0
- package/dist/detectors/markup-finding.js.map +1 -0
- 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-numeral.d.ts +1 -1
- package/dist/detectors/name-numeral.d.ts.map +1 -1
- package/dist/detectors/name-numeral.js +2 -7
- package/dist/detectors/name-numeral.js.map +1 -1
- 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 +72 -37
- 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 +7 -1
- package/dist/detectors/oxford-comma.d.ts.map +1 -1
- package/dist/detectors/oxford-comma.js +136 -229
- 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/place-run.d.ts.map +1 -1
- package/dist/detectors/place-run.js +10 -6
- package/dist/detectors/place-run.js.map +1 -1
- package/dist/detectors/placeholder-text.d.ts +9 -0
- package/dist/detectors/placeholder-text.d.ts.map +1 -0
- package/dist/detectors/placeholder-text.js +18 -0
- package/dist/detectors/placeholder-text.js.map +1 -0
- package/dist/detectors/quote-around.d.ts +3 -0
- package/dist/detectors/quote-around.d.ts.map +1 -0
- package/dist/detectors/quote-around.js +8 -0
- package/dist/detectors/quote-around.js.map +1 -0
- 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/register.d.ts +11 -3
- package/dist/detectors/register.d.ts.map +1 -1
- package/dist/detectors/register.js +28 -9
- package/dist/detectors/register.js.map +1 -1
- 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/roman-numeral.d.ts +2 -0
- package/dist/detectors/roman-numeral.d.ts.map +1 -1
- package/dist/detectors/roman-numeral.js +2 -0
- package/dist/detectors/roman-numeral.js.map +1 -1
- package/dist/detectors/sentence-ending.d.ts +17 -1
- package/dist/detectors/sentence-ending.d.ts.map +1 -1
- package/dist/detectors/sentence-ending.js +13 -7
- package/dist/detectors/sentence-ending.js.map +1 -1
- package/dist/detectors/sentence-length.d.ts.map +1 -1
- package/dist/detectors/sentence-length.js +13 -4
- package/dist/detectors/sentence-length.js.map +1 -1
- package/dist/detectors/signals.d.ts +8 -0
- package/dist/detectors/signals.d.ts.map +1 -1
- package/dist/detectors/signals.js +67 -46
- package/dist/detectors/signals.js.map +1 -1
- 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 +6 -0
- package/dist/detectors/structure-tree.d.ts.map +1 -1
- package/dist/detectors/structure-tree.js +39 -1
- package/dist/detectors/structure-tree.js.map +1 -1
- package/dist/detectors/structure.d.ts +1 -3
- package/dist/detectors/structure.d.ts.map +1 -1
- package/dist/detectors/structure.js +19 -6
- 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/superlative-name.d.ts.map +1 -1
- package/dist/detectors/superlative-name.js +8 -5
- package/dist/detectors/superlative-name.js.map +1 -1
- package/dist/detectors/superlative-scope.d.ts.map +1 -1
- package/dist/detectors/superlative-scope.js +9 -4
- package/dist/detectors/superlative-scope.js.map +1 -1
- package/dist/detectors/token-column.d.ts +46 -0
- package/dist/detectors/token-column.d.ts.map +1 -0
- package/dist/detectors/token-column.js +95 -0
- package/dist/detectors/token-column.js.map +1 -0
- package/dist/detectors/unbalanced-bracket.d.ts +22 -0
- package/dist/detectors/unbalanced-bracket.d.ts.map +1 -0
- package/dist/detectors/unbalanced-bracket.js +119 -0
- package/dist/detectors/unbalanced-bracket.js.map +1 -0
- package/dist/detectors/url-run-on.d.ts +9 -0
- package/dist/detectors/url-run-on.d.ts.map +1 -0
- package/dist/detectors/url-run-on.js +24 -0
- package/dist/detectors/url-run-on.js.map +1 -0
- 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-sections.d.ts +13 -0
- package/dist/document-sections.d.ts.map +1 -0
- package/dist/document-sections.js +32 -0
- package/dist/document-sections.js.map +1 -0
- package/dist/document.d.ts +20 -7
- package/dist/document.d.ts.map +1 -1
- package/dist/document.js +140 -125
- package/dist/document.js.map +1 -1
- package/dist/email-parts.d.ts +28 -0
- package/dist/email-parts.d.ts.map +1 -0
- package/dist/email-parts.js +230 -0
- package/dist/email-parts.js.map +1 -0
- package/dist/eval.d.ts +2 -1
- package/dist/eval.d.ts.map +1 -1
- package/dist/eval.js +16 -4
- package/dist/eval.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 +39 -0
- package/dist/figure-references.d.ts.map +1 -0
- package/dist/figure-references.js +113 -0
- package/dist/figure-references.js.map +1 -0
- package/dist/files.d.ts +2 -0
- package/dist/files.d.ts.map +1 -1
- package/dist/files.js +4 -0
- package/dist/files.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/heading-label.d.ts +22 -0
- package/dist/heading-label.d.ts.map +1 -0
- package/dist/heading-label.js +50 -0
- package/dist/heading-label.js.map +1 -0
- package/dist/in-page-nav.d.ts +4 -1
- package/dist/in-page-nav.d.ts.map +1 -1
- package/dist/in-page-nav.js +53 -18
- package/dist/in-page-nav.js.map +1 -1
- package/dist/joined-view.d.ts.map +1 -1
- package/dist/joined-view.js +1 -0
- package/dist/joined-view.js.map +1 -1
- 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/levels.d.ts +5 -1
- package/dist/levels.d.ts.map +1 -1
- package/dist/levels.js +9 -0
- package/dist/levels.js.map +1 -1
- package/dist/line-paragraphs.d.ts +8 -0
- package/dist/line-paragraphs.d.ts.map +1 -1
- package/dist/line-paragraphs.js +33 -10
- package/dist/line-paragraphs.js.map +1 -1
- 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 +38 -0
- package/dist/long-vowel.d.ts.map +1 -0
- package/dist/long-vowel.js +78 -0
- package/dist/long-vowel.js.map +1 -0
- package/dist/markdown-node.d.ts +19 -0
- package/dist/markdown-node.d.ts.map +1 -0
- package/dist/markdown-node.js +6 -0
- package/dist/markdown-node.js.map +1 -0
- package/dist/markdown-read.d.ts +17 -0
- package/dist/markdown-read.d.ts.map +1 -0
- package/dist/markdown-read.js +37 -0
- package/dist/markdown-read.js.map +1 -0
- package/dist/markup.d.ts +22 -0
- package/dist/markup.d.ts.map +1 -0
- package/dist/markup.js +182 -0
- package/dist/markup.js.map +1 -0
- package/dist/mask.js +8 -5
- package/dist/mask.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/number-name.d.ts +21 -5
- package/dist/number-name.d.ts.map +1 -1
- package/dist/number-name.js +119 -17
- package/dist/number-name.js.map +1 -1
- package/dist/orthography.d.ts +10 -1
- package/dist/orthography.d.ts.map +1 -1
- package/dist/orthography.js +42 -16
- 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/page-furniture.d.ts +5 -2
- package/dist/page-furniture.d.ts.map +1 -1
- package/dist/page-furniture.js +8 -2
- package/dist/page-furniture.js.map +1 -1
- package/dist/plain-source.d.ts +1 -0
- package/dist/plain-source.d.ts.map +1 -1
- package/dist/plain-source.js +2 -1
- package/dist/plain-source.js.map +1 -1
- package/dist/plugin.d.ts +138 -1
- package/dist/plugin.d.ts.map +1 -1
- package/dist/profile/for-file.d.ts.map +1 -1
- package/dist/profile/for-file.js +3 -1
- package/dist/profile/for-file.js.map +1 -1
- package/dist/quoted-span.d.ts.map +1 -1
- package/dist/quoted-span.js +8 -3
- package/dist/quoted-span.js.map +1 -1
- package/dist/reasons.d.ts +4 -0
- package/dist/reasons.d.ts.map +1 -1
- package/dist/reasons.js +8 -0
- package/dist/reasons.js.map +1 -1
- package/dist/reference-lists.d.ts +3 -0
- package/dist/reference-lists.d.ts.map +1 -0
- package/dist/reference-lists.js +75 -0
- package/dist/reference-lists.js.map +1 -0
- 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 +9 -1
- package/dist/render/explain.d.ts.map +1 -1
- package/dist/render/explain.js +54 -13
- package/dist/render/explain.js.map +1 -1
- package/dist/render/friendly.d.ts.map +1 -1
- package/dist/render/friendly.js +19 -9
- package/dist/render/friendly.js.map +1 -1
- package/dist/render/options.d.ts +7 -0
- package/dist/render/options.d.ts.map +1 -0
- package/dist/render/options.js +50 -0
- package/dist/render/options.js.map +1 -0
- package/dist/render/rules-json.d.ts +4 -1
- package/dist/render/rules-json.d.ts.map +1 -1
- package/dist/render/rules-json.js +110 -16
- package/dist/render/rules-json.js.map +1 -1
- package/dist/render/rules-table.d.ts +4 -0
- package/dist/render/rules-table.d.ts.map +1 -0
- package/dist/render/rules-table.js +70 -0
- package/dist/render/rules-table.js.map +1 -0
- package/dist/render/sarif.js +4 -4
- package/dist/render/sarif.js.map +1 -1
- package/dist/render/semantic.js +3 -3
- package/dist/render/semantic.js.map +1 -1
- package/dist/render/severity-name.d.ts +6 -0
- package/dist/render/severity-name.d.ts.map +1 -0
- package/dist/render/severity-name.js +7 -0
- package/dist/render/severity-name.js.map +1 -0
- 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/render/text.d.ts +7 -2
- package/dist/render/text.d.ts.map +1 -1
- package/dist/render/text.js +15 -4
- package/dist/render/text.js.map +1 -1
- package/dist/resolve-genre.d.ts +1 -1
- package/dist/resolve-genre.d.ts.map +1 -1
- package/dist/resolve-genre.js +4 -1
- package/dist/resolve-genre.js.map +1 -1
- package/dist/rule-genres.d.ts +24 -0
- package/dist/rule-genres.d.ts.map +1 -0
- package/dist/rule-genres.js +11 -0
- package/dist/rule-genres.js.map +1 -0
- package/dist/rule-guide.d.ts +73 -0
- package/dist/rule-guide.d.ts.map +1 -0
- package/dist/rule-guide.js +95 -0
- package/dist/rule-guide.js.map +1 -0
- package/dist/rule-load.d.ts.map +1 -1
- package/dist/rule-load.js +87 -33
- package/dist/rule-load.js.map +1 -1
- package/dist/rule-options.d.ts +50 -0
- package/dist/rule-options.d.ts.map +1 -0
- package/dist/rule-options.js +106 -0
- package/dist/rule-options.js.map +1 -0
- 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 +18 -1
- package/dist/run.d.ts.map +1 -1
- package/dist/run.js +80 -19
- package/dist/run.js.map +1 -1
- package/dist/sentence-shape.d.ts.map +1 -1
- package/dist/sentence-shape.js +4 -4
- package/dist/sentence-shape.js.map +1 -1
- package/dist/setting-problems.d.ts +2 -1
- package/dist/setting-problems.d.ts.map +1 -1
- package/dist/setting-problems.js +8 -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/span-cut.d.ts +6 -0
- package/dist/span-cut.d.ts.map +1 -0
- package/dist/span-cut.js +22 -0
- package/dist/span-cut.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/aside-depth.d.ts +21 -0
- package/dist/structure/aside-depth.d.ts.map +1 -0
- package/dist/structure/aside-depth.js +65 -0
- package/dist/structure/aside-depth.js.map +1 -0
- package/dist/structure/build.d.ts +5 -1
- package/dist/structure/build.d.ts.map +1 -1
- package/dist/structure/build.js +29 -17
- package/dist/structure/build.js.map +1 -1
- package/dist/structure/closed-pairs.d.ts +8 -0
- package/dist/structure/closed-pairs.d.ts.map +1 -0
- package/dist/structure/closed-pairs.js +22 -0
- package/dist/structure/closed-pairs.js.map +1 -0
- package/dist/structure/date-range.d.ts +31 -0
- package/dist/structure/date-range.d.ts.map +1 -0
- package/dist/structure/date-range.js +77 -0
- package/dist/structure/date-range.js.map +1 -0
- 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/known-mentions.d.ts +18 -0
- package/dist/structure/known-mentions.d.ts.map +1 -0
- package/dist/structure/known-mentions.js +78 -0
- package/dist/structure/known-mentions.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/numbering.d.ts +1 -0
- package/dist/structure/numbering.d.ts.map +1 -1
- package/dist/structure/numbering.js +11 -6
- package/dist/structure/numbering.js.map +1 -1
- package/dist/structure/of.d.ts +3 -1
- package/dist/structure/of.d.ts.map +1 -1
- package/dist/structure/of.js +5 -1
- package/dist/structure/of.js.map +1 -1
- package/dist/structure/percent-sum.d.ts +16 -0
- package/dist/structure/percent-sum.d.ts.map +1 -0
- package/dist/structure/percent-sum.js +104 -0
- package/dist/structure/percent-sum.js.map +1 -0
- package/dist/structure/quoted-number.d.ts +8 -0
- package/dist/structure/quoted-number.d.ts.map +1 -0
- package/dist/structure/quoted-number.js +34 -0
- package/dist/structure/quoted-number.js.map +1 -0
- package/dist/structure/relative-find.d.ts.map +1 -1
- package/dist/structure/relative-find.js +34 -46
- package/dist/structure/relative-find.js.map +1 -1
- package/dist/structure/relative-resolve.d.ts.map +1 -1
- package/dist/structure/relative-resolve.js +76 -30
- package/dist/structure/relative-resolve.js.map +1 -1
- package/dist/structure/runs.d.ts +2 -0
- package/dist/structure/runs.d.ts.map +1 -1
- package/dist/structure/runs.js +2 -2
- package/dist/structure/runs.js.map +1 -1
- package/dist/structure/sexp.d.ts +1 -1
- package/dist/structure/sexp.d.ts.map +1 -1
- package/dist/structure/sexp.js +18 -6
- package/dist/structure/sexp.js.map +1 -1
- package/dist/structure/total.d.ts +3 -0
- package/dist/structure/total.d.ts.map +1 -1
- package/dist/structure/total.js +2 -2
- package/dist/structure/total.js.map +1 -1
- package/dist/structure/universal.d.ts +14 -2
- package/dist/structure/universal.d.ts.map +1 -1
- package/dist/structure/universal.js +24 -3
- package/dist/structure/universal.js.map +1 -1
- package/dist/structure/wrapped-tail.d.ts +14 -7
- package/dist/structure/wrapped-tail.d.ts.map +1 -1
- package/dist/structure/wrapped-tail.js +33 -8
- package/dist/structure/wrapped-tail.js.map +1 -1
- package/dist/style-load.d.ts +4 -0
- package/dist/style-load.d.ts.map +1 -0
- package/dist/style-load.js +28 -0
- package/dist/style-load.js.map +1 -0
- package/dist/style-parse.d.ts +25 -0
- package/dist/style-parse.d.ts.map +1 -0
- package/dist/style-parse.js +88 -0
- package/dist/style-parse.js.map +1 -0
- package/dist/subheading-line.d.ts +23 -0
- package/dist/subheading-line.d.ts.map +1 -0
- package/dist/subheading-line.js +85 -0
- package/dist/subheading-line.js.map +1 -0
- 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/dist/template-syntax.d.ts +17 -0
- package/dist/template-syntax.d.ts.map +1 -0
- package/dist/template-syntax.js +140 -0
- package/dist/template-syntax.js.map +1 -0
- package/dist/text-above.d.ts +19 -0
- package/dist/text-above.d.ts.map +1 -0
- package/dist/text-above.js +43 -0
- package/dist/text-above.js.map +1 -0
- package/dist/text-figures.d.ts +10 -0
- package/dist/text-figures.d.ts.map +1 -0
- package/dist/text-figures.js +131 -0
- package/dist/text-figures.js.map +1 -0
- package/dist/trailing-aside.d.ts +2 -0
- package/dist/trailing-aside.d.ts.map +1 -0
- package/dist/trailing-aside.js +53 -0
- package/dist/trailing-aside.js.map +1 -0
- package/dist/tree-walk.d.ts +18 -0
- package/dist/tree-walk.d.ts.map +1 -0
- package/dist/tree-walk.js +45 -0
- package/dist/tree-walk.js.map +1 -0
- package/genres.yaml +68 -0
- package/package.json +9 -3
- package/reference-headings.yaml +17 -0
- package/rules/acronym-expansion-conflict.yaml +82 -0
- package/rules/adverb-overuse.yaml +19 -0
- package/rules/agentless-passive.yaml +47 -0
- package/rules/agreement-slip.yaml +14 -1
- package/rules/ai-generated-composite.yaml +102 -0
- package/rules/ai-tell.yaml +57 -0
- package/rules/announced-count-mismatch.yaml +57 -0
- package/rules/announcing-opener.yaml +82 -0
- package/rules/assistant-residue.yaml +82 -0
- package/rules/bold-density.yaml +59 -0
- package/rules/bold-label-list.yaml +81 -0
- package/rules/broken-link.yaml +65 -0
- package/rules/closing-cliche.yaml +58 -0
- package/rules/colon-lead-in.yaml +83 -0
- package/rules/concrete-evidence-density.yaml +41 -0
- package/rules/contraction-consistency.yaml +18 -0
- package/rules/contrast-framing.yaml +88 -0
- package/rules/cushion-phrase-density.yaml +53 -1
- package/rules/dangling-figure-reference.yaml +61 -0
- package/rules/dangling-reference.yaml +54 -1
- package/rules/date-order.yaml +34 -1
- package/rules/date-range-reversed.yaml +46 -0
- package/rules/date-weekday-mismatch.yaml +17 -1
- package/rules/double-keigo.yaml +16 -0
- package/rules/double-negative.yaml +51 -0
- package/rules/doubled-punctuation.yaml +45 -0
- package/rules/doubled-word.yaml +18 -2
- package/rules/duplicate-definition.yaml +59 -1
- package/rules/duplicate-heading.yaml +78 -0
- package/rules/emoji-density.yaml +28 -2
- package/rules/empty-conclusion.yaml +28 -0
- package/rules/empty-intensifier.yaml +44 -0
- package/rules/empty-section.yaml +74 -0
- package/rules/excessive-hedging.yaml +49 -2
- package/rules/expletive-construction.yaml +19 -0
- package/rules/fullwidth-alnum-consistency.yaml +53 -0
- package/rules/hankaku-kana.yaml +41 -0
- package/rules/heading-echo.yaml +31 -0
- package/rules/heading-level-skip.yaml +78 -0
- package/rules/hiragana-fukushi.yaml +16 -0
- package/rules/image-alt-text.yaml +54 -0
- package/rules/internal-jargon.yaml +21 -0
- package/rules/invisible-character.yaml +63 -0
- package/rules/katakana-long-vowel.yaml +99 -0
- package/rules/kutoten-consistency.yaml +53 -0
- package/rules/latin-spacing.yaml +30 -4
- package/rules/max-kanji-continuous.yaml +17 -0
- package/rules/max-paragraph-length.yaml +34 -0
- package/rules/max-sentence-length.yaml +58 -0
- package/rules/modal-conflict.yaml +106 -0
- package/rules/name-variant.yaml +88 -0
- package/rules/ngram-repetition.yaml +29 -2
- package/rules/no-doubled-joshi.yaml +17 -0
- package/rules/no-em-dash.yaml +49 -0
- package/rules/no-mixed-desumasu.yaml +28 -2
- package/rules/no-nakaguro-parallel.yaml +20 -0
- package/rules/nominalization.yaml +89 -0
- package/rules/numbering-gap.yaml +53 -1
- package/rules/outside-announced-list.yaml +80 -0
- package/rules/oxford-comma-consistency.yaml +18 -0
- package/rules/padded-intro.yaml +44 -0
- package/rules/paragraph-length-variance.yaml +73 -0
- package/rules/percent-sum-mismatch.yaml +58 -0
- package/rules/preamble-length.yaml +56 -0
- package/rules/preferred-term.yaml +28 -0
- package/rules/proper-noun-density.yaml +37 -2
- package/rules/ra-nuki.yaml +43 -0
- package/rules/repeated-conjunction.yaml +47 -0
- package/rules/repeated-sentence-head.yaml +23 -0
- package/rules/required-sections.yaml +49 -0
- package/rules/requirement-modal.yaml +94 -0
- package/rules/requirement-smell.yaml +70 -0
- package/rules/risk-disclosure.yaml +22 -0
- package/rules/rule-of-three.yaml +143 -0
- package/rules/sasete-itadaku.yaml +18 -0
- package/rules/section-length-uniformity.yaml +113 -0
- package/rules/sentence-initial-conjunction-run.yaml +18 -0
- package/rules/sentence-rhythm.yaml +51 -0
- package/rules/space-before-punctuation.yaml +41 -0
- package/rules/spelling-consistency.yaml +47 -0
- package/rules/stock-transition.yaml +86 -0
- package/rules/stray-space.yaml +18 -0
- package/rules/taigen-dome-in-prose.yaml +33 -0
- package/rules/title-case-consistency.yaml +42 -0
- package/rules/total-mismatch.yaml +38 -1
- package/rules/unbalanced-bracket.yaml +56 -0
- package/rules/undefined-acronym.yaml +23 -0
- package/rules/unfilled-placeholder.yaml +50 -0
- package/rules/unqualified-superlative.yaml +20 -0
- package/rules/unsourced-number.yaml +16 -0
- package/rules/unused-definition.yaml +75 -0
- package/rules/url-run-on.yaml +45 -0
- package/rules/use-before-definition.yaml +77 -0
- package/rules/vague-figure-reference.yaml +66 -0
- package/skills/chaff/SKILL.md +171 -1
- package/src/acronym-expansions.ts +106 -0
- package/src/announced-count.ts +190 -0
- package/src/announced-list.ts +120 -0
- package/src/api.ts +154 -0
- package/src/bare-url.ts +35 -0
- package/src/baseline.ts +17 -1
- package/src/body-section.ts +7 -0
- package/src/calendar-number.ts +18 -4
- package/src/cli-args.ts +6 -0
- package/src/cli-text.ts +14 -15
- package/src/cli.ts +93 -92
- package/src/closing-paragraph.ts +24 -0
- package/src/commands/compare.ts +73 -0
- package/src/commands/document-commands.ts +19 -0
- package/src/commands/eval.ts +22 -10
- package/src/commands/facts.ts +33 -0
- package/src/commands/feedback.ts +45 -7
- 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 +3 -5
- package/src/commands/tree.ts +41 -5
- package/src/compare/atom.ts +33 -0
- package/src/compare/clock-time.ts +89 -0
- package/src/compare/distinct.ts +13 -0
- package/src/compare/extract.ts +80 -0
- package/src/compare/fact-key.ts +31 -0
- package/src/compare/fact-text.ts +87 -0
- package/src/compare/facts-render.ts +63 -0
- package/src/compare/facts-text.ts +41 -0
- package/src/compare/markup-atoms.ts +29 -0
- package/src/compare/match.ts +105 -0
- package/src/compare/outcome.ts +80 -0
- package/src/compare/proper-nouns.ts +65 -0
- package/src/compare/render.ts +102 -0
- package/src/compare/spans.ts +17 -0
- package/src/compare/text-atoms.ts +96 -0
- package/src/compare/text.ts +121 -0
- package/src/compare/tree-atoms.ts +80 -0
- package/src/compare/written-names.ts +26 -0
- package/src/config/load.ts +30 -0
- package/src/config/option-problems.ts +72 -0
- package/src/config/read.ts +8 -0
- package/src/config/rule-problems.ts +12 -2
- package/src/config/style.ts +55 -0
- package/src/config/warnings.ts +13 -0
- package/src/config/write.ts +18 -4
- package/src/custom/bounded-match.ts +58 -0
- package/src/custom/load.ts +23 -0
- package/src/custom/module-path.ts +23 -0
- package/src/custom/parse.ts +323 -0
- package/src/custom/problems.ts +111 -0
- package/src/custom/regex-safety.ts +118 -0
- package/src/custom/token-pattern.ts +84 -0
- package/src/detect-language.ts +1 -1
- package/src/detect.ts +35 -2
- package/src/detectors/acronym-context.ts +16 -4
- package/src/detectors/ai-phrasing.ts +141 -0
- package/src/detectors/announced-count.ts +25 -0
- package/src/detectors/bold-label.ts +55 -0
- package/src/detectors/broken-link.ts +90 -0
- package/src/detectors/cited-name.ts +6 -5
- package/src/detectors/cited-title.ts +96 -0
- package/src/detectors/concrete-evidence.ts +3 -2
- package/src/detectors/contrast-frame.ts +54 -0
- package/src/detectors/custom.ts +89 -0
- package/src/detectors/dangling-figure.ts +26 -0
- package/src/detectors/definition-use.ts +41 -0
- package/src/detectors/doubled-punctuation.ts +52 -0
- package/src/detectors/doubled-word.ts +19 -4
- package/src/detectors/duplicate-heading.ts +47 -0
- package/src/detectors/empty-section.ts +21 -0
- package/src/detectors/enumerated-runs.ts +13 -4
- package/src/detectors/fullwidth-alnum.ts +118 -0
- package/src/detectors/gram-furniture.ts +30 -0
- package/src/detectors/gram-place.ts +9 -5
- package/src/detectors/gram-windows.ts +31 -0
- package/src/detectors/hankaku-kana.ts +38 -0
- package/src/detectors/heading-case.ts +30 -2
- package/src/detectors/heading-code-words.ts +35 -0
- package/src/detectors/heading-echo.ts +8 -4
- package/src/detectors/heading-level-skip.ts +19 -0
- package/src/detectors/image-alt-text.ts +11 -0
- package/src/detectors/index.ts +79 -1
- package/src/detectors/invisible-character.ts +190 -0
- package/src/detectors/kutoten-consistency.ts +96 -0
- package/src/detectors/lead-in.ts +3 -1
- package/src/detectors/lexicon-match.ts +41 -2
- package/src/detectors/lexicon.ts +40 -13
- package/src/detectors/list-item.ts +122 -0
- package/src/detectors/list-items.ts +163 -0
- package/src/detectors/list-lead-in.ts +33 -0
- package/src/detectors/list-sentence.ts +198 -0
- package/src/detectors/list-view.ts +157 -0
- package/src/detectors/long-vowel.ts +82 -0
- package/src/detectors/markup-finding.ts +39 -0
- package/src/detectors/modal-conflict.ts +26 -0
- package/src/detectors/name-numeral.ts +4 -2
- package/src/detectors/name-variant.ts +15 -0
- package/src/detectors/nominalization.ts +73 -0
- package/src/detectors/orthography.ts +97 -41
- package/src/detectors/outside-announced-list.ts +25 -0
- package/src/detectors/oxford-comma.ts +179 -283
- package/src/detectors/phrase-match.ts +27 -7
- package/src/detectors/place-run.ts +7 -4
- package/src/detectors/placeholder-text.ts +27 -0
- package/src/detectors/quote-around.ts +9 -0
- package/src/detectors/ra-nuki.ts +38 -0
- package/src/detectors/register.ts +37 -10
- package/src/detectors/requirement-modal.ts +67 -0
- package/src/detectors/requirement-smell.ts +52 -0
- package/src/detectors/roman-numeral.ts +3 -0
- package/src/detectors/sentence-ending.ts +14 -7
- package/src/detectors/sentence-length.ts +16 -5
- package/src/detectors/signals.ts +80 -46
- package/src/detectors/space-before-punctuation.ts +32 -0
- package/src/detectors/spelling-variety.ts +81 -0
- package/src/detectors/structure-tree.ts +47 -1
- package/src/detectors/structure.ts +20 -7
- package/src/detectors/superlative-comparison.ts +47 -0
- package/src/detectors/superlative-name.ts +7 -4
- package/src/detectors/superlative-scope.ts +8 -3
- package/src/detectors/token-column.ts +149 -0
- package/src/detectors/unbalanced-bracket.ts +153 -0
- package/src/detectors/url-run-on.ts +33 -0
- package/src/detectors/vague-figure-pointer.ts +58 -0
- package/src/detectors/word-list.ts +6 -1
- package/src/document-sections.ts +46 -0
- package/src/document.ts +188 -173
- package/src/email-parts.ts +269 -0
- package/src/eval.ts +14 -4
- 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 +173 -0
- package/src/files.ts +5 -0
- 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/heading-label.ts +55 -0
- package/src/in-page-nav.ts +48 -19
- package/src/joined-view.ts +1 -0
- package/src/language-sample.ts +48 -0
- package/src/levels.ts +14 -1
- package/src/line-paragraphs.ts +52 -9
- package/src/link-line.ts +13 -0
- package/src/long-vowel.ts +109 -0
- package/src/markdown-node.ts +19 -0
- package/src/markdown-read.ts +44 -0
- package/src/markup.ts +212 -0
- package/src/mask.ts +8 -8
- package/src/name-variants.ts +217 -0
- package/src/node-version.ts +22 -0
- package/src/not-run.ts +16 -0
- package/src/number-name.ts +151 -24
- package/src/orthography.ts +50 -14
- package/src/outline/render.ts +85 -0
- package/src/outline/shape.ts +72 -0
- package/src/outline/text.ts +50 -0
- package/src/page-furniture.ts +11 -2
- package/src/plain-source.ts +2 -1
- package/src/plugin.ts +120 -3
- package/src/profile/for-file.ts +3 -1
- package/src/quoted-span.ts +9 -3
- package/src/reasons.ts +12 -0
- package/src/reference-lists.ts +91 -0
- package/src/render/compact.ts +13 -3
- package/src/render/explain.ts +75 -14
- package/src/render/friendly.ts +20 -9
- package/src/render/options.ts +58 -0
- package/src/render/rules-json.ts +140 -18
- package/src/render/rules-table.ts +91 -0
- package/src/render/sarif.ts +4 -4
- package/src/render/semantic.ts +3 -3
- package/src/render/severity-name.ts +10 -0
- package/src/render/suppressions.ts +30 -2
- package/src/render/text.ts +21 -7
- package/src/resolve-genre.ts +4 -1
- package/src/rule-genres.ts +25 -0
- package/src/rule-guide.ts +173 -0
- package/src/rule-load.ts +91 -34
- package/src/rule-options.ts +131 -0
- package/src/run-semantic.ts +2 -1
- package/src/run.ts +105 -22
- package/src/sentence-shape.ts +4 -5
- package/src/setting-problems.ts +9 -1
- package/src/spacing-minority.ts +27 -0
- package/src/span-cut.ts +28 -0
- package/src/stet-block.ts +60 -0
- package/src/stet.ts +41 -15
- package/src/structure/aside-depth.ts +67 -0
- package/src/structure/build.ts +38 -19
- package/src/structure/closed-pairs.ts +20 -0
- package/src/structure/date-range.ts +117 -0
- package/src/structure/definition-use.ts +130 -0
- package/src/structure/known-mentions.ts +96 -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/numbering.ts +9 -5
- package/src/structure/of.ts +11 -3
- package/src/structure/percent-sum.ts +135 -0
- package/src/structure/quoted-number.ts +36 -0
- package/src/structure/relative-find.ts +34 -47
- package/src/structure/relative-resolve.ts +77 -30
- package/src/structure/runs.ts +2 -2
- package/src/structure/sexp.ts +17 -5
- package/src/structure/total.ts +2 -2
- package/src/structure/universal.ts +33 -5
- package/src/structure/wrapped-tail.ts +38 -13
- package/src/style-load.ts +28 -0
- package/src/style-parse.ts +112 -0
- package/src/subheading-line.ts +106 -0
- package/src/tag-coverage.ts +13 -0
- package/src/template-syntax.ts +164 -0
- package/src/text-above.ts +49 -0
- package/src/text-figures.ts +147 -0
- package/src/trailing-aside.ts +50 -0
- package/src/tree-walk.ts +48 -0
- package/styles/bunkacho.yaml +25 -0
- package/styles/ieice.yaml +30 -0
- package/styles/jis-z8301-2011.yaml +28 -0
- 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,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.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
id: requirement-smell
|
|
2
|
+
layer: L2
|
|
3
|
+
status: experimental
|
|
4
|
+
how_to_find: requirement-smell
|
|
5
|
+
# 要求の文の目印と、三つの見つけ方の語。語はすべて言語ごとの語彙表にある。
|
|
6
|
+
word_list: requirement-marker
|
|
7
|
+
extra_word_lists: [requirement-loophole, requirement-open-end, requirement-either]
|
|
8
|
+
uses: [pos]
|
|
9
|
+
severity: warning
|
|
10
|
+
|
|
11
|
+
name:
|
|
12
|
+
ja: 要求の文に、決めきれない言い方がある
|
|
13
|
+
en: A requirement that leaves its reader to decide
|
|
14
|
+
|
|
15
|
+
why:
|
|
16
|
+
ja: 仕様書や契約書の要求は、満たしたかどうかを誰が読んでも同じに決められる必要があります。「可能な限り」「必要に応じて」は、どこまでしたら満たしたことになるのかを書き手が決めずに残します。要求の文の「等」「など」は、ほかに何が含まれるのかを残し、「及び/又は」は両方なのか片方でよいのかを残します。要求の書き方を調べた研究(Femmer ほか 2017、Berry ほか 2003)と ISO/IEC/IEEE 29148 が、どれも避ける言い方に挙げています。要求の文(「〜しなければならない」「〜ものとする」「〜こと。」で終わる文)だけを見ます。
|
|
17
|
+
en: 'A requirement in a specification or a contract must be one that any reader can check the same way. "As far as possible" and "if necessary" leave open how much is enough. "Etc." in a requirement leaves open what else it covers, and "and/or" leaves open whether both are meant or one is enough. Studies of requirements (Femmer et al. 2017; Berry et al. 2003) and ISO/IEC/IEEE 29148 all list these among the phrases to avoid. Only a sentence that states a requirement (with shall, must or is required to) is checked.'
|
|
18
|
+
|
|
19
|
+
message:
|
|
20
|
+
ja: 「{matched}」は、要求を決めきらずに残しています
|
|
21
|
+
en: '"{matched}" leaves the requirement open'
|
|
22
|
+
|
|
23
|
+
messages:
|
|
24
|
+
loophole:
|
|
25
|
+
ja: 「{matched}」は、どこまでしたら満たしたことになるのかを決めていません
|
|
26
|
+
en: '"{matched}" does not say how much is enough to meet the requirement'
|
|
27
|
+
open-end:
|
|
28
|
+
ja: 要求の中の「{matched}」は、ほかに何が含まれるのかを決めていません
|
|
29
|
+
en: '"{matched}" in a requirement does not say what else it covers'
|
|
30
|
+
either:
|
|
31
|
+
ja: 「{matched}」は、両方なのか片方でよいのかを決めていません
|
|
32
|
+
en: '"{matched}" does not say whether both are meant or either is enough'
|
|
33
|
+
|
|
34
|
+
how_to_fix:
|
|
35
|
+
ja: 満たしたかどうかを確かめられる形に書き直してください。「可能な限り速く」なら「3 秒以内に」、「ログ等を保存すること」なら保存するものを全部並べる、「A 及び/又は B」なら「A 又は B(両方でもよい)」のように。
|
|
36
|
+
en: 'Rewrite it so that meeting it can be checked: "as fast as possible" becomes "within 3 seconds", "logs, etc." becomes the full list, and "A and/or B" becomes "A, B, or both".'
|
|
37
|
+
|
|
38
|
+
placeholders:
|
|
39
|
+
matched:
|
|
40
|
+
ja: 見つけた語
|
|
41
|
+
en: the phrase found
|
|
42
|
+
|
|
43
|
+
levels: { strict: error, normal: warning, relaxed: info }
|
|
44
|
+
|
|
45
|
+
# 要求を書く文書だけ。仕様書、契約書・規約、説明書(マニュアル・FAQ)。ほかの法務・説明書のジャンルと、学術・文学・話し言葉は
|
|
46
|
+
# genres.yaml で止める(法令は「等」を定義して使う、用語集の「〜すること。」は語の説明)。
|
|
47
|
+
use_for: [technical/spec, legal, docs, academic, literature, speech]
|
|
48
|
+
sources: [femmer-2017, berry-2003, iso-29148]
|
|
49
|
+
|
|
50
|
+
group: wording
|
|
51
|
+
summary:
|
|
52
|
+
ja: 仕様書や契約書の要求の文にある「可能な限り」「必要に応じて」「等」「及び/又は」
|
|
53
|
+
en: '"As far as possible", "if necessary", "etc." or "and/or" in a requirement of a specification or a contract'
|
|
54
|
+
example:
|
|
55
|
+
ja:
|
|
56
|
+
before: |
|
|
57
|
+
予約の画面は、可能な限り速く表示されなければならない。
|
|
58
|
+
after: |
|
|
59
|
+
予約の画面は、3 秒以内に表示されなければならない。
|
|
60
|
+
config: { genre: technical/spec }
|
|
61
|
+
en:
|
|
62
|
+
before: |
|
|
63
|
+
The booking page must load as fast as possible.
|
|
64
|
+
after: |
|
|
65
|
+
The booking page must load within 3 seconds.
|
|
66
|
+
config: { genre: technical/spec }
|
|
67
|
+
|
|
68
|
+
not_flagged:
|
|
69
|
+
ja: 要求の文でない文(説明や背景)、法令、ブログやビジネス文書は見ません。語彙表にない言い方は指しません。
|
|
70
|
+
en: Sentences that state no requirement (background, explanation), statutes, and blogs and business documents are not checked. Phrases not on chaff's lists are not reported.
|
|
@@ -39,3 +39,25 @@ levels:
|
|
|
39
39
|
relaxed: info
|
|
40
40
|
|
|
41
41
|
use_for: [business]
|
|
42
|
+
|
|
43
|
+
group: structure
|
|
44
|
+
summary:
|
|
45
|
+
ja: よい面だけを書き、リスクや弱みに触れていない提案(AI に読ませる検査)
|
|
46
|
+
en: A proposal that gives only the upside and never mentions a risk (checked by an AI)
|
|
47
|
+
example:
|
|
48
|
+
ja:
|
|
49
|
+
before: |
|
|
50
|
+
新しい会計の仕組みに切り替えると、月末の締めが三日早くなります。費用も年に二百万円下がります。
|
|
51
|
+
after: |
|
|
52
|
+
新しい会計の仕組みに切り替えると、月末の締めが三日早くなります。費用も年に二百万円下がります。
|
|
53
|
+
ただし、切り替えの月は二つの仕組みを並べて動かすため、経理部の残業が増えます。
|
|
54
|
+
en:
|
|
55
|
+
before: |
|
|
56
|
+
Moving to the new accounting system closes the month three days sooner. It also cuts costs by 20,000 dollars a year.
|
|
57
|
+
after: |
|
|
58
|
+
Moving to the new accounting system closes the month three days sooner. It also cuts costs by 20,000 dollars a year.
|
|
59
|
+
In the month we switch, however, finance will run both systems side by side and work longer hours.
|
|
60
|
+
|
|
61
|
+
not_flagged:
|
|
62
|
+
ja: 機械では決めません。chaff test で、AI が文書を読んでリスクに触れているかを見ます。
|
|
63
|
+
en: No machine decides this. chaff test has an AI read the document for any mention of a risk.
|
package/rules/rule-of-three.yaml
CHANGED
|
@@ -23,3 +23,146 @@ how_to_fix:
|
|
|
23
23
|
levels: { strict: 50, normal: 70, relaxed: 90 }
|
|
24
24
|
|
|
25
25
|
use_for: [blog, legal, docs, academic, literature, speech]
|
|
26
|
+
sources: [reinhart-2025, zhang-2024]
|
|
27
|
+
|
|
28
|
+
group: ai-tells
|
|
29
|
+
summary:
|
|
30
|
+
ja: 箇条書きがどれも三つの項目で、数を合わせて並べたように見える所
|
|
31
|
+
en: Lists that almost all have exactly three items, as if padded or trimmed to fit
|
|
32
|
+
example:
|
|
33
|
+
ja:
|
|
34
|
+
config: { genre: blog/tech }
|
|
35
|
+
before: |
|
|
36
|
+
# 在庫管理
|
|
37
|
+
|
|
38
|
+
よい在庫管理の条件です。
|
|
39
|
+
|
|
40
|
+
- 正確さ
|
|
41
|
+
- 速さ
|
|
42
|
+
- 安さ
|
|
43
|
+
|
|
44
|
+
毎日することです。
|
|
45
|
+
|
|
46
|
+
- 数える
|
|
47
|
+
- 記録する
|
|
48
|
+
- 見返す
|
|
49
|
+
|
|
50
|
+
よくある失敗です。
|
|
51
|
+
|
|
52
|
+
- 数え忘れ
|
|
53
|
+
- 記録の漏れ
|
|
54
|
+
- 見返さない
|
|
55
|
+
after: |
|
|
56
|
+
# 在庫管理
|
|
57
|
+
|
|
58
|
+
よい在庫管理の条件です。
|
|
59
|
+
|
|
60
|
+
- 正確さ
|
|
61
|
+
- 速さ
|
|
62
|
+
|
|
63
|
+
毎日することです。
|
|
64
|
+
|
|
65
|
+
- 数える
|
|
66
|
+
- 記録する
|
|
67
|
+
- 見返す
|
|
68
|
+
- 月末の棚卸しと突き合わせる
|
|
69
|
+
|
|
70
|
+
よくある失敗です。
|
|
71
|
+
|
|
72
|
+
- 数え忘れ
|
|
73
|
+
- 記録の漏れ
|
|
74
|
+
- 見返さない
|
|
75
|
+
en:
|
|
76
|
+
config: { genre: blog/tech }
|
|
77
|
+
before: |
|
|
78
|
+
# Stock control
|
|
79
|
+
|
|
80
|
+
Good stock control is:
|
|
81
|
+
|
|
82
|
+
- Accurate
|
|
83
|
+
- Fast
|
|
84
|
+
- Cheap
|
|
85
|
+
|
|
86
|
+
Every day we:
|
|
87
|
+
|
|
88
|
+
- Count
|
|
89
|
+
- Record
|
|
90
|
+
- Review
|
|
91
|
+
|
|
92
|
+
Common mistakes:
|
|
93
|
+
|
|
94
|
+
- Missed counts
|
|
95
|
+
- Gaps in the record
|
|
96
|
+
- No review
|
|
97
|
+
after: |
|
|
98
|
+
# Stock control
|
|
99
|
+
|
|
100
|
+
Good stock control is:
|
|
101
|
+
|
|
102
|
+
- Accurate
|
|
103
|
+
- Fast
|
|
104
|
+
|
|
105
|
+
Every day we:
|
|
106
|
+
|
|
107
|
+
- Count
|
|
108
|
+
- Record
|
|
109
|
+
- Review
|
|
110
|
+
- Match against the month-end count
|
|
111
|
+
|
|
112
|
+
Common mistakes:
|
|
113
|
+
|
|
114
|
+
- Missed counts
|
|
115
|
+
- Gaps in the record
|
|
116
|
+
- No review
|
|
117
|
+
|
|
118
|
+
not_flagged:
|
|
119
|
+
ja: 箇条書きが 3 つより少ない文書は見ません。ビジネス文書と技術文書のジャンルでは見ません。
|
|
120
|
+
en: Documents with fewer than three lists are not checked. Business and technical genres do not run this rule.
|
|
121
|
+
level_meaning:
|
|
122
|
+
ja: 3 項目の箇条書きの割合 {limit}% まで
|
|
123
|
+
en: up to {limit}% of lists with exactly three items
|
|
124
|
+
rewrite:
|
|
125
|
+
ja:
|
|
126
|
+
direction: 三つ並んだ箇条書きのうち、ほかの項目と同じことを言っている項目を消すか、一つにまとめてください。本当に三つあるリストはそのままにします。
|
|
127
|
+
pairs:
|
|
128
|
+
- before: |
|
|
129
|
+
- 速い
|
|
130
|
+
- 高速に動く
|
|
131
|
+
- 安い
|
|
132
|
+
after: |
|
|
133
|
+
- 速い
|
|
134
|
+
- 安い
|
|
135
|
+
- before: |
|
|
136
|
+
- 費用の削減
|
|
137
|
+
- コストの低減
|
|
138
|
+
- 保守の手間が減る
|
|
139
|
+
after: |
|
|
140
|
+
- 費用が下がる
|
|
141
|
+
- 保守の手間が減る
|
|
142
|
+
keep:
|
|
143
|
+
- 互いに別のことを言っている項目
|
|
144
|
+
avoid:
|
|
145
|
+
- 別々のことを一つにまとめて意味を変える
|
|
146
|
+
- 三つを避けるために四つ目を作る
|
|
147
|
+
en:
|
|
148
|
+
direction: In each list of three, delete or merge the item that says what another item already says. A list that really has three items stays.
|
|
149
|
+
pairs:
|
|
150
|
+
- before: |
|
|
151
|
+
- fast
|
|
152
|
+
- quick to run
|
|
153
|
+
- cheap
|
|
154
|
+
after: |
|
|
155
|
+
- fast
|
|
156
|
+
- cheap
|
|
157
|
+
- before: |
|
|
158
|
+
- lower costs
|
|
159
|
+
- reduced spending
|
|
160
|
+
- less maintenance
|
|
161
|
+
after: |
|
|
162
|
+
- lower costs
|
|
163
|
+
- less maintenance
|
|
164
|
+
keep:
|
|
165
|
+
- items that say different things
|
|
166
|
+
avoid:
|
|
167
|
+
- merging two different things into one and changing the meaning
|
|
168
|
+
- inventing a fourth item to get away from three
|
|
@@ -26,3 +26,21 @@ how_to_fix:
|
|
|
26
26
|
levels: { strict: 1, normal: 3, relaxed: 6 }
|
|
27
27
|
|
|
28
28
|
use_for: [business, blog, legal, docs, academic, literature, speech]
|
|
29
|
+
|
|
30
|
+
group: wording
|
|
31
|
+
summary:
|
|
32
|
+
ja: 「させていただく」を繰り返して、誰が決めて何が起きるのかがぼやけた所
|
|
33
|
+
en: The Japanese humble form させていただく repeated until it hides who decides what
|
|
34
|
+
example:
|
|
35
|
+
ja:
|
|
36
|
+
before: |
|
|
37
|
+
本日は資料を配布させていただきます。続いて内容を説明させていただきます。そのあと質問に回答させていただきます。最後に日程を確認させていただきます。
|
|
38
|
+
after: |
|
|
39
|
+
本日は資料を配ります。続いて内容を説明します。そのあと質問に答えます。最後に日程を確認します。
|
|
40
|
+
|
|
41
|
+
not_flagged:
|
|
42
|
+
ja: 上限の回数までは、丁寧な言い方として指しません。
|
|
43
|
+
en: Up to the limit, the form reads as politeness and is not reported.
|
|
44
|
+
level_meaning:
|
|
45
|
+
ja: 文書の中で {limit} 回まで
|
|
46
|
+
en: up to {limit} times in a document
|
|
@@ -22,4 +22,117 @@ how_to_fix:
|
|
|
22
22
|
|
|
23
23
|
levels: { strict: 45, normal: 35, relaxed: 25 }
|
|
24
24
|
|
|
25
|
+
options:
|
|
26
|
+
min_sections:
|
|
27
|
+
kind: count
|
|
28
|
+
default: 5
|
|
29
|
+
about:
|
|
30
|
+
ja: 測る節の数の下限。節が少ないと長さのばらつきは偶然で小さく出て、人の書いた文書でも揃って見えます
|
|
31
|
+
en: The fewest sections measured. With few sections, 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]
|
|
34
|
+
|
|
35
|
+
group: ai-tells
|
|
36
|
+
summary:
|
|
37
|
+
ja: どの節もほぼ同じ長さに埋めてあり、ひな形を埋めたように見える所
|
|
38
|
+
en: Every section filled to the same size, which is what a template does
|
|
39
|
+
example:
|
|
40
|
+
ja:
|
|
41
|
+
config: { genre: blog/tech }
|
|
42
|
+
before: |
|
|
43
|
+
# 新しい道具の紹介
|
|
44
|
+
|
|
45
|
+
## 入れる
|
|
46
|
+
|
|
47
|
+
公式のページから、使う機械に合った版を選んで入れます。
|
|
48
|
+
|
|
49
|
+
## 設定する
|
|
50
|
+
|
|
51
|
+
右上の歯車の印を押して、言語と文書の種類を選びます。
|
|
52
|
+
|
|
53
|
+
## 招く
|
|
54
|
+
|
|
55
|
+
左の招待の画面で、仲間の宛先を入れて送ります。
|
|
56
|
+
|
|
57
|
+
## 確かめる
|
|
58
|
+
|
|
59
|
+
試しの文書を置いて、指摘が画面に出るかを見ます。
|
|
60
|
+
|
|
61
|
+
## 更新する
|
|
62
|
+
|
|
63
|
+
新しい版が出たら、同じ公式のページから入れ直します。
|
|
64
|
+
after: |
|
|
65
|
+
# 新しい道具の紹介
|
|
66
|
+
|
|
67
|
+
## 入れる
|
|
68
|
+
|
|
69
|
+
公式のページから入れます。
|
|
70
|
+
|
|
71
|
+
## 設定する
|
|
72
|
+
|
|
73
|
+
右上の歯車の印を押して、言語と文書の種類を選びます。項目は多いですが、最初に触るのはこの二つだけで足ります。ほかは、使いながら必要になったときに変えてください。
|
|
74
|
+
|
|
75
|
+
## 招く
|
|
76
|
+
|
|
77
|
+
左の招待の画面から送ります。
|
|
78
|
+
|
|
79
|
+
## 確かめる
|
|
80
|
+
|
|
81
|
+
試しの文書を置いて、指摘が画面に出るかを見ます。
|
|
82
|
+
|
|
83
|
+
## 更新する
|
|
84
|
+
|
|
85
|
+
新しい版は同じページにあります。
|
|
86
|
+
en:
|
|
87
|
+
config: { genre: blog/tech }
|
|
88
|
+
before: |
|
|
89
|
+
# Introducing the new tool
|
|
90
|
+
|
|
91
|
+
## Install
|
|
92
|
+
|
|
93
|
+
Pick the version for your computer from the official page.
|
|
94
|
+
|
|
95
|
+
## Set up
|
|
96
|
+
|
|
97
|
+
Press the gear icon and choose your language and document type.
|
|
98
|
+
|
|
99
|
+
## Invite
|
|
100
|
+
|
|
101
|
+
Enter your team's addresses on the invite page and send.
|
|
102
|
+
|
|
103
|
+
## Check
|
|
104
|
+
|
|
105
|
+
Add a sample document and look for findings on the screen.
|
|
106
|
+
|
|
107
|
+
## Update
|
|
108
|
+
|
|
109
|
+
When a new version comes out, install it again from the same page.
|
|
110
|
+
after: |
|
|
111
|
+
# Introducing the new tool
|
|
112
|
+
|
|
113
|
+
## Install
|
|
114
|
+
|
|
115
|
+
Download it from the official page.
|
|
116
|
+
|
|
117
|
+
## Set up
|
|
118
|
+
|
|
119
|
+
Press the gear icon and choose your language and document type. There are many options, but at first you only need these two. Change the rest when you need to.
|
|
120
|
+
|
|
121
|
+
## Invite
|
|
122
|
+
|
|
123
|
+
Send invites from the page on the left.
|
|
124
|
+
|
|
125
|
+
## Check
|
|
126
|
+
|
|
127
|
+
Add a sample document and look for findings on the screen.
|
|
128
|
+
|
|
129
|
+
## Update
|
|
130
|
+
|
|
131
|
+
New versions are on the same page.
|
|
132
|
+
|
|
133
|
+
not_flagged:
|
|
134
|
+
ja: 中身のある節が 5 より少ない文書は見ません(min_sections で変えられます)。ビジネス文書と技術文書のジャンルでは見ません。
|
|
135
|
+
en: Documents with fewer than 5 sections are not checked (min_sections changes it). Business and technical genres do not run this rule.
|
|
136
|
+
level_meaning:
|
|
137
|
+
ja: 節の長さのばらつきが {limit}% 未満なら指摘
|
|
138
|
+
en: reported when section length varies by less than {limit}%
|
|
@@ -25,3 +25,21 @@ how_to_fix:
|
|
|
25
25
|
levels: { strict: 1, normal: 2, relaxed: 4 }
|
|
26
26
|
|
|
27
27
|
use_for: [blog, business, legal, docs, academic, literature, speech]
|
|
28
|
+
|
|
29
|
+
group: readability
|
|
30
|
+
summary:
|
|
31
|
+
ja: 英語で、And や But で始まる文が続く所
|
|
32
|
+
en: A run of sentences that open with "And", "But" or "So"
|
|
33
|
+
example:
|
|
34
|
+
en:
|
|
35
|
+
before: |
|
|
36
|
+
We shipped the update on Monday. But the login page broke. And the fix took two days. So some customers could not sign in.
|
|
37
|
+
after: |
|
|
38
|
+
We shipped the update on Monday, and the login page broke. The fix took two days, during which some customers could not sign in.
|
|
39
|
+
|
|
40
|
+
not_flagged:
|
|
41
|
+
ja: And や But で始まる文が一つだけなら指しません。
|
|
42
|
+
en: One sentence opening with "And" or "But" is not reported.
|
|
43
|
+
level_meaning:
|
|
44
|
+
ja: 接続詞で始まる文の連続 {limit} 文まで
|
|
45
|
+
en: up to {limit} sentences in a row opening with a conjunction
|
|
@@ -28,3 +28,54 @@ levels:
|
|
|
28
28
|
relaxed: 20
|
|
29
29
|
|
|
30
30
|
use_for: [blog, legal, docs, academic, literature, speech]
|
|
31
|
+
sources: [iwamoto-2026]
|
|
32
|
+
|
|
33
|
+
group: readability
|
|
34
|
+
summary:
|
|
35
|
+
ja: どの文もほぼ同じ長さで、読むリズムが単調な所
|
|
36
|
+
en: Sentences that are all about the same length, so the text reads as a drone
|
|
37
|
+
example:
|
|
38
|
+
ja:
|
|
39
|
+
config: { genre: blog/tech }
|
|
40
|
+
before: |
|
|
41
|
+
今日は新しい道具の使い方を紹介します。最初に画面の右上から設定を開きます。次に一覧から使いたい項目を選びます。項目の横にある印を押して有効にします。最後に保存の印を押して閉じます。これで最初の準備が整いました。次は仲間を招く手順を見ます。招待の画面は左の端にあります。
|
|
42
|
+
after: |
|
|
43
|
+
今日は新しい道具の使い方を紹介します。まず設定を開きます。画面の右上にある歯車の印を押すと、使える項目が一覧で出てくるので、使いたいものを選び、横の印を押して有効にしてください。最後に保存です。これで最初の準備が整いました。次は、仲間を招く手順です。招待の画面は、左の端にあります。
|
|
44
|
+
en:
|
|
45
|
+
config: { genre: blog/tech }
|
|
46
|
+
before: |
|
|
47
|
+
Today we look at the new tool in detail. First you open the settings page here. Then you pick the option you want to use. Next you switch the option on with a click. Finally you press save and close it. Now the first part of setup is done. Next we invite the rest of the team. The invite page sits on the left side.
|
|
48
|
+
after: |
|
|
49
|
+
Today we look at the new tool. Open the settings. The gear icon at the top right opens a list of everything you can change, so pick the option you want there and switch it on. Then save. That is the first part done. Next, invite the rest of the team from the page on the left.
|
|
50
|
+
|
|
51
|
+
not_flagged:
|
|
52
|
+
ja: 文が 8 文より少ない文書は、ばらつきが当てにならないので測りません。
|
|
53
|
+
en: A document with fewer than 8 sentences is not measured, because the spread means little.
|
|
54
|
+
level_meaning:
|
|
55
|
+
ja: 文の長さのばらつきが {limit}% 未満なら指摘
|
|
56
|
+
en: reported when sentence length varies by less than {limit}%
|
|
57
|
+
rewrite:
|
|
58
|
+
ja:
|
|
59
|
+
direction: 長めの文のいくつかを、意味の切れ目で二つに割ってください。結論の文は短くします。言葉は足しません。
|
|
60
|
+
pairs:
|
|
61
|
+
- before: 設定は管理画面から変えられ、変えた内容はすぐに反映され、元に戻すこともできます。
|
|
62
|
+
after: 設定は管理画面から変えられ、すぐに反映されます。元にも戻せます。
|
|
63
|
+
- before: この方式は導入が簡単で費用も安いため、多くの部署で採用されています。
|
|
64
|
+
after: この方式は導入が簡単で、費用も安い方式です。多くの部署が採用しています。
|
|
65
|
+
keep:
|
|
66
|
+
- 文の中身と順番
|
|
67
|
+
avoid:
|
|
68
|
+
- 全部の文を短くして、別の単調さにする
|
|
69
|
+
- リズムのために言葉や例を足す
|
|
70
|
+
en:
|
|
71
|
+
direction: Split a few of the longer sentences at a break in the meaning. Make the sentence that carries the conclusion short. Add no words.
|
|
72
|
+
pairs:
|
|
73
|
+
- before: The setting can be changed from the admin page, the change applies at once, and it can be undone.
|
|
74
|
+
after: The setting can be changed from the admin page and applies at once. It can be undone.
|
|
75
|
+
- before: This method is easy to set up and cheap to run, which is why many departments have adopted it.
|
|
76
|
+
after: This method is easy to set up and cheap to run. Many departments have adopted it.
|
|
77
|
+
keep:
|
|
78
|
+
- what the sentences say, in the same order
|
|
79
|
+
avoid:
|
|
80
|
+
- cutting every sentence short, which is another monotone
|
|
81
|
+
- adding words or examples for the sake of rhythm
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
id: space-before-punctuation
|
|
2
|
+
layer: L1
|
|
3
|
+
status: experimental
|
|
4
|
+
how_to_find: space-before-punctuation
|
|
5
|
+
languages: [en]
|
|
6
|
+
severity: warning
|
|
7
|
+
|
|
8
|
+
name:
|
|
9
|
+
ja: 句読点の前に空白がある
|
|
10
|
+
en: Space before punctuation
|
|
11
|
+
|
|
12
|
+
why:
|
|
13
|
+
ja: '英文では句読点を前の語に付けて書きます。「word .」「(word) ,」のように前に空白があると、行の折り返しで句読点だけが次の行の頭に落ちることがあり、書き換えの途中で残った空白に見えます。ピリオド・カンマ・セミコロン・疑問符・感嘆符を見ます。コロン("Note : ")、空白で区切った省略の点や目次の点線(". . .")、".NET" や ".5" のように次の語の頭の点、数の後ろ(式の "[ 1 , N ]")、コードと URL は数えません。前の空白が二つ以上の所(表のように並べた行)も数えません。'
|
|
14
|
+
en: 'English attaches punctuation to the word before it. A space before it ("word .", "(word) ,") can leave the mark alone at the start of the next line, and reads as a space left over from an edit. Periods, commas, semicolons, question marks and exclamation marks are checked. A colon ("Note : "), dots spaced out as an ellipsis or a leader in a table of contents (". . ."), a dot that starts the next word (".NET", ".5"), a mark after a number ("[ 1 , N ]" in a formula), code and URLs are not counted, nor are two or more spaces before the mark (a line laid out like a table).'
|
|
15
|
+
|
|
16
|
+
message:
|
|
17
|
+
ja: 「{mark}」の前に空白があります
|
|
18
|
+
en: 'A space before "{mark}"'
|
|
19
|
+
|
|
20
|
+
how_to_fix:
|
|
21
|
+
ja: 空白を消して、句読点を前の語に付けてください。
|
|
22
|
+
en: Delete the space and attach the mark to the word before it.
|
|
23
|
+
|
|
24
|
+
levels: { strict: error, normal: warning, relaxed: info }
|
|
25
|
+
|
|
26
|
+
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
27
|
+
|
|
28
|
+
group: slips
|
|
29
|
+
summary:
|
|
30
|
+
ja: 英文の「word .」「word ,」のように、句読点の前に空白がある所
|
|
31
|
+
en: A space before a period, comma, semicolon, question mark or exclamation mark, as in "word ."
|
|
32
|
+
example:
|
|
33
|
+
en:
|
|
34
|
+
before: |
|
|
35
|
+
The form is ready , and the office has a copy .
|
|
36
|
+
after: |
|
|
37
|
+
The form is ready, and the office has a copy.
|
|
38
|
+
|
|
39
|
+
not_flagged:
|
|
40
|
+
ja: コロン、空白で区切った省略の点や目次の点線(「. . .」)、「.NET」「.5」のような語の頭の点、数の後ろの句読点、二つ以上の空白の後ろの句読点、コードと URL は指しません。
|
|
41
|
+
en: Colons, dots spaced out as an ellipsis or a leader (". . ."), a dot that starts a word (".NET", ".5"), a mark after a number or after two or more spaces, code and URLs are not reported.
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
id: spelling-consistency
|
|
2
|
+
layer: L3
|
|
3
|
+
status: experimental
|
|
4
|
+
how_to_find: spelling-variety
|
|
5
|
+
word_list: spelling-variant
|
|
6
|
+
extra_word_lists: [spelling-ize]
|
|
7
|
+
languages: [en]
|
|
8
|
+
severity: info
|
|
9
|
+
|
|
10
|
+
name:
|
|
11
|
+
ja: イギリスとアメリカの綴りが混ざっている
|
|
12
|
+
en: British and American spellings are mixed
|
|
13
|
+
|
|
14
|
+
why:
|
|
15
|
+
ja: colour と color、centre と center、organise と organize のように、イギリスとアメリカの綴りはどちらも正しい英語です。困るのは一つの文書の中で混ざることで、検索で別の語になり、別の人が書いた段落がそこだけ違って見えます。chaff はどちらが正しいかを決めず、文書の中で少ないほうを指摘します。-ise と -ize は別に比べます(Oxford の綴りは colour と organize を一緒に使うため)。文の頭でないのに大文字で始まる語(Labor Day、World Health Organization)は名前なので数えず、引用符の中と引用符で引いた語(‘organize’)も数えません。古い文学の綴りは時代のものなので、文学のジャンルでは既定で止めています。少ないほうが三分の一を超える文書は、使い分けている(引用や固有の用語)と見て言いません。
|
|
16
|
+
en: British and American spellings (colour and color, centre and center, organise and organize) are both correct English. What reads badly is mixing them in one document, which makes search treat them as different words and makes another writer's paragraph stand out. chaff does not decide which is right; it points at whichever the document uses less. -ise and -ize are compared on their own, since Oxford spelling writes colour with organize. A word capitalised in the middle of a sentence (Labor Day, World Health Organization) is a name and is not counted, nor is anything in quotation marks or a word quoted on its own (‘organize’). The literature preset turns it off, since old spelling belongs to its time. It says nothing when the minority is more than a third, since the document then mixes them on purpose (quotations, fixed terms).
|
|
17
|
+
|
|
18
|
+
message:
|
|
19
|
+
ja: 「{matched}」と書いています(この文書はふつう「{other}」の綴り。{of} 箇所のうち {count} 箇所が違う)
|
|
20
|
+
en: '"{matched}" here, where the document usually spells it "{other}" ({count} of {of})'
|
|
21
|
+
|
|
22
|
+
how_to_fix:
|
|
23
|
+
ja: 文書の多いほうの綴りに合わせてください。チームで決めているなら、STYLE.md に書いておくと迷いません。
|
|
24
|
+
en: Match the spelling the rest of the document uses. If the team has decided, write it in the style guide.
|
|
25
|
+
|
|
26
|
+
# 少ないほうが組の何パーセントまでなら「混ざっている」と見るか。これを超えたら、文書が使い分けている。
|
|
27
|
+
levels: { strict: 49, normal: 34, relaxed: 20 }
|
|
28
|
+
|
|
29
|
+
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
30
|
+
|
|
31
|
+
group: consistency
|
|
32
|
+
summary:
|
|
33
|
+
ja: 英語で、colour と color のように、イギリスとアメリカの綴りが一つの文書の中で混ざっている所
|
|
34
|
+
en: British and American spellings (colour and color, centre and center) mixed in one document
|
|
35
|
+
example:
|
|
36
|
+
en:
|
|
37
|
+
before: |
|
|
38
|
+
The colour of the logo is blue. The colour of the button is green. The color of the link is red.
|
|
39
|
+
after: |
|
|
40
|
+
The colour of the logo is blue. The colour of the button is green. The colour of the link is red.
|
|
41
|
+
|
|
42
|
+
not_flagged:
|
|
43
|
+
ja: どちらの綴りが正しいかは決めません。-ise と -ize は別に比べるので、Oxford の綴り(colour と organize)はそろっていると見ます。文の途中で大文字で始まる名前(Labor Day)と引用符の中は数えません。
|
|
44
|
+
en: Neither spelling is called right. -ise and -ize are compared on their own, so Oxford spelling (colour with organize) is consistent. Names capitalised mid-sentence (Labor Day) and quotations are not counted.
|
|
45
|
+
level_meaning:
|
|
46
|
+
ja: 少ないほうが組の {limit}% 以下のとき指摘
|
|
47
|
+
en: reported when the minority spelling is {limit}% of its group or less
|