Setup dprint

After installing, the main part of getting setup is to create a dprint.json/dprint.jsonc, or hidden .dprint.json/.dprint.jsonc file in your project.

This file will outline:

  1. The plugins to use.
  2. The configuration to use for formatting files.
  3. Which files to include and exclude from formatting.

Quick Setup

Using the dprint init command is a quick way to get setup formatting your project.

Open a terminal in the root directory of your project and run the following command:

dprint init

This will create a dprint.json file in the current working directory. If you are connected to the internet, it will initialize the file according to the latest plugins.

Manual Setup

Create a dprint.json/dprint.jsonc or hidden .dprint.json/.dprint.jsonc file in the root directory of the project and read the configuration documentation.

Hidden Config File

The dprint CLI supports a default hidden configuration at .dprint.json or .dprint.jsonc.

Custom Config File Location

It is recommended to use an auto-discoverable dprint configuration file name (ex. dprint.json) as the location of your configuration file because it will be automatically picked up by the CLI and editor plugins. If you place it in another other location then it will need to be manually specified using the --config <path> or -c <path> flag whenever you run a command.

dprint init with custom config file location

You may specify a custom path for the creation of a configuration file via dprint init by specifying it with the -c or --config flag.

dprint init --config .dprint.jsonc
dprint init --config path/to/dprint.json

Custom Cache Directory

By default, dprint stores information in the current system user's cache directory (~/.cache/dprint on Linux, ~/Library/Caches/dprint on Mac, and %LOCALAPPDATA%/dprint on Windows) such as cached plugins and incremental formatting information. If you would like to store the cache in a custom location, then specify a DPRINT_CACHE_DIR environment variable. Note that this directory may be periodically deleted by the CLI, so if you set it please make sure it's set correctly and you're ok with the custom directory being deleted.

Proxy

You may specify a proxy for dprint to use when downloading plugins or configuration files by setting the HTTPS_PROXY and HTTP_PROXY environment variables.

Additionally, dprint 0.48+ supports the NO_PROXY environment variable, which is a comma-separated list of hosts which should not use the proxy.

TLS Certificates

dprint downloads plugins via HTTPS. In some cases you may wish to configure this. This is possible via the following environment variables:

  • DPRINT_CERT - Load certificate authority from PEM encoded file.
  • DPRINT_TLS_CA_STORE - Comma-separated list of order dependent certificate stores.
    • Possible values: mozilla and system
    • Defaults to mozilla,system

Requires dprint >= 0.46.0

Unsafely ignoring certificates

Starting in dprint 0.49.0, you can unsafely ignore all or some TLS certificates via the DPRINT_IGNORE_CERTS environment variable:

  • DPRINT_IGNORE_CERTS=1 - Ignore all TLS certificates.
  • DPRINT_IGNORE_CERTS=dprint.dev,localhost,[::],127.0.0.1 - Ignore certs from the specified hosts.

This is very unsafe to do and not recommended. A warning will be displayed on first download when this is done.

Limiting Parallelism

By default, dprint only runs for a short period of time and so it will try to take advantage of as many CPU cores as it can. This might be an issue in some scenarios, and so you can limit the amount of parallelism by setting the DPRINT_MAX_THREADS environment variable in version 0.32 and up (ex. DPRINT_MAX_THREADS=4).

Next step: Configuration