@textlint/textlint-plugin-text

plain text plugin for textlint

Usage no npm install needed!

<script type="module">
  import textlintTextlintPluginText from 'https://cdn.skypack.dev/@textlint/textlint-plugin-text';
</script>

README

@textlint/textlint-plugin-text

Plain text plugin for textlint.

Install

Install with npm:

npm install @textlint/textlint-plugin-text

Usage

This plugin is built-in in textlint. No need configuration.

Following config is set by default.

{
    "plugins": {
        "@textlint/text": true
    }
}

Options

  • extensions: string[]
    • Additional file extensions for plain text

For example, if you want to treat .custom-ext as text, put following config to .textlintrc

{
    "plugins": {
        "@textlint/text": {
            "extensions": [".custom-ext"]
        }
    }
}

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