chaffjs 0.20.0 → 0.22.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 +7 -5
- package/dist/api.d.ts +16 -1
- package/dist/api.d.ts.map +1 -1
- package/dist/api.js.map +1 -1
- package/dist/cli-text.d.ts +2 -0
- package/dist/cli-text.d.ts.map +1 -1
- package/dist/cli-text.js +18 -5
- package/dist/cli-text.js.map +1 -1
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +8 -11
- package/dist/cli.js.map +1 -1
- package/dist/command-help.d.ts +7 -0
- package/dist/command-help.d.ts.map +1 -0
- package/dist/command-help.js +18 -0
- package/dist/command-help.js.map +1 -0
- package/dist/commands/eval.js +2 -2
- package/dist/commands/eval.js.map +1 -1
- package/dist/commands/fix-plan.d.ts.map +1 -1
- package/dist/commands/fix-plan.js +11 -1
- package/dist/commands/fix-plan.js.map +1 -1
- package/dist/commands/help.d.ts +4 -0
- package/dist/commands/help.d.ts.map +1 -0
- package/dist/commands/help.js +7 -0
- package/dist/commands/help.js.map +1 -0
- package/dist/commands/init-command.d.ts +4 -0
- package/dist/commands/init-command.d.ts.map +1 -0
- package/dist/commands/init-command.js +15 -0
- package/dist/commands/init-command.js.map +1 -0
- package/dist/commands/plugin-init.d.ts +20 -0
- package/dist/commands/plugin-init.d.ts.map +1 -0
- package/dist/commands/plugin-init.js +129 -0
- package/dist/commands/plugin-init.js.map +1 -0
- package/dist/commands/plugin-test.d.ts +11 -0
- package/dist/commands/plugin-test.d.ts.map +1 -0
- package/dist/commands/plugin-test.js +81 -0
- package/dist/commands/plugin-test.js.map +1 -0
- package/dist/config/load.d.ts +2 -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.js +2 -2
- package/dist/config/option-problems.js.map +1 -1
- package/dist/config/rule-problems.js +2 -2
- package/dist/config/rule-problems.js.map +1 -1
- package/dist/custom/checked.d.ts +9 -0
- package/dist/custom/checked.d.ts.map +1 -0
- package/dist/custom/checked.js +3 -0
- package/dist/custom/checked.js.map +1 -0
- package/dist/custom/dsl-fields.d.ts +27 -0
- package/dist/custom/dsl-fields.d.ts.map +1 -0
- package/dist/custom/dsl-fields.js +86 -0
- package/dist/custom/dsl-fields.js.map +1 -0
- package/dist/custom/load.d.ts.map +1 -1
- package/dist/custom/load.js +2 -0
- package/dist/custom/load.js.map +1 -1
- package/dist/custom/parse.d.ts +14 -3
- package/dist/custom/parse.d.ts.map +1 -1
- package/dist/custom/parse.js +44 -40
- package/dist/custom/parse.js.map +1 -1
- package/dist/custom/problems.d.ts.map +1 -1
- package/dist/custom/problems.js +10 -1
- package/dist/custom/problems.js.map +1 -1
- package/dist/detectors/amount-for-count.d.ts +21 -0
- package/dist/detectors/amount-for-count.d.ts.map +1 -0
- package/dist/detectors/amount-for-count.js +55 -0
- package/dist/detectors/amount-for-count.js.map +1 -0
- package/dist/detectors/blank-structure.d.ts.map +1 -1
- package/dist/detectors/blank-structure.js +6 -4
- package/dist/detectors/blank-structure.js.map +1 -1
- package/dist/detectors/clause-shape.d.ts +22 -0
- package/dist/detectors/clause-shape.d.ts.map +1 -0
- package/dist/detectors/clause-shape.js +149 -0
- package/dist/detectors/clause-shape.js.map +1 -0
- package/dist/detectors/code-fences.d.ts +34 -0
- package/dist/detectors/code-fences.d.ts.map +1 -0
- package/dist/detectors/code-fences.js +100 -0
- package/dist/detectors/code-fences.js.map +1 -0
- package/dist/detectors/cross-definitions.d.ts +4 -0
- package/dist/detectors/cross-definitions.d.ts.map +1 -0
- package/dist/detectors/cross-definitions.js +43 -0
- package/dist/detectors/cross-definitions.js.map +1 -0
- package/dist/detectors/cross-facts.d.ts +4 -0
- package/dist/detectors/cross-facts.d.ts.map +1 -0
- package/dist/detectors/cross-facts.js +53 -0
- package/dist/detectors/cross-facts.js.map +1 -0
- package/dist/detectors/cross-registry/cross-doc-duplicate-definition.d.ts +3 -0
- package/dist/detectors/cross-registry/cross-doc-duplicate-definition.d.ts.map +1 -0
- package/dist/detectors/cross-registry/cross-doc-duplicate-definition.js +3 -0
- package/dist/detectors/cross-registry/cross-doc-duplicate-definition.js.map +1 -0
- package/dist/detectors/cross-registry/cross-doc-fact-conflict.d.ts +3 -0
- package/dist/detectors/cross-registry/cross-doc-fact-conflict.d.ts.map +1 -0
- package/dist/detectors/cross-registry/cross-doc-fact-conflict.js +3 -0
- package/dist/detectors/cross-registry/cross-doc-fact-conflict.js.map +1 -0
- package/dist/detectors/currency-notation.d.ts +29 -0
- package/dist/detectors/currency-notation.d.ts.map +1 -0
- package/dist/detectors/currency-notation.js +58 -0
- package/dist/detectors/currency-notation.js.map +1 -0
- package/dist/detectors/custom.d.ts.map +1 -1
- package/dist/detectors/custom.js +4 -1
- package/dist/detectors/custom.js.map +1 -1
- package/dist/detectors/dangling-opener.d.ts +14 -0
- package/dist/detectors/dangling-opener.d.ts.map +1 -0
- package/dist/detectors/dangling-opener.js +55 -0
- package/dist/detectors/dangling-opener.js.map +1 -0
- package/dist/detectors/defined-term-form.d.ts +25 -0
- package/dist/detectors/defined-term-form.d.ts.map +1 -0
- package/dist/detectors/defined-term-form.js +170 -0
- package/dist/detectors/defined-term-form.js.map +1 -0
- package/dist/detectors/email-letter.d.ts +46 -0
- package/dist/detectors/email-letter.d.ts.map +1 -0
- package/dist/detectors/email-letter.js +234 -0
- package/dist/detectors/email-letter.js.map +1 -0
- package/dist/detectors/footnote-mismatch.d.ts +11 -0
- package/dist/detectors/footnote-mismatch.d.ts.map +1 -0
- package/dist/detectors/footnote-mismatch.js +55 -0
- package/dist/detectors/footnote-mismatch.js.map +1 -0
- package/dist/detectors/form-minority.d.ts +13 -0
- package/dist/detectors/form-minority.d.ts.map +1 -0
- package/dist/detectors/form-minority.js +19 -0
- package/dist/detectors/form-minority.js.map +1 -0
- package/dist/detectors/heading-end-mark.d.ts +10 -0
- package/dist/detectors/heading-end-mark.d.ts.map +1 -0
- package/dist/detectors/heading-end-mark.js +59 -0
- package/dist/detectors/heading-end-mark.js.map +1 -0
- package/dist/detectors/impossible-date.d.ts +20 -0
- package/dist/detectors/impossible-date.d.ts.map +1 -0
- package/dist/detectors/impossible-date.js +105 -0
- package/dist/detectors/impossible-date.js.map +1 -0
- package/dist/detectors/impossible-time.d.ts +18 -0
- package/dist/detectors/impossible-time.d.ts.map +1 -0
- package/dist/detectors/impossible-time.js +116 -0
- package/dist/detectors/impossible-time.js.map +1 -0
- package/dist/detectors/link-shape.d.ts +11 -0
- package/dist/detectors/link-shape.d.ts.map +1 -0
- package/dist/detectors/link-shape.js +56 -0
- package/dist/detectors/link-shape.js.map +1 -0
- package/dist/detectors/list-marker.d.ts +7 -0
- package/dist/detectors/list-marker.d.ts.map +1 -0
- package/dist/detectors/list-marker.js +50 -0
- package/dist/detectors/list-marker.js.map +1 -0
- package/dist/detectors/mark-shape.d.ts +53 -0
- package/dist/detectors/mark-shape.d.ts.map +1 -0
- package/dist/detectors/mark-shape.js +160 -0
- package/dist/detectors/mark-shape.js.map +1 -0
- package/dist/detectors/markdown-slip.d.ts +19 -0
- package/dist/detectors/markdown-slip.d.ts.map +1 -0
- package/dist/detectors/markdown-slip.js +122 -0
- package/dist/detectors/markdown-slip.js.map +1 -0
- package/dist/detectors/numeral-opener.d.ts +10 -0
- package/dist/detectors/numeral-opener.d.ts.map +1 -0
- package/dist/detectors/numeral-opener.js +65 -0
- package/dist/detectors/numeral-opener.js.map +1 -0
- package/dist/detectors/ordinal-suffix.d.ts +12 -0
- package/dist/detectors/ordinal-suffix.d.ts.map +1 -0
- package/dist/detectors/ordinal-suffix.js +33 -0
- package/dist/detectors/ordinal-suffix.js.map +1 -0
- package/dist/detectors/range-notation.d.ts +15 -0
- package/dist/detectors/range-notation.d.ts.map +1 -0
- package/dist/detectors/range-notation.js +58 -0
- package/dist/detectors/range-notation.js.map +1 -0
- package/dist/detectors/registry/adverb-polarity.d.ts +3 -0
- package/dist/detectors/registry/adverb-polarity.d.ts.map +1 -0
- package/dist/detectors/registry/adverb-polarity.js +3 -0
- package/dist/detectors/registry/adverb-polarity.js.map +1 -0
- package/dist/detectors/registry/amount-for-count.d.ts +3 -0
- package/dist/detectors/registry/amount-for-count.d.ts.map +1 -0
- package/dist/detectors/registry/amount-for-count.js +3 -0
- package/dist/detectors/registry/amount-for-count.js.map +1 -0
- package/dist/detectors/registry/attachment-missing.d.ts +3 -0
- package/dist/detectors/registry/attachment-missing.d.ts.map +1 -0
- package/dist/detectors/registry/attachment-missing.js +3 -0
- package/dist/detectors/registry/attachment-missing.js.map +1 -0
- package/dist/detectors/registry/bare-url-mix.d.ts +3 -0
- package/dist/detectors/registry/bare-url-mix.d.ts.map +1 -0
- package/dist/detectors/registry/bare-url-mix.js +3 -0
- package/dist/detectors/registry/bare-url-mix.js.map +1 -0
- package/dist/detectors/registry/caps-shouting.d.ts +3 -0
- package/dist/detectors/registry/caps-shouting.d.ts.map +1 -0
- package/dist/detectors/registry/caps-shouting.js +3 -0
- package/dist/detectors/registry/caps-shouting.js.map +1 -0
- package/dist/detectors/registry/code-fence-language.d.ts +3 -0
- package/dist/detectors/registry/code-fence-language.d.ts.map +1 -0
- package/dist/detectors/registry/code-fence-language.js +3 -0
- package/dist/detectors/registry/code-fence-language.js.map +1 -0
- package/dist/detectors/registry/currency-notation.d.ts +3 -0
- package/dist/detectors/registry/currency-notation.d.ts.map +1 -0
- package/dist/detectors/registry/currency-notation.js +3 -0
- package/dist/detectors/registry/currency-notation.js.map +1 -0
- package/dist/detectors/registry/dangling-opener.d.ts +3 -0
- package/dist/detectors/registry/dangling-opener.d.ts.map +1 -0
- package/dist/detectors/registry/dangling-opener.js +3 -0
- package/dist/detectors/registry/dangling-opener.js.map +1 -0
- package/dist/detectors/registry/defined-name-repeated.d.ts +3 -0
- package/dist/detectors/registry/defined-name-repeated.d.ts.map +1 -0
- package/dist/detectors/registry/defined-name-repeated.js +3 -0
- package/dist/detectors/registry/defined-name-repeated.js.map +1 -0
- package/dist/detectors/registry/defined-term-form.d.ts +3 -0
- package/dist/detectors/registry/defined-term-form.d.ts.map +1 -0
- package/dist/detectors/registry/defined-term-form.js +3 -0
- package/dist/detectors/registry/defined-term-form.js.map +1 -0
- package/dist/detectors/registry/email-frame.d.ts +3 -0
- package/dist/detectors/registry/email-frame.d.ts.map +1 -0
- package/dist/detectors/registry/email-frame.js +3 -0
- package/dist/detectors/registry/email-frame.js.map +1 -0
- package/dist/detectors/registry/email-subject.d.ts +3 -0
- package/dist/detectors/registry/email-subject.d.ts.map +1 -0
- package/dist/detectors/registry/email-subject.js +3 -0
- package/dist/detectors/registry/email-subject.js.map +1 -0
- package/dist/detectors/registry/ending-run.d.ts +3 -0
- package/dist/detectors/registry/ending-run.d.ts.map +1 -0
- package/dist/detectors/registry/ending-run.js +3 -0
- package/dist/detectors/registry/ending-run.js.map +1 -0
- package/dist/detectors/registry/footnote-mismatch.d.ts +3 -0
- package/dist/detectors/registry/footnote-mismatch.d.ts.map +1 -0
- package/dist/detectors/registry/footnote-mismatch.js +3 -0
- package/dist/detectors/registry/footnote-mismatch.js.map +1 -0
- package/dist/detectors/registry/heading-command.d.ts +3 -0
- package/dist/detectors/registry/heading-command.d.ts.map +1 -0
- package/dist/detectors/registry/heading-command.js +3 -0
- package/dist/detectors/registry/heading-command.js.map +1 -0
- package/dist/detectors/registry/heading-end-punctuation.d.ts +3 -0
- package/dist/detectors/registry/heading-end-punctuation.d.ts.map +1 -0
- package/dist/detectors/registry/heading-end-punctuation.js +3 -0
- package/dist/detectors/registry/heading-end-punctuation.js.map +1 -0
- package/dist/detectors/registry/hyphen-dash.d.ts +3 -0
- package/dist/detectors/registry/hyphen-dash.d.ts.map +1 -0
- package/dist/detectors/registry/hyphen-dash.js +3 -0
- package/dist/detectors/registry/hyphen-dash.js.map +1 -0
- package/dist/detectors/registry/image-file-name-alt.d.ts +3 -0
- package/dist/detectors/registry/image-file-name-alt.d.ts.map +1 -0
- package/dist/detectors/registry/image-file-name-alt.js +3 -0
- package/dist/detectors/registry/image-file-name-alt.js.map +1 -0
- package/dist/detectors/registry/impossible-date.d.ts +3 -0
- package/dist/detectors/registry/impossible-date.d.ts.map +1 -0
- package/dist/detectors/registry/impossible-date.js +3 -0
- package/dist/detectors/registry/impossible-date.js.map +1 -0
- package/dist/detectors/registry/impossible-time.d.ts +3 -0
- package/dist/detectors/registry/impossible-time.d.ts.map +1 -0
- package/dist/detectors/registry/impossible-time.js +3 -0
- package/dist/detectors/registry/impossible-time.js.map +1 -0
- package/dist/detectors/registry/latin-abbreviation.d.ts +3 -0
- package/dist/detectors/registry/latin-abbreviation.d.ts.map +1 -0
- package/dist/detectors/registry/latin-abbreviation.js +3 -0
- package/dist/detectors/registry/latin-abbreviation.js.map +1 -0
- package/dist/detectors/registry/link-text-url-mismatch.d.ts +3 -0
- package/dist/detectors/registry/link-text-url-mismatch.d.ts.map +1 -0
- package/dist/detectors/registry/link-text-url-mismatch.js +3 -0
- package/dist/detectors/registry/link-text-url-mismatch.js.map +1 -0
- package/dist/detectors/registry/list-marker.d.ts +3 -0
- package/dist/detectors/registry/list-marker.d.ts.map +1 -0
- package/dist/detectors/registry/list-marker.js +3 -0
- package/dist/detectors/registry/list-marker.js.map +1 -0
- package/dist/detectors/registry/mark-consistency.d.ts +3 -0
- package/dist/detectors/registry/mark-consistency.d.ts.map +1 -0
- package/dist/detectors/registry/mark-consistency.js +3 -0
- package/dist/detectors/registry/mark-consistency.js.map +1 -0
- package/dist/detectors/registry/numeral-opener.d.ts +3 -0
- package/dist/detectors/registry/numeral-opener.d.ts.map +1 -0
- package/dist/detectors/registry/numeral-opener.js +3 -0
- package/dist/detectors/registry/numeral-opener.js.map +1 -0
- package/dist/detectors/registry/ordinal-suffix.d.ts +3 -0
- package/dist/detectors/registry/ordinal-suffix.d.ts.map +1 -0
- package/dist/detectors/registry/ordinal-suffix.js +3 -0
- package/dist/detectors/registry/ordinal-suffix.js.map +1 -0
- package/dist/detectors/registry/origin-particle.d.ts +3 -0
- package/dist/detectors/registry/origin-particle.d.ts.map +1 -0
- package/dist/detectors/registry/origin-particle.js +3 -0
- package/dist/detectors/registry/origin-particle.js.map +1 -0
- package/dist/detectors/registry/range-notation.d.ts +3 -0
- package/dist/detectors/registry/range-notation.d.ts.map +1 -0
- package/dist/detectors/registry/range-notation.js +3 -0
- package/dist/detectors/registry/range-notation.js.map +1 -0
- package/dist/detectors/registry/relative-pronoun-mix.d.ts +3 -0
- package/dist/detectors/registry/relative-pronoun-mix.d.ts.map +1 -0
- package/dist/detectors/registry/relative-pronoun-mix.js +3 -0
- package/dist/detectors/registry/relative-pronoun-mix.js.map +1 -0
- package/dist/detectors/registry/request-without-deadline.d.ts +3 -0
- package/dist/detectors/registry/request-without-deadline.d.ts.map +1 -0
- package/dist/detectors/registry/request-without-deadline.js +3 -0
- package/dist/detectors/registry/request-without-deadline.js.map +1 -0
- package/dist/detectors/registry/sentence-spacing.d.ts +3 -0
- package/dist/detectors/registry/sentence-spacing.d.ts.map +1 -0
- package/dist/detectors/registry/sentence-spacing.js +3 -0
- package/dist/detectors/registry/sentence-spacing.js.map +1 -0
- package/dist/detectors/registry/share-over-hundred.d.ts +3 -0
- package/dist/detectors/registry/share-over-hundred.d.ts.map +1 -0
- package/dist/detectors/registry/share-over-hundred.js +3 -0
- package/dist/detectors/registry/share-over-hundred.js.map +1 -0
- package/dist/detectors/registry/shell-prompt.d.ts +3 -0
- package/dist/detectors/registry/shell-prompt.d.ts.map +1 -0
- package/dist/detectors/registry/shell-prompt.js +3 -0
- package/dist/detectors/registry/shell-prompt.js.map +1 -0
- package/dist/detectors/registry/step-reference.d.ts +3 -0
- package/dist/detectors/registry/step-reference.d.ts.map +1 -0
- package/dist/detectors/registry/step-reference.js +3 -0
- package/dist/detectors/registry/step-reference.js.map +1 -0
- package/dist/detectors/registry/step-statement.d.ts +3 -0
- package/dist/detectors/registry/step-statement.d.ts.map +1 -0
- package/dist/detectors/registry/step-statement.js +3 -0
- package/dist/detectors/registry/step-statement.js.map +1 -0
- package/dist/detectors/registry/table-row-overflow.d.ts +3 -0
- package/dist/detectors/registry/table-row-overflow.d.ts.map +1 -0
- package/dist/detectors/registry/table-row-overflow.js +3 -0
- package/dist/detectors/registry/table-row-overflow.js.map +1 -0
- package/dist/detectors/registry/toc-heading.d.ts +3 -0
- package/dist/detectors/registry/toc-heading.d.ts.map +1 -0
- package/dist/detectors/registry/toc-heading.js +3 -0
- package/dist/detectors/registry/toc-heading.js.map +1 -0
- package/dist/detectors/registry/unclosed-code-fence.d.ts +3 -0
- package/dist/detectors/registry/unclosed-code-fence.d.ts.map +1 -0
- package/dist/detectors/registry/unclosed-code-fence.js +3 -0
- package/dist/detectors/registry/unclosed-code-fence.js.map +1 -0
- package/dist/detectors/registry/unpaired-parallel.d.ts +3 -0
- package/dist/detectors/registry/unpaired-parallel.d.ts.map +1 -0
- package/dist/detectors/registry/unpaired-parallel.js +3 -0
- package/dist/detectors/registry/unpaired-parallel.js.map +1 -0
- package/dist/detectors/registry/unrendered-emphasis.d.ts +3 -0
- package/dist/detectors/registry/unrendered-emphasis.d.ts.map +1 -0
- package/dist/detectors/registry/unrendered-emphasis.js +3 -0
- package/dist/detectors/registry/unrendered-emphasis.js.map +1 -0
- package/dist/detectors/relative-pronoun-mix.d.ts +19 -0
- package/dist/detectors/relative-pronoun-mix.d.ts.map +1 -0
- package/dist/detectors/relative-pronoun-mix.js +60 -0
- package/dist/detectors/relative-pronoun-mix.js.map +1 -0
- package/dist/detectors/request-owner.d.ts +23 -0
- package/dist/detectors/request-owner.d.ts.map +1 -0
- package/dist/detectors/request-owner.js +110 -0
- package/dist/detectors/request-owner.js.map +1 -0
- package/dist/detectors/share-over-hundred.d.ts +20 -0
- package/dist/detectors/share-over-hundred.d.ts.map +1 -0
- package/dist/detectors/share-over-hundred.js +55 -0
- package/dist/detectors/share-over-hundred.js.map +1 -0
- package/dist/detectors/step-reference.d.ts +20 -0
- package/dist/detectors/step-reference.d.ts.map +1 -0
- package/dist/detectors/step-reference.js +57 -0
- package/dist/detectors/step-reference.js.map +1 -0
- package/dist/detectors/technical-docs.d.ts +32 -0
- package/dist/detectors/technical-docs.d.ts.map +1 -0
- package/dist/detectors/technical-docs.js +199 -0
- package/dist/detectors/technical-docs.js.map +1 -0
- package/dist/detectors/toc-heading.d.ts +10 -0
- package/dist/detectors/toc-heading.d.ts.map +1 -0
- package/dist/detectors/toc-heading.js +99 -0
- package/dist/detectors/toc-heading.js.map +1 -0
- package/dist/extension/pack-read.d.ts +21 -0
- package/dist/extension/pack-read.d.ts.map +1 -0
- package/dist/extension/pack-read.js +117 -0
- package/dist/extension/pack-read.js.map +1 -0
- package/dist/extension/plugin-load.d.ts.map +1 -1
- package/dist/extension/plugin-load.js +44 -10
- package/dist/extension/plugin-load.js.map +1 -1
- package/dist/extension/plugin-parse.d.ts.map +1 -1
- package/dist/extension/plugin-parse.js +10 -3
- package/dist/extension/plugin-parse.js.map +1 -1
- package/dist/facts/address-values.d.ts +5 -0
- package/dist/facts/address-values.d.ts.map +1 -0
- package/dist/facts/address-values.js +64 -0
- package/dist/facts/address-values.js.map +1 -0
- package/dist/facts/cross-facts.d.ts +20 -0
- package/dist/facts/cross-facts.d.ts.map +1 -0
- package/dist/facts/cross-facts.js +41 -0
- package/dist/facts/cross-facts.js.map +1 -0
- package/dist/fix-plan/chosen-depth.d.ts +10 -0
- package/dist/fix-plan/chosen-depth.d.ts.map +1 -0
- package/dist/fix-plan/chosen-depth.js +24 -0
- package/dist/fix-plan/chosen-depth.js.map +1 -0
- package/dist/fix-plan/mode.d.ts +13 -4
- package/dist/fix-plan/mode.d.ts.map +1 -1
- package/dist/fix-plan/mode.js +38 -7
- package/dist/fix-plan/mode.js.map +1 -1
- package/dist/fix-plan/plan.d.ts +20 -0
- package/dist/fix-plan/plan.d.ts.map +1 -1
- package/dist/fix-plan/plan.js +23 -5
- package/dist/fix-plan/plan.js.map +1 -1
- package/dist/fix-plan/render.d.ts.map +1 -1
- package/dist/fix-plan/render.js +24 -0
- package/dist/fix-plan/render.js.map +1 -1
- package/dist/fix-plan/text.d.ts +8 -0
- package/dist/fix-plan/text.d.ts.map +1 -1
- package/dist/fix-plan/text.js +36 -10
- package/dist/fix-plan/text.js.map +1 -1
- package/dist/genre-load.d.ts +1 -1
- package/dist/genre-load.d.ts.map +1 -1
- package/dist/genre-load.js +7 -4
- package/dist/genre-load.js.map +1 -1
- package/dist/genre-parse.d.ts +6 -0
- package/dist/genre-parse.d.ts.map +1 -1
- package/dist/genre-parse.js +18 -0
- package/dist/genre-parse.js.map +1 -1
- package/dist/init.js +10 -10
- package/dist/init.js.map +1 -1
- package/dist/known-genres.d.ts +8 -0
- package/dist/known-genres.d.ts.map +1 -0
- package/dist/known-genres.js +17 -0
- package/dist/known-genres.js.map +1 -0
- package/dist/link-shape.d.ts +20 -0
- package/dist/link-shape.d.ts.map +1 -0
- package/dist/link-shape.js +58 -0
- package/dist/link-shape.js.map +1 -0
- package/dist/list-marks.d.ts +21 -0
- package/dist/list-marks.d.ts.map +1 -0
- package/dist/list-marks.js +82 -0
- package/dist/list-marks.js.map +1 -0
- package/dist/reasons.d.ts.map +1 -1
- package/dist/reasons.js +15 -4
- package/dist/reasons.js.map +1 -1
- package/dist/render/explain.d.ts.map +1 -1
- package/dist/render/explain.js +11 -2
- package/dist/render/explain.js.map +1 -1
- package/dist/render/friendly.js +1 -1
- package/dist/render/friendly.js.map +1 -1
- package/dist/render/rules-json.d.ts.map +1 -1
- package/dist/render/rules-json.js +12 -3
- package/dist/render/rules-json.js.map +1 -1
- package/dist/render/rules-table.js +6 -6
- package/dist/render/rules-table.js.map +1 -1
- package/dist/render/semantic.js +2 -2
- package/dist/render/semantic.js.map +1 -1
- package/dist/render/suppressions.js +2 -2
- package/dist/render/suppressions.js.map +1 -1
- package/dist/rewrite-depth.d.ts +22 -0
- package/dist/rewrite-depth.d.ts.map +1 -0
- package/dist/rewrite-depth.js +42 -0
- package/dist/rewrite-depth.js.map +1 -0
- package/dist/rule-fields.d.ts +28 -0
- package/dist/rule-fields.d.ts.map +1 -0
- package/dist/rule-fields.js +85 -0
- package/dist/rule-fields.js.map +1 -0
- package/dist/rule-guide.d.ts +3 -0
- package/dist/rule-guide.d.ts.map +1 -1
- package/dist/rule-guide.js +6 -0
- package/dist/rule-guide.js.map +1 -1
- package/dist/rule-load.d.ts.map +1 -1
- package/dist/rule-load.js +13 -5
- package/dist/rule-load.js.map +1 -1
- package/dist/rule-offs.d.ts +14 -0
- package/dist/rule-offs.d.ts.map +1 -0
- package/dist/rule-offs.js +45 -0
- package/dist/rule-offs.js.map +1 -0
- package/dist/structure/build.d.ts.map +1 -1
- package/dist/structure/build.js +14 -1
- package/dist/structure/build.js.map +1 -1
- package/dist/structure/cross-definitions.d.ts +23 -0
- package/dist/structure/cross-definitions.d.ts.map +1 -0
- package/dist/structure/cross-definitions.js +34 -0
- package/dist/structure/cross-definitions.js.map +1 -0
- package/genres.yaml +14 -313
- package/package.json +3 -3
- package/rules/absolute-exception.yaml +3 -1
- package/rules/abstract-length.yaml +7 -1
- package/rules/acronym-expansion-conflict.yaml +2 -1
- package/rules/adverb-overuse.yaml +7 -1
- package/rules/adverb-without-negation.yaml +60 -0
- package/rules/adversative-ga-repeat.yaml +2 -1
- package/rules/agentless-passive.yaml +10 -1
- package/rules/agreement-slip.yaml +4 -1
- package/rules/ai-generated-composite.yaml +6 -1
- package/rules/ai-structure.yaml +8 -2
- package/rules/ai-tell.yaml +7 -1
- package/rules/all-caps-shouting.yaml +61 -0
- package/rules/announced-count-mismatch.yaml +3 -1
- package/rules/announcing-opener.yaml +7 -1
- package/rules/article-sound.yaml +6 -2
- package/rules/assistant-residue.yaml +4 -1
- package/rules/attachment-not-attached.yaml +112 -0
- package/rules/baito-keigo.yaml +64 -0
- package/rules/bare-url-mix.yaml +86 -0
- package/rules/bold-density.yaml +1 -0
- package/rules/bold-label-list.yaml +9 -1
- package/rules/bracket-nesting.yaml +2 -1
- package/rules/bracket-width-consistency.yaml +64 -0
- package/rules/broken-link.yaml +1 -1
- package/rules/chat-citation-residue.yaml +2 -1
- package/rules/citation-reference-mismatch.yaml +7 -1
- package/rules/citation-style-mix.yaml +7 -1
- package/rules/clause-chain.yaml +6 -1
- package/rules/cliche.yaml +67 -0
- package/rules/closing-cliche.yaml +7 -0
- package/rules/code-fence-language-mix.yaml +176 -0
- package/rules/colloquial-opener.yaml +62 -0
- package/rules/colon-lead-in.yaml +7 -1
- package/rules/concrete-evidence-density.yaml +6 -0
- package/rules/contraction-consistency.yaml +4 -1
- package/rules/contrast-framing.yaml +7 -1
- package/rules/cross-doc-duplicate-definition.yaml +70 -0
- package/rules/cross-doc-fact-conflict.yaml +64 -0
- package/rules/currency-notation-consistency.yaml +77 -0
- package/rules/cushion-phrase-density.yaml +8 -1
- package/rules/dangling-figure-reference.yaml +3 -1
- package/rules/dangling-participle.yaml +58 -0
- package/rules/dangling-reference.yaml +3 -1
- package/rules/date-format-consistency.yaml +3 -2
- package/rules/date-order.yaml +3 -1
- package/rules/date-range-reversed.yaml +3 -1
- package/rules/date-weekday-mismatch.yaml +3 -1
- package/rules/date-without-year.yaml +4 -3
- package/rules/defined-name-repeated.yaml +97 -0
- package/rules/defined-term-form.yaml +113 -0
- package/rules/demonstrative-opener-run.yaml +2 -1
- package/rules/double-keigo.yaml +6 -1
- package/rules/double-negative.yaml +5 -1
- package/rules/doubled-nado.yaml +2 -1
- package/rules/doubled-punctuation.yaml +1 -1
- package/rules/doubled-word.yaml +4 -1
- package/rules/duplicate-definition.yaml +3 -1
- package/rules/duplicate-heading.yaml +1 -1
- package/rules/duration-mismatch.yaml +2 -1
- package/rules/elapsed-years-mismatch.yaml +4 -1
- package/rules/email-greeting-closing.yaml +122 -0
- package/rules/email-subject-length.yaml +112 -0
- package/rules/emoji-density.yaml +3 -1
- package/rules/emoji-heading.yaml +7 -1
- package/rules/empty-intensifier.yaml +4 -0
- package/rules/empty-list-item.yaml +2 -1
- package/rules/empty-section.yaml +1 -1
- package/rules/empty-table-cell.yaml +2 -1
- package/rules/excessive-hedging.yaml +7 -1
- package/rules/exclamation-width-consistency.yaml +64 -0
- package/rules/expletive-construction.yaml +7 -1
- package/rules/fact-conflict.yaml +4 -1
- package/rules/figure-reference-order.yaml +7 -1
- package/rules/footnote-mismatch.yaml +91 -0
- package/rules/fullwidth-alnum-consistency.yaml +2 -2
- package/rules/hankaku-kana.yaml +1 -1
- package/rules/heading-command-missing.yaml +109 -0
- package/rules/heading-echo.yaml +6 -1
- package/rules/heading-end-punctuation-mix.yaml +158 -0
- package/rules/heading-level-skip.yaml +3 -3
- package/rules/heading-numbering-mix.yaml +4 -3
- package/rules/hiragana-fukushi.yaml +4 -1
- package/rules/homophone-slip.yaml +5 -1
- package/rules/humble-for-others.yaml +63 -0
- package/rules/hyphen-as-dash.yaml +59 -0
- package/rules/idiom-misuse.yaml +4 -1
- package/rules/image-file-name-alt.yaml +83 -0
- package/rules/impossible-date.yaml +79 -0
- package/rules/impossible-time.yaml +76 -0
- package/rules/internal-jargon.yaml +1 -1
- package/rules/invisible-character.yaml +1 -1
- package/rules/katakana-density.yaml +2 -1
- package/rules/katakana-long-vowel.yaml +1 -1
- package/rules/known-misspelling.yaml +2 -1
- package/rules/kutoten-consistency.yaml +1 -1
- package/rules/latin-abbreviation-form.yaml +58 -0
- package/rules/latin-spacing.yaml +6 -2
- package/rules/less-for-fewer.yaml +59 -0
- package/rules/link-text-url-mismatch.yaml +72 -0
- package/rules/list-item-form-mix.yaml +7 -1
- package/rules/list-marker-mix.yaml +111 -0
- package/rules/max-kanji-continuous.yaml +10 -2
- package/rules/max-paragraph-length.yaml +4 -1
- package/rules/max-sentence-length.yaml +29 -21
- package/rules/max-ten.yaml +4 -1
- package/rules/misconversion.yaml +2 -1
- package/rules/modal-conflict.yaml +2 -1
- package/rules/name-variant.yaml +4 -3
- package/rules/ngram-repetition.yaml +5 -0
- package/rules/no-doubled-joshi.yaml +5 -1
- package/rules/no-em-dash.yaml +4 -1
- package/rules/no-lead.yaml +6 -1
- package/rules/no-mixed-desumasu.yaml +5 -2
- package/rules/no-nakaguro-parallel.yaml +3 -0
- package/rules/nominalization.yaml +5 -1
- package/rules/nonstandard-word.yaml +80 -0
- package/rules/number-style-consistency.yaml +6 -1
- package/rules/number-without-unit.yaml +2 -1
- package/rules/numbering-gap.yaml +1 -1
- package/rules/numeral-sentence-start.yaml +56 -0
- package/rules/one-sentence-paragraph-run.yaml +5 -1
- package/rules/ordinal-suffix-mismatch.yaml +65 -0
- package/rules/orthographic-variant.yaml +4 -1
- package/rules/outside-announced-list.yaml +2 -1
- package/rules/oxford-comma-consistency.yaml +3 -1
- package/rules/padded-intro.yaml +7 -0
- package/rules/paragraph-length-variance.yaml +7 -1
- package/rules/paragraph-restatement.yaml +6 -1
- package/rules/percent-sum-mismatch.yaml +3 -1
- package/rules/person-consistency.yaml +4 -1
- package/rules/preamble-length.yaml +6 -0
- package/rules/preferred-term.yaml +1 -1
- package/rules/proper-noun-density.yaml +8 -1
- package/rules/quote-style-consistency.yaml +66 -0
- package/rules/ra-nuki.yaml +4 -1
- package/rules/range-notation-consistency.yaml +73 -0
- package/rules/redundant-expression.yaml +4 -1
- package/rules/reference-title-mismatch.yaml +4 -3
- package/rules/reference-topic-missing.yaml +2 -1
- package/rules/relative-date-mismatch.yaml +2 -1
- package/rules/repeated-conjunction.yaml +4 -1
- package/rules/repeated-sentence-ending.yaml +62 -0
- package/rules/repeated-sentence-head.yaml +4 -0
- package/rules/request-without-deadline.yaml +92 -0
- package/rules/required-sections.yaml +1 -1
- package/rules/requirement-modal.yaml +1 -1
- package/rules/requirement-smell.yaml +12 -4
- package/rules/rule-of-three.yaml +8 -1
- package/rules/sasete-itadaku.yaml +7 -1
- package/rules/section-length-uniformity.yaml +7 -1
- package/rules/sentence-initial-conjunction-run.yaml +5 -1
- package/rules/sentence-initial-so.yaml +6 -1
- package/rules/sentence-rhythm.yaml +8 -1
- package/rules/sentence-spacing-consistency.yaml +63 -0
- package/rules/share-over-hundred.yaml +65 -0
- package/rules/shell-prompt-mix.yaml +128 -0
- package/rules/space-before-punctuation.yaml +1 -1
- package/rules/spelling-consistency.yaml +3 -1
- package/rules/step-reference-missing.yaml +85 -0
- package/rules/step-statement-mix.yaml +76 -0
- package/rules/stock-transition.yaml +8 -1
- package/rules/stray-space.yaml +2 -2
- package/rules/summary-fact-mismatch.yaml +4 -1
- package/rules/table-header-variant.yaml +2 -1
- package/rules/table-row-overflow.yaml +90 -0
- package/rules/taigen-dome-in-prose.yaml +6 -0
- package/rules/tari-unpaired.yaml +58 -0
- package/rules/teki-overuse.yaml +2 -1
- package/rules/title-case-consistency.yaml +1 -1
- package/rules/title-length.yaml +7 -1
- package/rules/toc-heading-mismatch.yaml +136 -0
- package/rules/topic-predicate-distance.yaml +6 -1
- package/rules/total-mismatch.yaml +3 -1
- package/rules/translationese-density.yaml +4 -1
- package/rules/unbalanced-bracket.yaml +3 -3
- package/rules/unclosed-code-fence.yaml +107 -0
- package/rules/uncomparable-graded.yaml +65 -0
- package/rules/undefined-acronym.yaml +8 -1
- package/rules/unfilled-placeholder.yaml +1 -1
- package/rules/unit-mismatch.yaml +2 -1
- package/rules/unknown-word.yaml +4 -1
- package/rules/unqualified-superlative.yaml +6 -1
- package/rules/unrendered-emphasis.yaml +73 -0
- package/rules/unused-definition.yaml +4 -3
- package/rules/url-run-on.yaml +1 -1
- package/rules/use-before-definition.yaml +4 -3
- package/rules/vague-figure-reference.yaml +3 -1
- package/rules/vague-link-text.yaml +2 -1
- package/rules/vague-word-density.yaml +2 -1
- package/rules/very-adjective.yaml +5 -1
- package/rules/weasel-word.yaml +6 -1
- package/rules/which-that-consistency.yaml +64 -0
- package/rules/wordy-phrase.yaml +6 -1
- package/rules/yori-as-from.yaml +61 -0
- package/skills/chaff/SKILL.md +7 -7
- package/src/api.ts +13 -1
- package/src/cli-text.ts +22 -7
- package/src/cli.ts +8 -9
- package/src/command-help.ts +26 -0
- package/src/commands/eval.ts +2 -2
- package/src/commands/fix-plan.ts +13 -1
- package/src/commands/help.ts +8 -0
- package/src/commands/init-command.ts +13 -0
- package/src/commands/plugin-init.ts +150 -0
- package/src/commands/plugin-test.ts +111 -0
- package/src/config/load.ts +3 -0
- package/src/config/option-problems.ts +2 -2
- package/src/config/rule-problems.ts +2 -2
- package/src/custom/checked.ts +8 -0
- package/src/custom/dsl-fields.ts +102 -0
- package/src/custom/load.ts +2 -0
- package/src/custom/parse.ts +72 -50
- package/src/custom/problems.ts +16 -2
- package/src/detectors/amount-for-count.ts +90 -0
- package/src/detectors/blank-structure.ts +12 -4
- package/src/detectors/clause-shape.ts +199 -0
- package/src/detectors/code-fences.ts +113 -0
- package/src/detectors/cross-definitions.ts +49 -0
- package/src/detectors/cross-facts.ts +60 -0
- package/src/detectors/cross-registry/cross-doc-duplicate-definition.ts +4 -0
- package/src/detectors/cross-registry/cross-doc-fact-conflict.ts +4 -0
- package/src/detectors/currency-notation.ts +90 -0
- package/src/detectors/custom.ts +10 -2
- package/src/detectors/dangling-opener.ts +74 -0
- package/src/detectors/defined-term-form.ts +200 -0
- package/src/detectors/email-letter.ts +262 -0
- package/src/detectors/footnote-mismatch.ts +72 -0
- package/src/detectors/form-minority.ts +21 -0
- package/src/detectors/heading-end-mark.ts +82 -0
- package/src/detectors/impossible-date.ts +141 -0
- package/src/detectors/impossible-time.ts +151 -0
- package/src/detectors/link-shape.ts +70 -0
- package/src/detectors/list-marker.ts +60 -0
- package/src/detectors/mark-shape.ts +202 -0
- package/src/detectors/markdown-slip.ts +140 -0
- package/src/detectors/numeral-opener.ts +72 -0
- package/src/detectors/ordinal-suffix.ts +40 -0
- package/src/detectors/range-notation.ts +76 -0
- package/src/detectors/registry/adverb-polarity.ts +4 -0
- package/src/detectors/registry/amount-for-count.ts +4 -0
- package/src/detectors/registry/attachment-missing.ts +4 -0
- package/src/detectors/registry/bare-url-mix.ts +4 -0
- package/src/detectors/registry/caps-shouting.ts +4 -0
- package/src/detectors/registry/code-fence-language.ts +4 -0
- package/src/detectors/registry/currency-notation.ts +4 -0
- package/src/detectors/registry/dangling-opener.ts +4 -0
- package/src/detectors/registry/defined-name-repeated.ts +4 -0
- package/src/detectors/registry/defined-term-form.ts +4 -0
- package/src/detectors/registry/email-frame.ts +4 -0
- package/src/detectors/registry/email-subject.ts +4 -0
- package/src/detectors/registry/ending-run.ts +4 -0
- package/src/detectors/registry/footnote-mismatch.ts +4 -0
- package/src/detectors/registry/heading-command.ts +4 -0
- package/src/detectors/registry/heading-end-punctuation.ts +4 -0
- package/src/detectors/registry/hyphen-dash.ts +4 -0
- package/src/detectors/registry/image-file-name-alt.ts +4 -0
- package/src/detectors/registry/impossible-date.ts +4 -0
- package/src/detectors/registry/impossible-time.ts +4 -0
- package/src/detectors/registry/latin-abbreviation.ts +4 -0
- package/src/detectors/registry/link-text-url-mismatch.ts +4 -0
- package/src/detectors/registry/list-marker.ts +4 -0
- package/src/detectors/registry/mark-consistency.ts +4 -0
- package/src/detectors/registry/numeral-opener.ts +4 -0
- package/src/detectors/registry/ordinal-suffix.ts +4 -0
- package/src/detectors/registry/origin-particle.ts +4 -0
- package/src/detectors/registry/range-notation.ts +4 -0
- package/src/detectors/registry/relative-pronoun-mix.ts +4 -0
- package/src/detectors/registry/request-without-deadline.ts +4 -0
- package/src/detectors/registry/sentence-spacing.ts +4 -0
- package/src/detectors/registry/share-over-hundred.ts +4 -0
- package/src/detectors/registry/shell-prompt.ts +4 -0
- package/src/detectors/registry/step-reference.ts +4 -0
- package/src/detectors/registry/step-statement.ts +4 -0
- package/src/detectors/registry/table-row-overflow.ts +4 -0
- package/src/detectors/registry/toc-heading.ts +4 -0
- package/src/detectors/registry/unclosed-code-fence.ts +4 -0
- package/src/detectors/registry/unpaired-parallel.ts +4 -0
- package/src/detectors/registry/unrendered-emphasis.ts +4 -0
- package/src/detectors/relative-pronoun-mix.ts +79 -0
- package/src/detectors/request-owner.ts +141 -0
- package/src/detectors/share-over-hundred.ts +75 -0
- package/src/detectors/step-reference.ts +83 -0
- package/src/detectors/technical-docs.ts +230 -0
- package/src/detectors/toc-heading.ts +125 -0
- package/src/extension/pack-read.ts +128 -0
- package/src/extension/plugin-load.ts +49 -9
- package/src/extension/plugin-parse.ts +10 -3
- package/src/facts/address-values.ts +74 -0
- package/src/facts/cross-facts.ts +54 -0
- package/src/fix-plan/chosen-depth.ts +28 -0
- package/src/fix-plan/mode.ts +57 -11
- package/src/fix-plan/plan.ts +37 -5
- package/src/fix-plan/render.ts +24 -0
- package/src/fix-plan/text.ts +47 -10
- package/src/genre-load.ts +7 -4
- package/src/genre-parse.ts +19 -0
- package/src/init.ts +10 -10
- package/src/known-genres.ts +19 -0
- package/src/link-shape.ts +62 -0
- package/src/list-marks.ts +106 -0
- package/src/reasons.ts +16 -4
- package/src/render/explain.ts +14 -2
- package/src/render/friendly.ts +1 -1
- package/src/render/rules-json.ts +14 -3
- package/src/render/rules-table.ts +6 -6
- package/src/render/semantic.ts +2 -2
- package/src/render/suppressions.ts +2 -2
- package/src/rewrite-depth.ts +60 -0
- package/src/rule-fields.ts +123 -0
- package/src/rule-guide.ts +9 -0
- package/src/rule-load.ts +10 -4
- package/src/rule-offs.ts +50 -0
- package/src/structure/build.ts +21 -1
- package/src/structure/cross-definitions.ts +60 -0
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
id: toc-heading-mismatch
|
|
2
|
+
layer: L3
|
|
3
|
+
status: stable
|
|
4
|
+
how_to_find: toc-heading
|
|
5
|
+
requires: [markdown]
|
|
6
|
+
severity: warning
|
|
7
|
+
|
|
8
|
+
name:
|
|
9
|
+
ja: 見出しの無い目次の項目
|
|
10
|
+
en: A table-of-contents entry with no heading
|
|
11
|
+
|
|
12
|
+
why:
|
|
13
|
+
ja: 目次に「3.2 費用」とあるのに本文にその見出しが無ければ、読み手は目次から探しても行き着けません。見出しを書き換えたり節を消したりしたあとに、目次だけが古いまま残ると起きます。目次の項目と見出しの言葉を突き合わせれば、機械で言えます。
|
|
14
|
+
en: When the table of contents lists "3.2 Costs" and the text has no such heading, the reader cannot get there from the contents. It happens when a heading is renamed or a section removed and the contents are left as they were. Matching the entries against the headings is mechanical.
|
|
15
|
+
|
|
16
|
+
message:
|
|
17
|
+
ja: 目次の「{entry}」に合う見出しがありません
|
|
18
|
+
en: 'No heading matches the contents entry "{entry}"'
|
|
19
|
+
|
|
20
|
+
how_to_fix:
|
|
21
|
+
ja: 目次を見出しに合わせて直すか、消えた節の項目を目次から消してください。
|
|
22
|
+
en: Update the entry to match the heading, or remove the entry for a section that is gone.
|
|
23
|
+
|
|
24
|
+
levels: { normal: warning, relaxed: info }
|
|
25
|
+
|
|
26
|
+
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
27
|
+
|
|
28
|
+
group: structure
|
|
29
|
+
summary:
|
|
30
|
+
ja: 目次(「目次」「Contents」の見出しの下の箇条書き)の項目のうち、文書のどの見出しとも合わないもの
|
|
31
|
+
en: An entry of the table of contents (the list under a "Contents" heading) that matches no heading of the document
|
|
32
|
+
example:
|
|
33
|
+
ja:
|
|
34
|
+
before: |
|
|
35
|
+
## 目次
|
|
36
|
+
|
|
37
|
+
- 1 概要
|
|
38
|
+
- 2 費用
|
|
39
|
+
- 3 日程
|
|
40
|
+
|
|
41
|
+
## 1 概要
|
|
42
|
+
|
|
43
|
+
本書の概要です。
|
|
44
|
+
|
|
45
|
+
## 2 料金
|
|
46
|
+
|
|
47
|
+
料金の説明です。
|
|
48
|
+
|
|
49
|
+
## 3 日程
|
|
50
|
+
|
|
51
|
+
日程の説明です。
|
|
52
|
+
after: |
|
|
53
|
+
## 目次
|
|
54
|
+
|
|
55
|
+
- 1 概要
|
|
56
|
+
- 2 料金
|
|
57
|
+
- 3 日程
|
|
58
|
+
|
|
59
|
+
## 1 概要
|
|
60
|
+
|
|
61
|
+
本書の概要です。
|
|
62
|
+
|
|
63
|
+
## 2 料金
|
|
64
|
+
|
|
65
|
+
料金の説明です。
|
|
66
|
+
|
|
67
|
+
## 3 日程
|
|
68
|
+
|
|
69
|
+
日程の説明です。
|
|
70
|
+
en:
|
|
71
|
+
before: |
|
|
72
|
+
## Contents
|
|
73
|
+
|
|
74
|
+
- 1 Overview
|
|
75
|
+
- 2 Costs
|
|
76
|
+
- 3 Schedule
|
|
77
|
+
|
|
78
|
+
## 1 Overview
|
|
79
|
+
|
|
80
|
+
An overview.
|
|
81
|
+
|
|
82
|
+
## 2 Fees
|
|
83
|
+
|
|
84
|
+
The fees.
|
|
85
|
+
|
|
86
|
+
## 3 Schedule
|
|
87
|
+
|
|
88
|
+
The schedule.
|
|
89
|
+
after: |
|
|
90
|
+
## Contents
|
|
91
|
+
|
|
92
|
+
- 1 Overview
|
|
93
|
+
- 2 Fees
|
|
94
|
+
- 3 Schedule
|
|
95
|
+
|
|
96
|
+
## 1 Overview
|
|
97
|
+
|
|
98
|
+
An overview.
|
|
99
|
+
|
|
100
|
+
## 2 Fees
|
|
101
|
+
|
|
102
|
+
The fees.
|
|
103
|
+
|
|
104
|
+
## 3 Schedule
|
|
105
|
+
|
|
106
|
+
The schedule.
|
|
107
|
+
|
|
108
|
+
not_flagged:
|
|
109
|
+
ja: 項目と見出しは、空白・記号・大文字小文字を無視して比べ、頭の番号(1.2、2-1)と、ページ番号(…… 12)を外しても比べます。リンクの項目は字の部分を比べます(リンクの行き先は broken-link が見ます)。目次の項目の半分より多くが見出しに合わない文書は、本文と別の章立ての目次と読んで言いません。Markdown の見出しのある文書だけを見ます。
|
|
110
|
+
en: Entries and headings are compared ignoring spaces, punctuation and case, and again without a leading number (1.2, 2-1) or a page number (.... 12). For a linked entry the link text is compared (broken-link checks where it points). When more than half of the entries match no heading, the contents are read as following another outline and nothing is reported. Only Markdown documents with headings are checked.
|
|
111
|
+
|
|
112
|
+
rewrite:
|
|
113
|
+
ja:
|
|
114
|
+
direction: 目次の項目を、本文の見出しの言葉と番号に合わせてください。節を消したのなら、その項目を目次から消します。
|
|
115
|
+
pairs:
|
|
116
|
+
- before: 目次の「2 費用」(見出しは「2 料金」)
|
|
117
|
+
after: 目次の「2 料金」
|
|
118
|
+
- before: 目次の「4 付録」(本文に付録の節が無い)
|
|
119
|
+
after: 目次から「4 付録」を消す
|
|
120
|
+
keep:
|
|
121
|
+
- 本文の見出し
|
|
122
|
+
- 目次の並び順
|
|
123
|
+
avoid:
|
|
124
|
+
- 目次に合わせて本文の見出しを書き換える
|
|
125
|
+
en:
|
|
126
|
+
direction: Make each contents entry match the heading's words and number. If a section was removed, remove its entry.
|
|
127
|
+
pairs:
|
|
128
|
+
- before: The contents entry "2 Costs" (the heading is "2 Fees")
|
|
129
|
+
after: The contents entry "2 Fees"
|
|
130
|
+
- before: The contents entry "4 Appendix" (no appendix in the text)
|
|
131
|
+
after: The entry "4 Appendix" removed
|
|
132
|
+
keep:
|
|
133
|
+
- the headings in the text
|
|
134
|
+
- the order of the contents
|
|
135
|
+
avoid:
|
|
136
|
+
- renaming a heading in the text to match the contents
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
id: topic-predicate-distance
|
|
2
2
|
layer: L3
|
|
3
|
-
status:
|
|
3
|
+
status: stable
|
|
4
4
|
how_to_find: topic-predicate-distance
|
|
5
5
|
requires: [pos]
|
|
6
6
|
languages: [ja]
|
|
@@ -24,6 +24,10 @@ how_to_fix:
|
|
|
24
24
|
|
|
25
25
|
levels: { strict: 60, normal: 80, relaxed: 100 }
|
|
26
26
|
|
|
27
|
+
# 法令と契約は、主題の後に要件と例外を挟んでから述語を置く。既定の上限では group の文書の大半に出たので、測って上げた(spec §21.1)。
|
|
28
|
+
by_genre:
|
|
29
|
+
legal: { strict: 160, normal: 200, relaxed: 260 }
|
|
30
|
+
|
|
27
31
|
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
28
32
|
|
|
29
33
|
group: readability
|
|
@@ -44,6 +48,7 @@ level_meaning:
|
|
|
44
48
|
ja: 主題から述語まで {limit} 字まで
|
|
45
49
|
en: up to {limit} characters between the topic and the predicate
|
|
46
50
|
rewrite:
|
|
51
|
+
depth: light
|
|
47
52
|
ja:
|
|
48
53
|
direction: 主題(〜は)を述語の近くに動かすか、主題と述語の間に挟んだ説明を前の文に出してください。
|
|
49
54
|
pairs:
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
id: total-mismatch
|
|
2
2
|
layer: L3
|
|
3
|
-
status:
|
|
3
|
+
status: stable
|
|
4
4
|
how_to_find: total-mismatch
|
|
5
5
|
requires: [quantities]
|
|
6
6
|
severity: error
|
|
@@ -24,6 +24,8 @@ how_to_fix:
|
|
|
24
24
|
levels: { normal: error, relaxed: warning }
|
|
25
25
|
|
|
26
26
|
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
27
|
+
off_for:
|
|
28
|
+
literature: "Length, rhythm, repetition and register are the author's choices in literature, and dialogue mixes styles. Only what one work can hold itself to runs: consistent spacing and commas, and numbering without gaps."
|
|
27
29
|
sources: [de-marneffe-2008]
|
|
28
30
|
|
|
29
31
|
group: facts
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
id: translationese-density
|
|
2
2
|
layer: L2
|
|
3
|
-
status:
|
|
3
|
+
status: stable
|
|
4
4
|
how_to_find: phrase-density
|
|
5
5
|
word_list: translationese
|
|
6
6
|
uses: [pos]
|
|
@@ -27,6 +27,8 @@ how_to_fix:
|
|
|
27
27
|
levels: { strict: 0, normal: 1, relaxed: 2 }
|
|
28
28
|
|
|
29
29
|
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
30
|
+
off_for:
|
|
31
|
+
literature: "Length, rhythm, repetition and register are the author's choices in literature, and dialogue mixes styles. Only what one work can hold itself to runs: consistent spacing and commas, and numbering without gaps."
|
|
30
32
|
|
|
31
33
|
group: ai-tells
|
|
32
34
|
summary:
|
|
@@ -47,6 +49,7 @@ level_meaning:
|
|
|
47
49
|
ja: 1000 字あたり翻訳調の言い回し {limit} 個まで
|
|
48
50
|
en: up to {limit} translated phrasings per 1000 characters
|
|
49
51
|
rewrite:
|
|
52
|
+
depth: light
|
|
50
53
|
ja:
|
|
51
54
|
direction: 英語の構文を写した言い回しを、日本語として素直な言い方に直してください。語彙表の語ごとの書き換え(〜を可能にする → 〜ができる)に従い、主語の「あなたは」「彼女は」は省くか名前で呼びます。書いてある事実は変えません。
|
|
52
55
|
pairs:
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
id: unbalanced-bracket
|
|
2
2
|
layer: L1
|
|
3
|
-
status:
|
|
3
|
+
status: stable
|
|
4
4
|
how_to_find: unbalanced-bracket
|
|
5
|
-
severity:
|
|
5
|
+
severity: info
|
|
6
6
|
|
|
7
7
|
name:
|
|
8
8
|
ja: 括弧が組になっていない
|
|
@@ -31,7 +31,7 @@ how_to_fix:
|
|
|
31
31
|
ja: 足りない括弧を足すか、余分な括弧を消してください。全角と半角は、開きと閉じをそろえてください。
|
|
32
32
|
en: Add the missing bracket or remove the extra one. Make the opening and closing marks the same width.
|
|
33
33
|
|
|
34
|
-
levels: { strict:
|
|
34
|
+
levels: { strict: warning, normal: info, relaxed: info }
|
|
35
35
|
|
|
36
36
|
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
37
37
|
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
id: unclosed-code-fence
|
|
2
|
+
layer: L1
|
|
3
|
+
status: stable
|
|
4
|
+
how_to_find: unclosed-code-fence
|
|
5
|
+
requires: [markdown]
|
|
6
|
+
severity: warning
|
|
7
|
+
|
|
8
|
+
name:
|
|
9
|
+
ja: 閉じていないコードブロック
|
|
10
|
+
en: Unclosed code fence
|
|
11
|
+
|
|
12
|
+
why:
|
|
13
|
+
ja: 「```」で始めたコードブロックを閉じ忘れると、Markdown は文書の終わり(リストの項目の中ならその項目の終わり)までをすべてコードとして表示します。後ろの見出しも本文も等幅の字の塊になり、読み手には文書が壊れて見えます。
|
|
14
|
+
en: A code block opened with "```" and never closed runs to the end of the document (or of the list item it is in), so Markdown shows everything after it as code. The headings and text that follow turn into one block of monospaced text, and the document looks broken.
|
|
15
|
+
|
|
16
|
+
message:
|
|
17
|
+
ja: 「{fence}」で始めたコードブロックが閉じていません
|
|
18
|
+
en: 'The code block opened with "{fence}" is never closed'
|
|
19
|
+
|
|
20
|
+
how_to_fix:
|
|
21
|
+
ja: コードの終わりに、始めと同じ記号を同じ数以上並べた行(「```」)を足してください。
|
|
22
|
+
en: Add a line after the code with the same character, at least as many ("```").
|
|
23
|
+
|
|
24
|
+
placeholders:
|
|
25
|
+
fence:
|
|
26
|
+
ja: 記号
|
|
27
|
+
en: the fence
|
|
28
|
+
|
|
29
|
+
levels: { strict: error, normal: warning, relaxed: info }
|
|
30
|
+
|
|
31
|
+
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
32
|
+
|
|
33
|
+
group: structure
|
|
34
|
+
summary:
|
|
35
|
+
ja: 「```」で始めたまま閉じていないコードブロック(後ろがすべてコードになる)
|
|
36
|
+
en: A code block opened with "```" and never closed (everything after it shows as code)
|
|
37
|
+
example:
|
|
38
|
+
ja:
|
|
39
|
+
before: |
|
|
40
|
+
手順は次のとおりです。
|
|
41
|
+
|
|
42
|
+
```sh
|
|
43
|
+
npm install
|
|
44
|
+
|
|
45
|
+
## 確認
|
|
46
|
+
|
|
47
|
+
動くことを確かめます。
|
|
48
|
+
after: |
|
|
49
|
+
手順は次のとおりです。
|
|
50
|
+
|
|
51
|
+
```sh
|
|
52
|
+
npm install
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## 確認
|
|
56
|
+
|
|
57
|
+
動くことを確かめます。
|
|
58
|
+
en:
|
|
59
|
+
before: |
|
|
60
|
+
Install it first.
|
|
61
|
+
|
|
62
|
+
```sh
|
|
63
|
+
npm install
|
|
64
|
+
|
|
65
|
+
## Check
|
|
66
|
+
|
|
67
|
+
Make sure it runs.
|
|
68
|
+
after: |
|
|
69
|
+
Install it first.
|
|
70
|
+
|
|
71
|
+
```sh
|
|
72
|
+
npm install
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Check
|
|
76
|
+
|
|
77
|
+
Make sure it runs.
|
|
78
|
+
|
|
79
|
+
not_flagged:
|
|
80
|
+
ja: 閉じたコードブロック、字下げで書いたコードブロック、引用の中のコードブロックは指しません。
|
|
81
|
+
en: A closed code block, an indented code block, and a code block in a quotation are not reported.
|
|
82
|
+
rewrite:
|
|
83
|
+
depth: light
|
|
84
|
+
ja:
|
|
85
|
+
direction: コードの終わりに閉じる行(「```」)を足してください。どこまでがコードかは、コマンドや出力の並びの終わりで決めます。コードの中身は変えません。
|
|
86
|
+
pairs:
|
|
87
|
+
- before: 「```sh」「npm install」「## 確認」
|
|
88
|
+
after: 「```sh」「npm install」「```」「## 確認」
|
|
89
|
+
- before: 「~~~」「SELECT 1;」のまま文書が終わる
|
|
90
|
+
after: 「~~~」「SELECT 1;」「~~~」
|
|
91
|
+
keep:
|
|
92
|
+
- コードの中身
|
|
93
|
+
- 始めの行の言語名
|
|
94
|
+
avoid:
|
|
95
|
+
- 後ろの本文までコードの中に入れる
|
|
96
|
+
en:
|
|
97
|
+
direction: Add a closing line ("```") where the code ends; the code ends where the commands or the output stop. Keep the code as it is.
|
|
98
|
+
pairs:
|
|
99
|
+
- before: '"```sh", "npm install", "## Check"'
|
|
100
|
+
after: '"```sh", "npm install", "```", "## Check"'
|
|
101
|
+
- before: 'the document ends after "~~~" and "SELECT 1;"'
|
|
102
|
+
after: '"~~~", "SELECT 1;", "~~~"'
|
|
103
|
+
keep:
|
|
104
|
+
- the code
|
|
105
|
+
- the language name on the opening line
|
|
106
|
+
avoid:
|
|
107
|
+
- putting the text after it inside the code block
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
id: uncomparable-graded
|
|
2
|
+
layer: L2
|
|
3
|
+
status: stable
|
|
4
|
+
how_to_find: phrase-match
|
|
5
|
+
word_list: uncomparable-graded
|
|
6
|
+
requires: [pos]
|
|
7
|
+
languages: [en]
|
|
8
|
+
severity: info
|
|
9
|
+
|
|
10
|
+
name:
|
|
11
|
+
ja: 比べられない形容詞に付けた程度
|
|
12
|
+
en: An uncomparable adjective given a degree
|
|
13
|
+
|
|
14
|
+
why:
|
|
15
|
+
ja: 英語の「unique」「unanimous」「impossible」は、そうであるかないかの二つしかない状態を言います。「very unique」「more unanimous」と程度を付けても何も足されず、読み手は書き手が語の意味を確かめていないと受け取ります。語の一覧は言語ごとの語彙表にあります。
|
|
16
|
+
en: '"Unique", "unanimous" and "impossible" name a state that holds or does not. "Very unique" or "more unanimous" adds nothing, and tells the reader the writer did not weigh the word. The phrases are listed in the lexicon.'
|
|
17
|
+
|
|
18
|
+
message:
|
|
19
|
+
ja: 「{matched}」は、程度の無い形容詞に程度を付けています
|
|
20
|
+
en: '"{matched}" grades an adjective that has no degrees'
|
|
21
|
+
|
|
22
|
+
how_to_fix:
|
|
23
|
+
ja: 程度の語を外すか、本当に言いたい程度の言える語に替えてください(very unique → unique、または unusual)。
|
|
24
|
+
en: Drop the grade, or use a word that has degrees ("very unique" → "unique", or "unusual").
|
|
25
|
+
|
|
26
|
+
levels: { strict: 1, normal: 1, relaxed: 2 }
|
|
27
|
+
|
|
28
|
+
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
29
|
+
off_for:
|
|
30
|
+
literature: 'A narrator or a character may say "very unique"; the voice is the author''s choice.'
|
|
31
|
+
|
|
32
|
+
group: wording
|
|
33
|
+
summary:
|
|
34
|
+
ja: 英語で、「very unique」「more unanimous」のように、程度の無い形容詞に付けた程度
|
|
35
|
+
en: A degree given to an adjective that has none, such as "very unique" or "more unanimous"
|
|
36
|
+
example:
|
|
37
|
+
en:
|
|
38
|
+
before: |
|
|
39
|
+
The design is very unique.
|
|
40
|
+
after: |
|
|
41
|
+
The design is unusual.
|
|
42
|
+
|
|
43
|
+
not_flagged:
|
|
44
|
+
ja: 一覧にある組み合わせだけを見ます。「almost」「nearly」のように近さを言う語(almost unique、nearly impossible)は指しません。英語の文書だけで動き、文学のジャンルは対象にしません。
|
|
45
|
+
en: Only the pairs on chaff's list are checked. Words that say how close ("almost unique", "nearly impossible") are not reported. English documents only; literature is not checked.
|
|
46
|
+
level_meaning:
|
|
47
|
+
ja: 当てはまる言い回しが {limit} 箇所あれば指摘
|
|
48
|
+
en: reported once there are {limit}
|
|
49
|
+
sources: [proselint]
|
|
50
|
+
rewrite:
|
|
51
|
+
depth: light
|
|
52
|
+
en:
|
|
53
|
+
direction: Drop the grade before the adjective, or swap the adjective for one that has degrees when a degree is meant. Change nothing else in the sentence.
|
|
54
|
+
pairs:
|
|
55
|
+
- before: The design is very unique.
|
|
56
|
+
after: The design is unusual.
|
|
57
|
+
- before: The vote was more unanimous than last year.
|
|
58
|
+
after: The vote was unanimous this year.
|
|
59
|
+
- before: A fix before Friday is extremely impossible.
|
|
60
|
+
after: A fix before Friday is impossible.
|
|
61
|
+
keep:
|
|
62
|
+
- the claim the sentence makes
|
|
63
|
+
- the rest of the sentence
|
|
64
|
+
avoid:
|
|
65
|
+
- adding a new grade ("truly unique") in place of the old one
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
id: undefined-acronym
|
|
2
2
|
layer: L1
|
|
3
|
-
status:
|
|
3
|
+
status: stable
|
|
4
4
|
how_to_find: undefined-acronym
|
|
5
5
|
word_list: common-acronym
|
|
6
6
|
extra_word_lists:
|
|
@@ -40,7 +40,14 @@ how_to_fix:
|
|
|
40
40
|
|
|
41
41
|
levels: { strict: 1, normal: 3, relaxed: 6 }
|
|
42
42
|
|
|
43
|
+
# 技術文書の読み手は、分野の略語を知っている。既定の数では group の文書の過半に出たので、測って上げた(spec §21.1)。
|
|
44
|
+
by_genre:
|
|
45
|
+
technical: { strict: 3, normal: 5, relaxed: 8 }
|
|
46
|
+
|
|
43
47
|
use_for: [business, technical, legal, docs, academic, literature, speech]
|
|
48
|
+
off_for:
|
|
49
|
+
literature: "Length, rhythm, repetition and register are the author's choices in literature, and dialogue mixes styles. Only what one work can hold itself to runs: consistent spacing and commas, and numbering without gaps."
|
|
50
|
+
speech/transcript: "A transcript records what was said: its sentences, repeats and register are the speaker's, not the writer's to fix."
|
|
44
51
|
sources: [plain-2011, jis-z8301-2019]
|
|
45
52
|
|
|
46
53
|
group: readability
|
package/rules/unit-mismatch.yaml
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
id: unit-mismatch
|
|
2
2
|
layer: L3
|
|
3
|
-
status:
|
|
3
|
+
status: stable
|
|
4
4
|
how_to_find: unit-mismatch
|
|
5
5
|
requires: [quantities]
|
|
6
6
|
uses: [pos]
|
|
@@ -58,6 +58,7 @@ not_flagged:
|
|
|
58
58
|
ja: 単位が同じ量(食い違いは fact-conflict が見ます)、種類の違う量(長さと重さ)、違う見出しや違う親の項目の下の量、2% までの差は見ません。GB や MB は 1000 倍でも 1024 倍でも合えば合うとみなします。
|
|
59
59
|
en: Values in the same unit (fact-conflict looks at those), of different kinds (a length and a mass), under different headings or parent items, and differences within 2% are left alone. GB and MB agree when they match at either 1000 or 1024.
|
|
60
60
|
rewrite:
|
|
61
|
+
depth: light
|
|
61
62
|
ja:
|
|
62
63
|
direction: 二つの量のどちらが正しいかを書き手に確かめ、もう一方を換算して直してください。どちらが正しいか文書から決まらないときは、推測で選ばずに書き手に聞いてください。
|
|
63
64
|
pairs:
|
package/rules/unknown-word.yaml
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
id: unknown-word
|
|
2
2
|
layer: L2
|
|
3
|
-
status:
|
|
3
|
+
status: stable
|
|
4
4
|
how_to_find: unknown-word
|
|
5
5
|
languages: [en]
|
|
6
6
|
severity: info
|
|
@@ -32,6 +32,8 @@ placeholders:
|
|
|
32
32
|
levels: { strict: warning, normal: info, relaxed: info }
|
|
33
33
|
|
|
34
34
|
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
35
|
+
off_for:
|
|
36
|
+
literature: "A narrator may hedge, speak with ら dropped, and spell as the work's time and place did."
|
|
35
37
|
|
|
36
38
|
group: slips
|
|
37
39
|
summary:
|
|
@@ -48,6 +50,7 @@ not_flagged:
|
|
|
48
50
|
ja: 大文字を含む語、四字より短い語、コード・URL・メールアドレスの中の語、文書で二度以上使う語、一字違いの辞書の語が無い語、chaff.yaml の names に並べた語、語彙表 known-misspelling が別に言う語は指しません。
|
|
49
51
|
en: Words with a capital letter, words shorter than four letters, words in code, URLs and email addresses, words used twice or more in the document, words with no dictionary word one letter away, words listed under names in chaff.yaml, and the misspellings known-misspelling reports are not reported.
|
|
50
52
|
rewrite:
|
|
53
|
+
depth: light
|
|
51
54
|
en:
|
|
52
55
|
direction: If the flagged word is a typo, replace it with the suggested dictionary word, or another word the sentence means. If it is a real word or a name, leave it and add it to names in chaff.yaml.
|
|
53
56
|
pairs:
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
id: unqualified-superlative
|
|
2
2
|
layer: L2
|
|
3
|
-
status:
|
|
3
|
+
status: stable
|
|
4
4
|
how_to_find: unqualified-superlative
|
|
5
5
|
word_list: superlative
|
|
6
6
|
extra_word_lists: [comparison-marker, superlative-scope, quantity-noun]
|
|
@@ -26,6 +26,11 @@ how_to_fix:
|
|
|
26
26
|
levels: { strict: 1, normal: 2, relaxed: 4 }
|
|
27
27
|
|
|
28
28
|
use_for: [business, blog, legal, docs, academic, literature, speech]
|
|
29
|
+
off_for:
|
|
30
|
+
legal: "Legal drafting repeats its terms and its sentence heads on purpose, puts the actor in the passive (shall be deemed), and joins long noun compounds (個人情報取扱事業者). This rule would only flag the form."
|
|
31
|
+
docs: "A help page repeats its heading in its first line (To upload a file, ...) and states no claims to back up."
|
|
32
|
+
literature: "Length, rhythm, repetition and register are the author's choices in literature, and dialogue mixes styles. Only what one work can hold itself to runs: consistent spacing and commas, and numbering without gaps."
|
|
33
|
+
speech/transcript: "A transcript records what was said: its sentences, repeats and register are the speaker's, not the writer's to fix."
|
|
29
34
|
sources: [femmer-2017]
|
|
30
35
|
|
|
31
36
|
group: wording
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
id: unrendered-emphasis
|
|
2
|
+
layer: L1
|
|
3
|
+
status: stable
|
|
4
|
+
how_to_find: unrendered-emphasis
|
|
5
|
+
requires: [markdown]
|
|
6
|
+
severity: warning
|
|
7
|
+
|
|
8
|
+
name:
|
|
9
|
+
ja: 太字にならずに見える「**」
|
|
10
|
+
en: Unrendered emphasis marks
|
|
11
|
+
|
|
12
|
+
why:
|
|
13
|
+
ja: 「**」や「__」は、Markdown が対にできたときだけ太字になり、対にできなければそのまま記号として表示されます。閉じ忘れ(「**重要」)のほか、日本語では「**「重要」**です」のように括弧や句読点の内側に記号を置き、外側に字が続くと、CommonMark の決まりで閉じられず、読み手には「**」が見えます。
|
|
14
|
+
en: '"**" and "__" turn into bold only when Markdown can pair them; otherwise they show as written. Besides one left open ("**important"), a mark with punctuation inside and a letter outside (Japanese "**「重要」**です") cannot close under CommonMark''s rules, and the reader sees the "**".'
|
|
15
|
+
|
|
16
|
+
message:
|
|
17
|
+
ja: 「{mark}」が太字にならず、そのまま表示されます
|
|
18
|
+
en: '"{mark}" is not turned into bold and shows as written'
|
|
19
|
+
|
|
20
|
+
how_to_fix:
|
|
21
|
+
ja: 閉じ忘れなら閉じる「**」を足してください。括弧や句読点の内側に置いた記号は、括弧の外に出すか(「**「重要」**」の外側に空白を置く)、括弧ごと太字にしないでください。
|
|
22
|
+
en: If it was left open, add the closing "**". If punctuation sits inside the mark, move the mark outside the punctuation, or put a space outside it.
|
|
23
|
+
|
|
24
|
+
placeholders:
|
|
25
|
+
mark:
|
|
26
|
+
ja: 記号
|
|
27
|
+
en: the mark
|
|
28
|
+
|
|
29
|
+
levels: { strict: error, normal: warning, relaxed: info }
|
|
30
|
+
|
|
31
|
+
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
32
|
+
|
|
33
|
+
group: structure
|
|
34
|
+
summary:
|
|
35
|
+
ja: 対にならず、太字にならないまま記号として見える「**」「__」
|
|
36
|
+
en: '"**" or "__" that Markdown cannot pair and shows as written'
|
|
37
|
+
example:
|
|
38
|
+
ja:
|
|
39
|
+
before: 締め切りは**金曜日です。遅れないようにしてください。
|
|
40
|
+
after: 締め切りは**金曜日**です。遅れないようにしてください。
|
|
41
|
+
en:
|
|
42
|
+
before: The deadline is **Friday. Do not be late.
|
|
43
|
+
after: The deadline is **Friday**. Do not be late.
|
|
44
|
+
|
|
45
|
+
not_flagged:
|
|
46
|
+
ja: 語の中の記号(「2**10」「snake__case」)、前後が空白の記号、三つ以上並んだ記号(区切りや記入欄の「____」)、「__init__」のような名前、コードと引用の中の記号は指しません。
|
|
47
|
+
en: A mark inside a word ("2**10", "snake__case"), a mark with spaces on both sides, runs of three or more (dividers and blanks to fill, "____"), names such as "__init__", and marks in code or quotations are not reported.
|
|
48
|
+
rewrite:
|
|
49
|
+
depth: light
|
|
50
|
+
ja:
|
|
51
|
+
direction: 太字にしたい範囲を「**」で正しく囲んでください。閉じ忘れは閉じる記号を足し、括弧の内側に置いた記号は括弧の外に出します。言葉は変えません。
|
|
52
|
+
pairs:
|
|
53
|
+
- before: 締め切りは**金曜日です。
|
|
54
|
+
after: 締め切りは**金曜日**です。
|
|
55
|
+
- before: これは**「重要」**です。
|
|
56
|
+
after: これは「**重要**」です。
|
|
57
|
+
keep:
|
|
58
|
+
- 文の言葉
|
|
59
|
+
- 太字にしたい範囲
|
|
60
|
+
avoid:
|
|
61
|
+
- 太字をやめて記号だけ消すのか、閉じるのかを、文から読み取らずに決める
|
|
62
|
+
en:
|
|
63
|
+
direction: Wrap the words meant to be bold in a matching pair of "**". Add the missing closing mark, or move a mark outside the punctuation it sits inside. Keep the words.
|
|
64
|
+
pairs:
|
|
65
|
+
- before: The deadline is **Friday.
|
|
66
|
+
after: The deadline is **Friday**.
|
|
67
|
+
- before: Mark the task **done when it ships.
|
|
68
|
+
after: Mark the task **done** when it ships.
|
|
69
|
+
keep:
|
|
70
|
+
- the words
|
|
71
|
+
- the span meant to be bold
|
|
72
|
+
avoid:
|
|
73
|
+
- deciding whether to close or drop the mark without reading the sentence
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
id: unused-definition
|
|
2
2
|
layer: L3
|
|
3
|
-
status:
|
|
3
|
+
status: stable
|
|
4
4
|
how_to_find: unused-definition
|
|
5
5
|
requires: [structure]
|
|
6
|
-
severity:
|
|
6
|
+
severity: info
|
|
7
7
|
|
|
8
8
|
name:
|
|
9
9
|
ja: 定義したのに使っていない語
|
|
@@ -27,7 +27,7 @@ placeholders:
|
|
|
27
27
|
ja: 〇〇
|
|
28
28
|
en: the term
|
|
29
29
|
|
|
30
|
-
levels: { strict:
|
|
30
|
+
levels: { strict: warning, normal: info, relaxed: info }
|
|
31
31
|
|
|
32
32
|
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
33
33
|
|
|
@@ -51,6 +51,7 @@ not_flagged:
|
|
|
51
51
|
ja: 定義の書き方(「X」とは、以下「X」という)で書いた語だけを見ます。複数形と所有の形(Services、Seller's)は使用に数えます。同じ語の二つ目の定義は duplicate-definition が言います。
|
|
52
52
|
en: Only terms defined in a recognised form ("X" means, (the "X")) are checked. Plurals and possessives (Services, Seller's) count as uses. A second definition of the same term is duplicate-definition's to report.
|
|
53
53
|
rewrite:
|
|
54
|
+
depth: light
|
|
54
55
|
ja:
|
|
55
56
|
direction: 本文で使っていない定義を消してください。本文が同じものを別の語で呼んでいるなら、その語を定義した語に替えます。どちらかは書き手に聞きます。
|
|
56
57
|
pairs:
|
package/rules/url-run-on.yaml
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
id: use-before-definition
|
|
2
2
|
layer: L3
|
|
3
|
-
status:
|
|
3
|
+
status: stable
|
|
4
4
|
how_to_find: use-before-definition
|
|
5
5
|
requires: [structure]
|
|
6
|
-
severity:
|
|
6
|
+
severity: info
|
|
7
7
|
|
|
8
8
|
name:
|
|
9
9
|
ja: 定義より前で使っている語
|
|
@@ -29,7 +29,7 @@ placeholders:
|
|
|
29
29
|
ja: 〇
|
|
30
30
|
en: N
|
|
31
31
|
|
|
32
|
-
levels: { strict:
|
|
32
|
+
levels: { strict: warning, normal: info, relaxed: info }
|
|
33
33
|
|
|
34
34
|
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
35
35
|
|
|
@@ -53,6 +53,7 @@ not_flagged:
|
|
|
53
53
|
ja: 定義の条(「X」とは…をいう)で定義した語は、前で使っても言いません。定義の条は文書の頭にも終わりにも置く書き方があるためです。最初の一か所だけを指します。
|
|
54
54
|
en: Terms defined in a definitions clause ("X" means ...) are not checked, since a definitions clause may come first or last. Only the first early use is pointed at.
|
|
55
55
|
rewrite:
|
|
56
|
+
depth: structure
|
|
56
57
|
ja:
|
|
57
58
|
direction: 定義を、その語を最初に使う文へ移してください。移せないなら、前の文を定義した語を使わない書き方にします。
|
|
58
59
|
pairs:
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
id: vague-figure-reference
|
|
2
2
|
layer: L2
|
|
3
|
-
status:
|
|
3
|
+
status: stable
|
|
4
4
|
how_to_find: vague-figure-pointer
|
|
5
5
|
# 置き場所で指す言い方と、その言い方が指す種類(図・表)。図・表に名前を付ける語は dangling-figure-reference と同じ figure-label。
|
|
6
6
|
# 箇条を置き場所で指す言い方は vague-clause-pointer。文書の構造の木に番号付きの条か章があるときだけ見る。
|
|
@@ -35,6 +35,8 @@ placeholders:
|
|
|
35
35
|
levels: { strict: error, normal: warning, relaxed: info }
|
|
36
36
|
|
|
37
37
|
use_for: [business, technical, blog, legal, docs, academic, literature, speech]
|
|
38
|
+
off_for:
|
|
39
|
+
literature: "Length, rhythm, repetition and register are the author's choices in literature, and dialogue mixes styles. Only what one work can hold itself to runs: consistent spacing and commas, and numbering without gaps."
|
|
38
40
|
sources: [jis-z8301-2019]
|
|
39
41
|
|
|
40
42
|
group: structure
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
id: vague-link-text
|
|
2
2
|
layer: L1
|
|
3
|
-
status:
|
|
3
|
+
status: stable
|
|
4
4
|
how_to_find: vague-link-text
|
|
5
5
|
word_list: vague-link-text
|
|
6
6
|
requires: [markdown]
|
|
@@ -51,6 +51,7 @@ not_flagged:
|
|
|
51
51
|
ja: 言葉の一部に「こちら」を含むだけのリンク(「料金表はこちら」)、URL をそのまま書いたリンク、参照の形のリンク([こちら][1])は指しません。Markdown でない文書と、引用(>)とコードの中のリンクも見ません。
|
|
52
52
|
en: Link text that only contains such a word ("pricing here"), a bare or angle-bracket URL, and reference-style links ([here][1]) are not reported, nor are links in a quotation (>), in code, or in a document that is not Markdown.
|
|
53
53
|
rewrite:
|
|
54
|
+
depth: light
|
|
54
55
|
ja:
|
|
55
56
|
direction: リンクの言葉を、行き先の名前(ページの題、資料の名前)に変えてください。「こちら」「ここ」は文から外し、文は行き先の名前を言う形に組み直します。行き先の URL は変えません。
|
|
56
57
|
pairs:
|