dprint

Changes

• perf: lazily create ureq agents (#836)

dprint on Mac and Linux now starts up faster.

Before:

% dprint -v
0.45.0
% time dprint check --incremental=false ./data/package-template.json
0.173s total

After:

% dprint -v
0.45.1
% time dprint --incremental=false ./data/package-template.json
0.023s total

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• feat: experimental lsp (#803)
• feat: protect against plugin formatting non-empty file above 300 chars to empty file (#807)
• fix: upgrade wasmer to 4.2.5 (#809)
• fix: respect NO_COLOR env var (#808)

Experimental Language Server

This release adds a language server to dprint found at dprint lsp. This will allow more easily using dprint in editors beside vscode and intellij, such as Neovim.

To try it out in vscode, add "dprint.experimentalLsp": true to your vscode settings. Please try it out and let me know if you run into any issues.

Outstanding tasks:

• Figure out how to do completions for dprint.json files (https://github.com/dprint/dprint/issues/806)
• Document how to use dprint lsp with editors such as Neovim (https://github.com/dprint/dprint/issues/810)
  • If you use Neovim or any other editor that easily supports the LSP, please consider contributing some setup documentation instructions as I'm very unfamiliar with other editors.

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

This is a breaking change for how the CLI uses the file patterns passed to it.

1. Paths provided to the CLI (ex. dprint fmt **/*.js) are now an intersection with the config includes patterns.
   • In other words, this only matches file patterns provided as CLI args that also match the config.
2. Paths provided as --excludes (ex. dprint fmt --excludes **/data) are now a union with the config excludes patterns.
   • In other words, this excludes files/directories in addition to what's excluded in the config.

The old behaviour may be useful in some rare cases. To get it, you can use these new CLI flags:

1. --includes-override - overrides/replaces the patterns derived from the config. This is the previous behaviour of providing file patterns as CLI args.
2. --excludes-override - overrides/replaces the "excludes" value in the config. This is the previous behaviour of --excludes.

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• fix: cli include args should not override negated includes in config (#797)
• fix: support formatting Vec<u8> (not just utf-8 strings) (#792)
  • Also a slight perf improvement.

dprint-plugin-jupyter

There is now a Jupyter Notebook plugin to format code blocks in Jupyter Notebooks using any other dprint plugin.

https://dprint.dev/plugins/jupyter/

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• fix: smarter 'no files found' error when providing cli args and has nested configs (#789)
• fix: recommend running with --allow-no-files in some cases (#788)
• fix: resolve 'system' newline global config in CLI (#787)
• fix: config glob matching was somewhat broken if cwd was descendant dir (#786)

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• feat: --allow-no-files (https://github.com/dprint/dprint/pull/778)

This allows specifying a --allow-no-files flag on the command line (ex. dprint check --allow-no-files **/*.ts) to supress the non-zero exit code when dprint finds no files and return a 0 exit code. Previously, the only option was to have some way of checking for exit code 14, which was inconvenient. This will be useful in pre-commit hooks, for example.

More Plugins

The plan (not guarantee... I do this in my free time) for the end of this year has been to get more formatters working in dprint, improve the Prettier plugin, and get dprint compiling on more architectures. See the End of 2023 roadmap for more details.

On that note, dprint now supports two additional plugins.

Biome Plugin

There is now a Biome adapter plugin for formatting JavaScript, TypeScript, and JSON files with Biome. It's a Wasm plugin so it runs sandboxed and you can use it on all CPU architectures that dprint supports. Additionally, it supports formatting via a JavaScript API.

Run the following to add the Biome plugin to your dprint.json:

dprint config add biome

For more details, see: https://dprint.dev/plugins/biome/

Ruff Plugin

Similarly, there is now a Ruff adapter plugin for formatting Python files with Ruff. It is also a Wasm plugin and also has support for formatting via a JavaScript API.

Run the following to add the Ruff plugin to your dprint.json:

dprint config add ruff

For more details, see: https://dprint.dev/plugins/ruff/

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• Added an aarch64-unknown-linux-musl build.

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• perf: ensure incremental cache doesn't get invalidated by unstable jsonc deserialization (#766)

The incremental cache was getting busted more often than it should have when using certain plugins such as dprint-plugin-exec. This was due to unstable json deserialization in only certain scenarios. After this change, the serialization is now stable and the incremental cache should work much better.

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• fix(check): --list-different should not output its error message (https://github.com/dprint/dprint/pull/765)

Apologies for the noise of doing multiple releases in one day.

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• fix: key wasm plugin cache on rustc version (https://github.com/dprint/dprint/pull/764)

Needed to do a quick release in order to bust the Wasm cache after upgrading the Rust version.

See 0.42.0 release notes for features: https://github.com/dprint/dprint/releases/tag/0.42.0

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• feat(check): --list-different flag (#756)
  • dprint check --list-different will output the list of files that are not formatted instead of a diff (same as Prettier).
• feat: add --log-level flag (#762)
  • This adds a granular logging flag. Ex. --log-level=warn for only fatal errors and warnings.

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• feat: monitor and throttle CPU if necessary (#744)
• fix: log and ignore PermissionDenied errors when globbing (#748)
• fix: key Wasm cache on CPU features (#739) -- Fixes bug with caching on GH actions

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• fix: improve error message when process plugin is too old (#732)
• fix: dprint init should not have includes pattern anymore (#730)

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• fix: do not error for --config in sub dir in some cases (regression in 0.40.0) (https://github.com/dprint/dprint/pull/727)

See https://github.com/dprint/dprint/releases/tag/0.40.0 release notes for details on previous release.

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• feat: ability for plugins to update their config on dprint config update (#722)
• feat: ability for plugins to provide extensions & filenames based on configuration (#721)
• feat: nested directory specific configuration -- no inheritence yet (#719)

This release breaks the process plugin interface and it was too much work for me to have backwards compatiblity. You will have to upgrade to the latest version of the CLI and plugins.

Here are the latest urls for some of the process plugins at the time of this release (usually you can just do dprint config update to automatically update, but not for this release):

• https://github.com/dprint/dprint-plugin-exec
  • https://plugins.dprint.dev/exec-0.4.2.json@ca3c3d1cc1105b4ac1c31afdb26791a90209f13a5950f8de00dcab5e5ee293a7
• https://github.com/dprint/dprint-plugin-prettier
  • https://plugins.dprint.dev/prettier-0.27.0.json@3557a62b4507c55a47d8cde0683195b14d13c41dda66d0f0b0e111aed107e2fe
• https://github.com/dprint/dprint-plugin-roslyn
  • https://plugins.dprint.dev/roslyn-0.14.0.json@6f6a9aee458d0c6fc2a8aba5f1638b9dca2adc1ff3e202fe4eb639a30a374127

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• fix: properly handle "excludes" in extended config (#709)
• fix(npm): remove bin.js from platform specific package.json files (#708)
• fix: cosmetic and logging improvements (#707)

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• feat: make using "includes" in a configuration file not the default (#698)
• feat: add shell completions generation (dprint completions <shell>) (#678, #699)
• feat: allow includes/excludes when extending non-remote config files (#697)
• feat: allow "excludes" patterns in remote config (#696)
• fix: race condition where cache state got overwritten by other thread (#694)
• fix(npm): cleanup temp file on failed rename (#692)

Starting in this release, it is recommended to not have an "includes" pattern in your dprint configuration file as it is largely unnecessary now. Instead, exclude files using an "excludes" pattern.

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• fix(npm): handle multiple processes initializing the npm package at the same time (#691)

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• fix: prevent multiple dprint processes downloading the same url at the same time (#690)
• fix: handle multiple processes writing to Wasm cache at the same time (#689)

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums

Changes

• fix(npm): make it work with yarn berry and readonly file systems (#687)
• fix: restrict process plugin initialization to one process at a time (#688)

Install

Run dprint upgrade or see https://dprint.dev/install/

Checksums