textlint rule that found mismatch between date and weekday.
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
test
.gitignore
.travis.yml
LICENSE
README.md
package.json

README.md

textlint-rule-date-weekday-mismatch Build Status textlint rule

textlint rule that found mismatch between date and weekday.

OK:

Correct date and weekday.

2016-12-29(Thursday)
2016年12月30日(木曜日)

NG:

Incorrect date and weekday.

2016-12-29(Friday)

// Error:
2016-12-29(Friday) mismatch weekday.
2016-12-29(Friday) => 2016-12-29(Thursday)

Supported lang

Automatically detect language from your text!

  • en
  • ja(日本語)
  • es
  • fr
  • zh

This rule depended on following library:

Install

Install with npm:

npm install textlint-rule-date-weekday-mismatch

Usage

Via .textlintrc(Recommended)

{
    "rules": {
        "date-weekday-mismatch": true
    }
}

Via CLI

textlint --rule date-weekday-mismatch README.md

Options

  • lang: string
    • Default: none(Automatically detect language)
    • Specify language for date string
{
    "rules": {
        "date-weekday-mismatch": {
            "lang": "ja"
        }
    }
}

For example, 2016-12-30 is en by default. But, You can specify 2016-12-30 is ja-JP text by options

{
    "rules": {
        "date-weekday-mismatch": {
            "lang": "ja-JP"
        }
    }
}

language format following ISO 639-1.

e.g.) en-US, en, ja etc..

Acknowledge

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