@cffnpwr/textlint-rule-no-arbitrary-line-break

A textlint rule that detects line breaks within a paragraph anywhere other than immediately after an allowed symbol.

日本語のREADMEはこちら

When wrapping text to comply with line-length limits such as markdownlint's MD013, this rule enforces breaking lines immediately after a delimiter such as a comma or period, rather than at an arbitrary position. A line break at a position unrelated to a delimiter makes the sentence harder to follow.

<!-- NG -->
この機能は長い説明が必要にな
るので途中で改行しています。

<!-- OK -->
この機能は長い説明が必要になるので、
読点の直後で改行しています。

Both source-level wrapping (softbreak) and hard breaks (two trailing spaces or \) are inspected. When judging a hard break, trailing whitespace and \ are ignored, and the character immediately preceding them is used to determine whether the break is allowed. Line breaks inside and immediately after inline elements (links, emphasis, inline code, images, HTML elements) are not targeted. Wrapping immediately after [リンク](url) or <br> is not reported. Content under a quote (BlockQuote) is also excluded by default.

Whereas @cffnpwr/textlint-rule-sentence-per-line enforces "always break at the end of a sentence", this rule restricts "the positions where a line break is allowed within a sentence". Enabling both establishes the discipline that "a line break is allowed only at the end of a sentence or immediately after a delimiter symbol".

This rule supports autofix via textlint --fix. The fix removes the line break together with the surrounding whitespace (and a trailing \ for a hard break), joining the two lines into one. A single half-width space is kept only when the character immediately before and the character immediately after the removed range are both non-Japanese (for example, between two English words); otherwise the lines are joined directly with no space.

How to Install

npm

npm install --save-dev @cffnpwr/textlint-rule-no-arbitrary-line-break

or

npx jsr add -D @cffnpwr/textlint-rule-no-arbitrary-line-break

yarn

yarn add --dev @cffnpwr/textlint-rule-no-arbitrary-line-break

or

yarn dlx jsr add -D @cffnpwr/textlint-rule-no-arbitrary-line-break

pnpm

pnpm add --save-dev @cffnpwr/textlint-rule-no-arbitrary-line-break

or

pnpm dlx jsr add -D @cffnpwr/textlint-rule-no-arbitrary-line-break

Bun

bun add --dev @cffnpwr/textlint-rule-no-arbitrary-line-break

or

bunx jsr add -D @cffnpwr/textlint-rule-no-arbitrary-line-break

Deno

deno add --dev npm:@cffnpwr/textlint-rule-no-arbitrary-line-break

or

deno add --dev jsr:@cffnpwr/textlint-rule-no-arbitrary-line-break

How to Use

Add it to .textlintrc.json.

{
  "rules": {
    "@cffnpwr/textlint-rule-no-arbitrary-line-break": true
  }
}

Options

interface Options {
  allowAfter?: string[];
  skipBlockQuote?: boolean;
}

| Option | Default | Description | | --- | --- | --- | | allowAfter | ["、", "。", "！", "？", "」", "』", "）", "］", "】", ",", ".", "!", "?", ")", "]"] | List of characters after which a line break is allowed. Each element is a single character consisting of one UTF-16 code unit (characters outside the BMP, such as emoji, cannot be specified). When specified, it overrides the default | | skipBlockQuote | true | Excludes content under quotes (BlockQuote) from inspection |

Specifying an unknown option key or an invalid value (including an element of two or more characters in allowAfter) results in an error. Specifying an empty array for allowAfter causes every line break within a paragraph to be reported.

{
  "rules": {
    "@cffnpwr/textlint-rule-no-arbitrary-line-break": {
      "allowAfter": ["、", "。"]
    }
  }
}

License

MIT