Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antfu/eslint-ts-patch
Support loading eslint.config.mjs and eslint.config.ts as flat config files for ESLint.
https://github.com/antfu/eslint-ts-patch
eslint eslint-flat-config
Last synced: 20 days ago
JSON representation
Support loading eslint.config.mjs and eslint.config.ts as flat config files for ESLint.
- Host: GitHub
- URL: https://github.com/antfu/eslint-ts-patch
- Owner: antfu
- License: mit
- Created: 2023-12-09T22:31:09.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-08-09T03:24:55.000Z (3 months ago)
- Last Synced: 2024-10-10T19:01:40.417Z (26 days ago)
- Topics: eslint, eslint-flat-config
- Language: JavaScript
- Homepage:
- Size: 445 KB
- Stars: 155
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# eslint-ts-patch
[![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]
Support loading `eslint.config.mjs` or `eslint.config.ts` as flat config file for ESLint.
Configure files will be searched in the following order, the first one found will be used:
- `eslint.config.js`
- `eslint.config.mjs`
- `eslint.config.cjs`
- `eslint.config.ts`
- `eslint.config.mts`
- `eslint.config.cts`
For `.js`, `.cjs`, and `.mjs` files, they will be loaded by Node's native `import()`.
For `.ts`, `.cts`, and `.mts` files, they will be loaded using [TypeScript loaders](#typescript-loaders).
Context:
- [~~Unfortunately ESLint team decided to not support the detection of `.cjs` and `.mjs` as flat config~~](https://github.com/eslint/eslint/issues/16580#issuecomment-1419027861).
- Update: [ESLint v8.57.0 added support for `eslint.config.mjs` and `eslint.config.cjs`](https://eslint.org/blog/2024/02/eslint-v8.57.0-released).
- Native ESLint support for `eslint.config.ts` has been merged (not released yet): [PR](https://github.com/eslint/eslint/pull/18134), [Original RFC](https://github.com/eslint/rfcs/pull/117#discussion_r1593410239) - This package will soon be redundant when it's landed.
## Install
```npm
npm i -D eslint-ts-patch eslint@npm:eslint-ts-patch
```
It should make your `eslint` CLI work for those config files automatically. If it's still not, you can try switching the CLI to `eslint-ts`.
## TypeScript Loaders
There are multiple solutions to load TypeScript files in Node.js at runtime, and each of them consists of different trade-offs. This patch supports the following loaders powered by [`importx`](https://github.com/antfu/importx):
- `default`: [Auto-detect the loader based on the user's environment](https://github.com/antfu/importx#auto).
- [`tsx`](https://github.com/privatenumber/tsx) - Use Node's native ESM loader to load TypeScript files.
- **Pros**: Use Node's native ESM loader, running in ESM. Should have the most correct behavior.
- **Cons**: It requires [Node.js v18.19.0+ or v20.8.0](https://nodejs.org/api/module.html#moduleregisterspecifier-parenturl-options). Refer to the [Compatibility](#compatibility) section.
- [`jiti`](https://github.com/unjs/jiti)- Transpile TypeScript files and ESM to CJS and execute them at runtime.
- **Pros**: Easy to use. No need to install additional dependencies.
- **Cons**: Everything is in CJS mode. It does not support top-level-await. It may have inconsistent behavior during ESM/CJS interop.
- [`bundle-require`](https://github.com/egoist/bundle-require) - Use `esbuild` to bundle the `eslint.config.ts` file, and import the temporary bundle.
- **Pros**: Not hacking into Node's internals. ESM and top-level-await are supported.
- **Cons**: It writes a temporary file to disk.
Learn more about the loaders in the [`importx` documentation](https://github.com/antfu/importx).
To try out different loaders, you can set the `ESLINT_TS_PATCH_LOADER` environment variable to one of the following values:
```sh
ESLINT_TS_PATCH_LOADER=tsx npx eslint
ESLINT_TS_PATCH_LOADER=bundle-require npx eslint
```
Or you can use magic comments `@eslint-ts-patch-loader` in your `eslint.config.ts` file:
```ts
// @eslint-ts-patch-loader tsx
```
## Compatibility
Tested with the following tools:
### Package Managers
- `npm` ✅
- `pnpm` ✅
- `yarn` ✅
### Integrations
- `eslint` CLI ✅
- VSCode ESLint extension ⚠️ (as it's executing your local `node_modules/.bin/eslint`)
As for [VS Code v1.89](https://code.visualstudio.com/updates/v1_89) (April 2024) the bundled Node is v18.18.2, which is not compatible with `tsx` loader (requires v18.19.0+) - Which should be [fixed with next month's VS Code release](https://github.com/microsoft/vscode/commit/5216c044283ba1f3c66caa092fd75ba0b3e3e5ca#diff-a4764aae9fcfee2bd5f25de9fd217e38b6278b95f2848508250a895fd631aa0e). In order for VS Code ESLint works now, you need to update your settings.json with the following config to use your global Node.js:
```json
{
"eslint.runtime": "node"
}
```
## Versioning
This package proxies all ESLint exports, it should be compatible by aliasing the `eslint` package. The version of this package is the same as the latest supported ESLint version in addition to a patch number suffix indicating the patches of this package (e.g. `8.55.0-1`). It's using `^` relaxed dependency of `eslint`, so it should work with any newer versions of ESLint.
## How it works
As the support of `eslint.config.js` seems to be quite hard-coded in ESLint, this package proxies all exports of ESLint and installs [this register](./lib/register.js) beforehand. The register will swap some internal code of ESLint at runtime to make it work.
## Disclaimer
It's only recommended to install this as top-level development dependency (user-aware). For plugin and library authors, it's ok to document the usage of this package for better DX. But we suggest avoiding having this as the dependency of your library or plugin, otherwise, take your own risk.
## Troubleshooting
### Is the Patch Working
This patch is designed to be as transparent as possible. If you want to verify if it's working, you can add `DEBUG="eslint-ts-patch"` environment variable to your command to see the debug logs.
```
➜ DEBUG="eslint-ts-patch" npx eslint -v
eslint-ts-patch initialized +0ms
eslint-ts-patch patched lib/eslint/flat-eslint.js +59ms
v8.55.0
```
## Sponsors
## License
[MIT](./LICENSE) License © 2023-PRESENT [Anthony Fu](https://github.com/antfu)
[npm-version-src]: https://img.shields.io/npm/v/eslint-ts-patch?style=flat&colorA=080f12&colorB=1fa669
[npm-version-href]: https://npmjs.com/package/eslint-ts-patch
[npm-downloads-src]: https://img.shields.io/npm/dm/eslint-ts-patch?style=flat&colorA=080f12&colorB=1fa669
[npm-downloads-href]: https://npmjs.com/package/eslint-ts-patch
[bundle-src]: https://img.shields.io/bundlephobia/minzip/eslint-ts-patch?style=flat&colorA=080f12&colorB=1fa669&label=minzip
[bundle-href]: https://bundlephobia.com/result?p=eslint-ts-patch
[license-src]: https://img.shields.io/github/license/antfu/eslint-ts-patch.svg?style=flat&colorA=080f12&colorB=1fa669
[license-href]: https://github.com/antfu/eslint-ts-patch/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-ts-patch