Have ideas to improve npm?Join in the discussion! »

    remark-lint-no-file-name-articles

    1.0.5 • Public • Published

    remark-lint-no-file-name-articles

    Build Coverage Downloads Size Sponsors Backers Chat

    Warn when file names start with an article.

    Presets

    This rule is included in the following presets:

    Preset Setting
    remark-preset-lint-markdown-style-guide

    Example

    title.md
    Out

    No messages.

    a-title.md
    Out
    1:1: Do not start file names with `a`
    the-title.md
    Out
    1:1: Do not start file names with `the`
    teh-title.md
    Out
    1:1: Do not start file names with `teh`
    an-article.md
    Out
    1:1: Do not start file names with `an`

    Install

    npm:

    npm install remark-lint-no-file-name-articles

    Use

    You probably want to use it on the CLI through a config file:

     …
     "remarkConfig": {
       "plugins": [
         …
         "lint",
    +    "lint-no-file-name-articles",
         …
       ]
     }
     …

    Or use it on the CLI directly

    remark -u lint -u lint-no-file-name-articles readme.md

    Or use this on the API:

     var remark = require('remark')
     var report = require('vfile-reporter')
     
     remark()
       .use(require('remark-lint'))
    +  .use(require('remark-lint-no-file-name-articles'))
       .process('_Emphasis_ and **importance**', function (err, file) {
         console.error(report(err || file))
       })

    Contribute

    See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

    This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

    License

    MIT © Titus Wormer

    Install

    npm i remark-lint-no-file-name-articles

    DownloadsWeekly Downloads

    26,000

    Version

    1.0.5

    License

    MIT

    Unpacked Size

    5.35 kB

    Total Files

    3

    Last publish

    Collaborators

    • avatar
    • avatar