Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antfu/eslint-merge-processors
Merge multiple ESLint processors to behave like one
https://github.com/antfu/eslint-merge-processors
Last synced: 29 days ago
JSON representation
Merge multiple ESLint processors to behave like one
- Host: GitHub
- URL: https://github.com/antfu/eslint-merge-processors
- Owner: antfu
- License: mit
- Created: 2023-12-07T16:32:01.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2023-12-07T17:13:55.000Z (11 months ago)
- Last Synced: 2024-10-04T22:12:38.431Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 54.7 KB
- Stars: 16
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# eslint-merge-processors
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![bundle][bundle-src]][bundle-href]
[![JSDocs][jsdocs-src]][jsdocs-href]
[![License][license-src]][license-href]
Merge multiple ESLint processors to behave like one
## Install
```bash
npm i eslint-merge-processors
```
```js
import { mergeProcessors } from 'eslint-merge-processors'
const processor = mergeProcessors([
processorA,
processorB,
// ...
])
```
## Examples
### Markdown
Lint `.md` files with `eslint-plugin-markdown`.
By default, `eslint-plugin-markdown`'s processor will create a virtual file for each code snippet in the markdown file, **but not the original `.md` file itself**. This means the original `.md` file will not be linted.
With this package, along with the `processorPassThrough` processor, you can now fix that:
```ts
import {
mergeProcessors,
processorPassThrough
} from 'eslint-merge-processors'
import markdown from 'eslint-plugin-markdown'
// ESlint Flat config
export default [
{
files: ['**/*.md'],
plugins: {
markdown
},
processor: mergeProcessors([
// This allow the original `.md` file to be linted
processorPassThrough,
// The markdown processor
markdown.processors.markdown,
// other processors if needed
])
}
]
```
## Sponsors
## License
[MIT](./LICENSE) License © 2023-PRESENT [Anthony Fu](https://github.com/antfu)
[npm-version-src]: https://img.shields.io/npm/v/eslint-merge-processors?style=flat&colorA=080f12&colorB=1fa669
[npm-version-href]: https://npmjs.com/package/eslint-merge-processors
[npm-downloads-src]: https://img.shields.io/npm/dm/eslint-merge-processors?style=flat&colorA=080f12&colorB=1fa669
[npm-downloads-href]: https://npmjs.com/package/eslint-merge-processors
[bundle-src]: https://img.shields.io/bundlephobia/minzip/eslint-merge-processors?style=flat&colorA=080f12&colorB=1fa669&label=minzip
[bundle-href]: https://bundlephobia.com/result?p=eslint-merge-processors
[license-src]: https://img.shields.io/github/license/antfu/eslint-merge-processors.svg?style=flat&colorA=080f12&colorB=1fa669
[license-href]: https://github.com/antfu/eslint-merge-processors/blob/main/LICENSE
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
[jsdocs-href]: https://www.jsdocs.io/package/eslint-merge-processors