dprint-plugins: init

[phanirithvij]

The plan is to keep track of official dprint plugins here, utilising nixpkgs' update infra. see numtide/treefmt-nix#278 (comment)

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
  • sandbox = relaxed
  • sandbox = true
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 25.05 Release Notes (or backporting 24.11 and 25.05 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
• Fits CONTRIBUTING.md.

---

cc: @zimbatm @kachick

[phanirithvij]

dprint requires the .wasm at the end. if not, it is asking for a checksum along with the file path eg. /nix/store/63fgj93wdnkav6nn266cvg5yy899ccr3-g-plane-pretty_graphql-0.2.1@aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa...

$ nix build -f default.nix dprint-plugins --print-out-paths --no-link
/nix/store/63fgj93wdnkav6nn266cvg5yy899ccr3-g-plane-pretty_graphql-0.2.1.wasm
/nix/store/091iqd1y4rs0ma8q3h601b5wjwdzd3ml-dprint-plugin-jupyter-0.1.5.wasm
/nix/store/6ps6p7jrpkhfsqdljhbln6x7lpq0mqf3-dprint-plugin-biome-0.7.1.wasm
/nix/store/9kvjnc47sd1hcrs1fy8sb11lijk2rs8j-dprint-plugin-toml-0.6.3.wasm
/nix/store/1zjqlkb8rzp1gpx66n3n310jpc9isg8l-dprint-plugin-json-0.19.4.wasm
/nix/store/bwrzsr7kb2rwggpysxi9vl0h1qkz3v7h-g-plane-markup_fmt-0.18.0.wasm
/nix/store/g2niwwr2ygpdkkzsijfj33napxzakgs9-dprint-plugin-markdown-0.17.8.wasm
/nix/store/i2ngikhn7zlayjbh4fn6ibfpg49ghr4p-g-plane-pretty_yaml-0.5.0.wasm
/nix/store/gsc5xd8vylrnvnsvr71rq8b6qbvdilh0-dprint-plugin-dockerfile-0.3.2.wasm
/nix/store/0h56sj4kmyxl6vb4ahfw21fn8cpc63dd-g-plane-malva-0.11.1.wasm
/nix/store/ygkhhlpl0yxf2jymnkcpksblzpfnlxzp-dprint-plugin-typescript-0.93.3.wasm
/nix/store/j5aqsds6bjywx9fsknfak6wzg89cclg0-dprint-plugin-ruff-0.3.9.wasm

[kachick]

In my understanding, dprint and the plugins have WASM schema versions. If there is a mismatch between them, dprint CLI does not run the plugin.

As far as I know, it occurs when dprint < 0.47 and the plugin uses the crate dprint-core >= 0.67.
For example, when using an old dprint CLI and several latest plugins.

Use https://github.com/dprint/dprint/releases/download/0.46.3/dprint-x86_64-unknown-linux-gnu.zip

With dprint.json as below

{
 "biome": {
 },
 "plugins": [
   "https://github.com/dprint/dprint-plugin-biome/releases/download/0.7.1/plugin.wasm"
 ]
}

Then

> ./dprint check
Error resolving plugin https://github.com/dprint/dprint-plugin-biome/releases/download/0.7.1/plugin.wasm: Invalid schema version: 4 -- Expected: 3. Upgrade your dprint CLI (/tmp/tmp.0KZQ0xdk2Y/dprint).

As far as I know, the latest dprint CLI version 0.48.0 supports old schema versions. However, I think it is not a guaranteed specification.

How to keep the compatibility

A version is listed at https://github.com/dprint/plugins/blob/cc8cd4c35bb0685b0a599b8d3c30923e8f41b0a0/info.json#L2-L3, but it does not mean the JSON result always points correct schema versions.

So I suggest it. Adding a test that includes all packaged plugins in the dprint.json enhances the stability of the dprint package in combination with dprint-plugins.
Ideal state is one where an update-script updates the dprint and the plugins together, but I don't know how to realize it in nixpkgs.

[kachick]

So I suggest it. Adding a test that includes all packaged plugins in the dprint.json enhances the stability of the dprint package in combination with dprint-plugins.

Or would injecting the dprint CLI package for each plugin package's checkPhase be more fluent?

[phanirithvij]

@kachick I will look into adding compatibility tests once the code generation part is finalised

[zimbatm]

Thanks @phanirithvij , great work.

I would suggest leaving the schema compatibility issue for later, if it becomes a problem. We should also be mindful of not extending the scope of the PR too much. But up to you @phanirithvij .

[phanirithvij]

Agreed, I will do that in a follow-up PR when I find the time.

[kachick]

Thanks for your work 👍

I don't have enough knowledge to review these Python code and usecase in treefmt-nix. However this discussion sounds good to me. 🙇

nixpkgs-review result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 369415

---

x86_64-linux

✅ 12 packages built:

• dprint-plugins.dprint-plugin-biome
• dprint-plugins.dprint-plugin-dockerfile
• dprint-plugins.dprint-plugin-json
• dprint-plugins.dprint-plugin-jupyter
• dprint-plugins.dprint-plugin-markdown
• dprint-plugins.dprint-plugin-ruff
• dprint-plugins.dprint-plugin-toml
• dprint-plugins.dprint-plugin-typescript
• dprint-plugins.g-plane-malva
• dprint-plugins.g-plane-markup_fmt
• dprint-plugins.g-plane-pretty_graphql
• dprint-plugins.g-plane-pretty_yaml

---

x86_64-darwin

✅ 12 packages built:

• dprint-plugins.dprint-plugin-biome
• dprint-plugins.dprint-plugin-dockerfile
• dprint-plugins.dprint-plugin-json
• dprint-plugins.dprint-plugin-jupyter
• dprint-plugins.dprint-plugin-markdown
• dprint-plugins.dprint-plugin-ruff
• dprint-plugins.dprint-plugin-toml
• dprint-plugins.dprint-plugin-typescript
• dprint-plugins.g-plane-malva
• dprint-plugins.g-plane-markup_fmt
• dprint-plugins.g-plane-pretty_graphql
• dprint-plugins.g-plane-pretty_yaml

---

aarch64-darwin

✅ 12 packages built:

• dprint-plugins.dprint-plugin-biome
• dprint-plugins.dprint-plugin-dockerfile
• dprint-plugins.dprint-plugin-json
• dprint-plugins.dprint-plugin-jupyter
• dprint-plugins.dprint-plugin-markdown
• dprint-plugins.dprint-plugin-ruff
• dprint-plugins.dprint-plugin-toml
• dprint-plugins.dprint-plugin-typescript
• dprint-plugins.g-plane-malva
• dprint-plugins.g-plane-markup_fmt
• dprint-plugins.g-plane-pretty_graphql
• dprint-plugins.g-plane-pretty_yaml

[kachick]

Don't we need to set license for each plugin?

[phanirithvij]

done.

as of now, all the official plugin repos have mit license (even g-plane/*), so I added it as a default argument.

[phanirithvij]

Then, ideally won't we need to build the wasm binaries from source?

not for this pr, just saying.

[kachick]

Then, ideally won't we need to build the wasm binaries from source?

Initially, I had the same question. However, as far as I know, at least for security reasons, the dprint CLI restricts behaviors for wasm plugins. This is a point that I prefer when selecting dprint WASM plugins for formatting.

https://github.com/dprint/dprint/blob/14eb074e9baf8d0533f04ad954e17a5a375e6385/crates/dprint/src/commands/formatting.rs#L2019

as of now, all the official plugin repos have mit license (even g-plane/*), so I added it as a default argument.

Sure. Bye the way, dprint project respects plugins license. I agree for that plugins may depend on the upstream crate license.

dprint license
https://github.com/dprint/dprint/blob/14eb074e9baf8d0533f04ad954e17a5a375e6385/docs/wasm-plugin-development.md?plain=1#L142

And I know a third-party plugin which choose another license of MIT https://github.com/RubixDev/dprint-plugin-stylua/blob/017360e78861dbef4d5c14087660525f9adc9f1a/LICENSE

[kachick]

Thanks for update!