eslint-plugin-dprint

This is an updated fork of mysticatea/eslint-plugin-dprint.

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
$ npm install -D dprint-plugin-malva
$ npm install -D dprint-plugin-markup
$ npm install -D dprint-plugin-yaml
$ npm install -D dprint-plugin-graphql

📖 Usage

Write your ESLint configuration. For example with typescript code:

import { defineConfig } from "eslint/config";
import tsPlugin from "@typescript-eslint/eslint-plugin";
import tsParser from "@typescript-eslint/parser";
import dprint from "@ben_12/eslint-plugin-dprint";

module.exports = defineConfig([
  {
    files: ["**/*.ts", "**/*.js"],

    languageOptions: {
        parser: tsParser
    },

    plugins: {
        "@typescript-eslint": tsPlugin,
        "@ben_12/dprint": dprint,
    },

    rules: {
      ...tsPlugin.configs["eslint-recommended"].rules,
      ...tsPlugin.configs["recommended"].rules,
      ...tsPlugin.configs["strict"].rules,
      ...dprint.configs["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/
          },
        },
      ],
    },
  },
]);

For legacy eslint (eslintrc configuration),

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!

Providing a pre-resolved formatter via settings

By default the plugin loads each dprint formatter at module-load time by doing a dynamic require() of the corresponding peer package (@dprint/typescript, dprint-plugin-yaml, …). That works for most setups, but it relies on the optional peer dependency being installed and discoverable by Node's resolver. Some bundlers and bundled config packages (anything that does static module-graph analysis, e.g. Packtory) only follow real import statements, so the dprint plugins never end up in the bundle. In that case the plugin logs Plugin not found: … for every linted file and the rule silently becomes a no-op.

You can avoid this by passing a pre-resolved formatter through ESLint's settings. Settings are not serialized or structuredCloned by ESLint, so they can carry runtime objects (modules, buffers, pre-built formatters). When a formatter is provided this way, the plugin uses it directly and skips the dynamic require() lookup (and the associated "Plugin not found" warning).

Accepted shapes for each formatter entry:

• an object with getPath(): string (the shape exported by @dprint/typescript, @dprint/json, @dprint/markdown, @dprint/toml, @dprint/dockerfile)
• an object with getBuffer(): Buffer | Uint8Array (legacy shape, previously used by some @dprint/* packages)
• a raw Buffer / Uint8Array / ArrayBuffer of the plugin's wasm bytes
• a pre-built Formatter returned by @dprint/formatter's createFromBuffer

Example (flat config):

import { defineConfig } from "eslint/config";
import dprint from "@ben_12/eslint-plugin-dprint";
import typescriptFormatter from "@dprint/typescript";

export default defineConfig([
  {
    files: ["**/*.ts"],
    plugins: { "@ben_12/dprint": dprint },
    settings: {
      "@ben_12/dprint": {
        formatters: {
          typescript: typescriptFormatter,
        },
      },
    },
    rules: {
      "@ben_12/dprint/typescript": ["error", { config: { /* dprint config */ } }],
    },
  },
]);

The settings key is the plugin namespace (@ben_12/dprint). Inside formatters, the key is the rule name (typescript, json, markdown, toml, dockerfile, malva, markup, yaml, graphql).

g-plane plugins (yaml, malva, markup, graphql)

The @dprint/* packages can be imported and passed straight through, as in the example above. The g-plane packages (dprint-plugin-yaml, dprint-plugin-malva, dprint-plugin-markup, dprint-plugin-graphql) have no JS entrypoint and ship only plugin.wasm, so callers have to resolve and read the wasm file themselves and pass the result through createFromBuffer (or as a raw BufferSource). Example for dprint-plugin-graphql:

import { defineConfig } from "eslint/config";
import dprint from "@ben_12/eslint-plugin-dprint";
import { createFromBuffer } from "@dprint/formatter";
import fs from "node:fs";

const graphqlFormatter = createFromBuffer(
  fs.readFileSync(new URL(import.meta.resolve("dprint-plugin-graphql/plugin.wasm"))),
);

export default defineConfig([
  {
    files: ["**/*.graphql"],
    plugins: { "@ben_12/dprint": dprint },
    settings: {
      "@ben_12/dprint": {
        formatters: { graphql: graphqlFormatter },
      },
    },
    rules: {
      "@ben_12/dprint/graphql": ["error", { config: { /* dprint config */ } }],
    },
  },
]);

The same pattern (with the matching package and rule name) applies to yaml, malva, and markup.

For unparsed eslint file like markdown or dockerfile, you can use @ben_12/eslint-simple-parser as parser.

import { defineConfig } from "eslint/config";
import dprint from "@ben_12/eslint-plugin-dprint";
import simpleParser from "@ben_12/eslint-simple-parser";

export default defineConfig([
  {
    files: ["**/*.md"],
    plugins: {
        "@ben_12/dprint": dprint,
    },
    languageOptions: {
        parser: simpleParser,
    },
    rules: dprint.configs["markdown-recommended"].rules,
  },
]);

Available Rules

Available Configs

• 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 into coverage directory.
• npm run watch ... Run tests when files are edited.
• npm version <patch|minor|major> ... Bump a new version.