https://github.com/textlint/textlint-rule-report-node-types
textlint rule that report error by node's type for debugging.
https://github.com/textlint/textlint-rule-report-node-types
Last synced: 9 months ago
JSON representation
textlint rule that report error by node's type for debugging.
- Host: GitHub
- URL: https://github.com/textlint/textlint-rule-report-node-types
- Owner: textlint
- License: mit
- Created: 2016-05-02T10:07:35.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-05-07T07:46:46.000Z (about 9 years ago)
- Last Synced: 2025-05-05T23:49:17.155Z (about 1 year ago)
- Language: JavaScript
- Size: 5.86 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# textlint-rule-report-node-types [](https://travis-ci.org/textlint/textlint-rule-report-node-types)
textlint rule that report error by node's type for **debugging**.
Opposite <-> [textlint-rule-ignore-node-types](https://github.com/textlint/textlint-rule-ignore-node-types "textlint-rule-ignore-node-types").
## Installation
npm install textlint-rule-report-node-types
## Usage
If you want to report `BlockQuote` node, define `"BlockQuote"` to `"nodeTypes"`.
`.textlintrc`
```json
{
"rules": {
"report-node-types": {
"nodeTypes": ["BlockQuote"]
}
}
}
```
OR
`.textlintrc` as JavaScript config file.
```js
const TextLintNodeType = require("textlint").TextLintNodeType;
module.exports = {
"rules": {
"report-node-types": {
"nodeTypes": [TextLintNodeType.BlockQuote]
}
}
}
```
If you want to know all types of TxtNode, please see the document.
- [github.com/textlint/textlint/blob/master/docs/txtnode.md#type](https://github.com/textlint/textlint/blob/master/docs/txtnode.md#type)
## Tests
npm test
## Contributing
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
## License
MIT