Code Monkey home page Code Monkey logo

textlint-rule-proselint's Introduction

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

textlint-rule-proselint's People

Contributors

azu avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.