textlint-rule-first-sentence-length

    1.0.1 • Public • Published

    textlint-rule-first-sentence-length

    textlint rule that limit maximum length of First sentence of the section.

    Related: textlint-rule-sentence-length

    OK:

    Title
     
    Short description.
     
    text text text.

    NG:

    Title
     
    Long Long Long Long description. <= Lint Error
     
    text text.
     
    ## Section 2
     
    Long Long Long Long description. <= Lint Error

    Install

    Install with npm:

    npm install textlint-rule-first-sentence-length
    

    Usage

    Via .textlintrc(Recommended)

    {
        "rules": {
            "first-sentence-length": true
        }
    }

    Via CLI

    textlint --rule first-sentence-length README.md
    

    Options

    • max
      • default: 50
      • The total number of characters allowed on first paragraph of the sentence.
      • Fist sentence.length should be <= 50.
    {
        "rules": {
            "sentence-length": {
                "max": 50
            }
        }
    }
    

    Related rule

    Reference

    書き出しの文は30字以下

    書き出しの長さは、文全体が一目で見られる目安として「30字」と定めました。興味を引き、一気に読んでもらえるかは、書き出し文の印象にかかっています。

    Changelog

    See Releases page.

    Running tests

    Install devDependencies and Run npm test:

    npm i -d && npm test
    

    Contributing

    Pull requests and stars are always welcome.

    For bugs and feature requests, please create an issue.

    1. Fork it!
    2. Create your feature branch: git checkout -b my-new-feature
    3. Commit your changes: git commit -am 'Add some feature'
    4. Push to the branch: git push origin my-new-feature
    5. Submit a pull request :D

    Author

    License

    MIT © azu

    Keywords

    Install

    npm i textlint-rule-first-sentence-length

    DownloadsWeekly Downloads

    8

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • azu