Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/textlint-rule/textlint-rule-eslint
textlint rule integrate with ESLint.
https://github.com/textlint-rule/textlint-rule-eslint
eslint markdown textlint textlintrule
Last synced: 4 days ago
JSON representation
textlint rule integrate with ESLint.
- Host: GitHub
- URL: https://github.com/textlint-rule/textlint-rule-eslint
- Owner: textlint-rule
- License: mit
- Created: 2016-07-03T15:07:41.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-25T22:00:49.000Z (8 months ago)
- Last Synced: 2024-05-02T00:21:54.525Z (8 months ago)
- Topics: eslint, markdown, textlint, textlintrule
- Language: TypeScript
- Size: 967 KB
- Stars: 14
- Watchers: 3
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# textlint-rule-eslint [](https://github.com/textlint-rule/textlint-rule-eslint/actions?query=workflow%3A"test")
[textlint](https://textlint.github.io/ "textlint official site") rule to lint JavaScript in Markdown with ESLint.
> [!WARNING]
> Now you can Lint CodeBlock code in ESLint by using [@eslint/markdown](https://github.com/eslint/markdown).
> Therefore, this rule is maintenance mode
## Use case
ESLint can lint Markdown files using [eslint-plugin-markdown](https://github.com/eslint/eslint-plugin-markdown "eslint/eslint-plugin-markdown"). But eslint-plugin-markdown doesn't support disabling Markdown (HTML) comments for ignoring some CodeBlocks.
[textlint](https://textlint.github.io/ "textlint official site") can filter some CodeBlocks using [textlint-filter-rule-comments](https://github.com/textlint/textlint-filter-rule-comments "textlint-filter-rule-comments"):
```js
var ignore = "This is ignored"
```
Sometimes, we want to write broken JavaScript code into a JS CodeBlock for syntax highlight:
This is error example of parsing:
```js
// This is invalid example
const const;
```
To ignore ESLint parsing errors that cannot be ignored from the config file, you can use `ignoreParsingErrors`:
```json5
{
"rules": {
"eslint": {
"configFile": "path/to/.eslintrc",
"ignoreParsingErrors": true
}
}
}
```
## Installation
Install with [npm](https://www.npmjs.com/):
npm install textlint-rule-eslint eslint
Support Versions:
- `textlint-rule-eslint@5`: Support ESLint 9
- `textlint-rule-eslint@4`: Support ESLint 8
## Usage
Via `.textlintrc` (recommended):
```json5
{
"rules": {
"eslint": {
// Required: path to eslint.config file
"configFile": "./path/to/eslint.config.mjs"
}
}
}
```
Via CLI:
```
textlint --rule eslint README.md
```
## Options
- `configFile`: string
- **Required**
- path to .eslintrc file
- `langs`: `string[]`
- Default: `["js", "javascript", "node", "jsx"]`
- recognize lang of CodeBlock
- `ignoreParsingErrors`: `Boolean`
- Default: `false`
- ignore ESLint parsing errors while still reporting other ESLint errors
```json5
{
"rules": {
"eslint": {
// Required: path to eslint.config file
"configFile": "./path/to/eslint.config.mjs",
// recognize lang of CodeBlock as JavaScript
"langs": ["js", "javascript", "node", "jsx"],
// Ignore ESLint parsing errors
"ignoreParsingErrors": true
}
}
}
```
## Fixable
`textlint-rule-eslint support` `--fix` option.
[](https://textlint.github.io/)
See [https://github.com/textlint/textlint/#fixable](https://github.com/textlint/textlint/#fixable) for more details.
## Changelog
See [Releases page](https://github.com/textlint-rule/textlint-rule-eslint/releases).
## Running tests
Install devDependencies and Run `npm test`:
npm ci && npm test
## Contributing
Pull requests and stars are always welcome.
For bugs and feature requests, [please create an issue](https://github.com/textlint-rule/textlint-rule-eslint/issues).
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
- [github/azu](https://github.com/azu)
- [twitter/azu_re](https://twitter.com/azu_re)
## License
MIT © azu