0.12.0 • Published 7 days ago
@ben_12/eslint-plugin-dprint v0.12.0
eslint-plugin-dprint
This is an updated fork of mysticatea/eslint-plugin-dprint. Some things are still being adjusted.
The plugin that runs dprint to format code in ESLint.
💿 Installation
Use npm or a compatible tool.
$ npm install -D eslint @ben_12/eslint-plugin-dprint
Then install dprint plugin for the language to format.
$ npm install -D @dprint/dockerfile
$ npm install -D @dprint/json
$ npm install -D @dprint/markdown
$ npm install -D @dprint/toml
$ npm install -D @dprint/typescript
📖 Usage
Write your ESLint configuration. For example with typescript code:
module.exports = {
extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:@ben_12/dprint/typescript-recommended"],
rules: {
"@ben_12/dprint/typescript": [
"error",
{
// Use dprint JSON configuration file (default: "dprint.json")
// It may be created using `dprint init` command
// See also https://dprint.dev/config/
configFile: "dprint.json",
config: {
// The TypeScript configuration of dprint
// See also https://dprint.dev/plugins/typescript/config/
},
},
],
},
};
Then run ESLint with --fix
!
Available Rules
Rule | Description |
---|---|
@ben_12/dprint/dockerfile | Format dockerfile code with @dprint/dockerfile. |
@ben_12/dprint/json | Format json code with @dprint/json. |
@ben_12/dprint/markdown | Format markdown code with @dprint/markdown. |
@ben_12/dprint/toml | Format toml code with @dprint/toml. |
@ben_12/dprint/typescript | Format typescript code with @dprint/typescript. |
Available Configs
Config | Description |
---|---|
plugin:@ben_12/dprint/disable-typescript-conflict-rules | Disable rules where are conflicted with the @ben_12/dprint/typescript rule. |
plugin:@ben_12/dprint/dockerfile-recommended | Enable the @ben_12/dprint/dockerfile rule. |
plugin:@ben_12/dprint/json-recommended | Enable the @ben_12/dprint/json rule. |
plugin:@ben_12/dprint/markdown-recommended | Enable the @ben_12/dprint/markdown rule. |
plugin:@ben_12/dprint/toml-recommended | Enable the @ben_12/dprint/toml rule. |
plugin:@ben_12/dprint/typescript-recommended | Enable the @ben_12/dprint/typescript rule along with the plugin:@ben_12/dprint/disable-typescript-conflict-rules preset. |
- Put the plugin:@ben_12/dprint/recommended or plugin:@ben_12/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.
0.12.0
7 days ago
0.11.3
14 days ago
0.11.2
21 days ago
0.11.1
28 days ago
0.11.0
1 month ago
0.10.2
3 months ago
0.10.1
3 months ago
0.10.0
3 months ago
0.9.0
4 months ago
0.8.4
4 months ago
0.8.3
5 months ago
0.8.2
6 months ago
0.8.1
7 months ago
0.8.0
7 months ago
0.7.1
7 months ago
0.7.0
7 months ago
0.6.2
7 months ago
0.6.1
8 months ago
0.6.0
8 months ago