eslint-plugin-dprint
eslint-plugin-dprint copied to clipboard
An ESLint plugin that fixes code with dprint
eslint-plugin-dprint
The plugin that runs dprint to format code in ESLint.
💿 Installation
Use npm or a compatible tool.
$ npm install -D eslint eslint-plugin-dprint
-
eslint-plugin-dprint
contains typescript-0.32.4.wasm because that will be not likely published to npm repository.
📖 Usage
Write your ESLint configuration. For example:
module.exports = {
extends: ["eslint:recommended", "plugin:dprint/recommended"],
rules: {
"dprint/dprint": [
"error",
{
config: {
// The TypeScript configuration of dprint
// See also https://dprint.dev/plugins/typescript/config/
},
},
],
},
};
Then run ESLint with --fix
!
Available Rules
Rule | Description |
---|---|
dprint/dprint | Format code with dprint. |
Available Configs
Config | Description |
---|---|
plugin:dprint/disable-conflict-rules | Disable rules where are conflicted with the dprint/dprint rule. |
plugin:dprint/recommended | Enable the dprint/dprint rule along with the plugin:dprint/disable-conflict-rules preset. |
- Put the plugin:dprint/recommended or plugin:dprint/disable-conflict-rules config into the last of your
extends
list in order to ensure disabling conflict rules where came from other base configurations.
📰 Changelog
See GitHub Releases.
❤️ Contributing
Welcome contributing!
Please use GitHub's Issues/PRs.
Development Tools
-
npm test
... Run tests. It generates code coverage intocoverage
directory. -
npm run watch
... Run tests when files are edited. -
npm version <patch|minor|major>
... Bump a new version.