feat: add support for multiple dprint plugins (#13)

Author: bitbloxhub

README.md

@@ -54,6 +54,36 @@ export default [
       'format/dprint': ['error', { language: 'toml', languageOptions: { indentWidth: 2 } }],
     },
   },
+
+  // use dprint to format HTML and CSS in style tags
+  {
+    files: ['**/*.html'],
+    languageOptions: {
+      parser: format.parserPlain,
+    },
+    plugins: {
+      format,
+    },
+    rules: {
+      'format/dprint': ['error', {
+        plugins: [
+          {
+            plugin: 'node_modules/dprint-plugin-malva/plugin.wasm',
+            options: {},
+          },
+          {
+            plugin: 'node_modules/dprint-plugin-markup/plugin.wasm',
+            options: {
+              scriptIndent: true,
+              styleIndent: true,
+            },
+          },
+        ],
+        useTabs: false,
+        indentWidth: 2,
+      }],
+    },
+  },
 ]
 ```
 
@@ -74,10 +104,15 @@ Use dprint to format files.
 
 #### Options
 
+Either:
 - `language` (required) - the language to format, or can be a filepath or URL to the WASM binary. [Supported languages](https://dprint.dev/plugins/)
 - `languageOptions` - the options for the language
 - The rest options are passed as dprint's general options
 
+Or:
+- `plugins` (required) - Array of plugins, defined as an object containing `plugin` (same as `language` above) and `options`, which is the same as `languageOptions` above.
+- The rest of the options are passed as dprint's general options
+
 ## Sponsors
 
 <p align="center">

dts/rule-options.d.ts

@@ -7,8 +7,6 @@ export interface RuleOptions {
 
 export { PrettierOptions }
 
-export interface DprintOptions {
-  language: string
-  languageOptions?: Record<string, unknown>
-  [x: string]: unknown
-}
+export type DprintOptions
+  = | { language: string, languageOptions?: Record<string, unknown>, [x: string]: unknown }
+    | { plugins: Array<{ plugin: string, options?: Record<string, unknown> }>, [x: string]: unknown }

package.json

@@ -65,7 +65,7 @@
     "eslint": "^8.40.0 || ^9.0.0"
   },
   "dependencies": {
-    "@dprint/formatter": "^0.4.1",
+    "@dprint/formatter": "^0.5.1",
     "@dprint/markdown": "^0.20.0",
     "@dprint/toml": "^0.7.0",
     "eslint-formatting-reporter": "^0.0.0",

pnpm-lock.yaml

@@ -26,6 +26,9 @@ export default {
           languageOptions: {
             type: 'object',
           },
+          plugins: {
+            type: 'array',
+          },
         },
         additionalProperties: true,
       },

src/rules/dprint.ts

@@ -1,6 +1,6 @@
-// @ts-check
 const { Buffer } = require('node:buffer')
 const fs = require('node:fs/promises')
+// @ts-check
 const { runAsWorker } = require('synckit')
 
 let dprint
@@ -38,16 +38,32 @@ runAsWorker(async (code, filename, options) => {
     dockerfile: '@dprint/dockerfile',
   }
 
-  const lang = builtInLangs[options.language] || options.language
-  const promise = cache.has(lang)
-    ? cache.get(lang)
-    : cache.set(lang, loadBuffer(lang).then(r => dprint.createFromBuffer(r))).get(lang)
-
-  const formatter = await promise
-  const { lang: _, languageOptions = {}, ...rest } = options
-  formatter.setConfig(rest, languageOptions)
-  return formatter.formatText({
-    filePath: filename,
-    fileText: code,
-  })
+  if (options.language) {
+    const lang = builtInLangs[options.language] || options.language
+    const promise = cache.has(lang)
+      ? cache.get(lang)
+      : cache.set(lang, loadBuffer(lang).then(r => dprint.createFromBuffer(r))).get(lang)
+
+    const formatter = await promise
+    const { lang: _, languageOptions = {}, ...rest } = options
+    formatter.setConfig(rest, languageOptions)
+    return formatter.formatText({
+      filePath: filename,
+      fileText: code,
+    })
+  }
+  else {
+    // TODO: context caching??
+    const { plugins, ...rest } = options
+    const context = dprint.createContext(rest)
+
+    for (const plugin of plugins) {
+      context.addPlugin(await loadBuffer(plugin.plugin), plugin.options || {})
+    }
+
+    return context.formatText({
+      filePath: filename,
+      fileText: code,
+    })
+  }
 })