mirror of
https://github.com/denoland/deno.git
synced 2025-02-20 20:33:42 -05:00
f08ca6414b
This commit adds an unstable lint plugin API.
Plugins are specified in the `deno.json` file under
`lint.plugins` option like so:
```
{
"lint": {
"plugins": [
"./plugins/my-plugin.ts",
"jsr:@deno/lint-plugin1",
"npm:@deno/lint-plugin2"
]
}
}
```
The API is considered unstable and might be subject
to changes in the future.
Plugin API was modelled after ESLint API for the
most part, but there are no guarantees for compatibility.
The AST format exposed to plugins is closely modelled
after the AST that `typescript-eslint` uses.
Lint plugins use the visitor pattern and can add
diagnostics like so:
```
export default {
name: "lint-plugin",
rules: {
"plugin-rule": {
create(context) {
return {
Identifier(node) {
if (node.name === "a") {
context.report({
node,
message: "should be b",
fix(fixer) {
return fixer.replaceText(node, "_b");
},
});
}
},
};
},
},
},
} satisfies Deno.lint.Plugin;
```
Besides reporting errors (diagnostics) plugins can provide
automatic fixes that use text replacement to apply changes.
---------
Co-authored-by: Marvin Hagemeister <marvin@deno.com>
Co-authored-by: David Sherret <dsherret@gmail.com>
|
||
|---|---|---|
| .. | ||
| all | ||
| bom | ||
| compact | ||
| default_ts | ||
| gitignore | ||
| glob | ||
| ignore | ||
| ignore_unexplicit_files | ||
| json | ||
| jsr_pkg_no_version | ||
| jsr_tag | ||
| jsx | ||
| lint_fix | ||
| lint_plugin | ||
| lint_plugin_fix_error | ||
| lint_plugin_infinite_edits | ||
| lint_plugin_utf16 | ||
| no_slow_types | ||
| no_slow_types_workspace | ||
| node_globals_no_duplicate_imports | ||
| opt_out_top_level_exclude_via_lint_inexclude | ||
| quiet | ||
| rules | ||
| rules_quiet | ||
| sloppy_imports_dts | ||
| sloppy_imports_no_incremental_cache | ||
| stdin | ||
| stdin_json | ||
| syntax_error_reporting | ||
| with_config | ||
| with_config_and_flags | ||
| with_config_without_args | ||
| with_glob_config | ||
| with_glob_config_and_flags | ||
| with_malformed_config | ||
| with_malformed_config2 | ||
| with_report_config | ||
| with_report_config_override | ||
| workspace | ||
| workspace_no_slow_types | ||