dan/oxc

mirror of https://github.com/danbulant/oxc synced 2026-05-24 20:32:10 +00:00

History

Alexander S. f0a8d8aab7 refactor(tasks/lint_rules): detect typescript alias from mod.rs file (#7891 ) based on #7890 tried graphite, but I do not have write access to this repo. Do not know how to create Branches on a Fork and the PRs on the Forked Project. --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>		2024-12-15 00:14:15 +08:00
..
src	refactor(tasks/lint_rules): detect typescript alias from mod.rs file (#7891 )	2024-12-15 00:14:15 +08:00
.gitignore
jsconfig.json
package.json	chore(tasks/lint_rules): sync rules with ESLint v9 (#6777 )	2024-10-22 20:14:10 +08:00
README.md

README.md

tasks/lint_rules

Task to update implementation progress for each linter plugin.

Usage:
  $ cmd [--target=<pluginName>]... [--update] [--help]

Options:
  --target, -t: Which plugin to target, multiple allowed
  --update: Update the issue instead of printing to stdout
  --help, -h: Print this help message

Environment variables GITHUB_TOKEN is required when --update is specified.

Design

Always install eslint-plugin-XXX@latest from npm
Load them through ESLint Node.js API
- https://eslint.org/docs/latest/integrate/nodejs-api#linter
List all their plugin rules(name, deprecated, recommended, docs, etc...)
List all our implemented rules(name)
Combine these lists and render as markdown
Update GitHub issue body

FAQ

Why is this task written in Node.js? Why not Rust?
- Some plugins do not provide static rules list
  - https://github.com/jest-community/eslint-plugin-jest/
- Easiest way to collect the list is just evaluating config file in JavaScript
Why .cjs?
- To keep dependencies as simple as possible
- Some plugins only provide their module as CommonJS
- So, CommonJS is the only way to go without bundling