@textlint-rule/textlint-rule-proselint

Proselint wrapper for textlint.

Usage no npm install needed!

<script type="module">
  import textlintRuleTextlintRuleProselint from 'https://cdn.skypack.dev/@textlint-rule/textlint-rule-proselint';
</script>

README

textlint-rule-proselint Build Status

Proselint wrapper for textlint.

Install

Install with npm and pip:

npm install @textlint-rule/textlint-rule-proselint
pip install proselint

Requirement:

This rule depended on proselint. You should install proselint.

pip install proselint

Usage

Via .textlintrc(Recommended)

{
    "rules": {
        "@textlint-rule/proselint": true
    }
}

Via CLI

textlint --rule @textlint-rule/proselint README.md

Exception

This rule ignore errors on following nodes.

  • CodeBlock
  • Code
  • Link
  • Strong
  • Emphasis
  • BlockQuote
  • Comment

For example, Following text is ok

Find `...` in a string.

Limitation

proselint can not run parallel. This rule limit concurrency.

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

Related