Skip to content

README.md

Latest commit

 

History

History
52 lines (34 loc) · 1.77 KB

README.md

File metadata and controls

52 lines (34 loc) · 1.77 KB
Raw

dprint-plugin-mago

CI

Adapter for Mago for use as a formatting plugin in dprint.

Install

Install and setup dprint.

Then in your project's directory with a dprint.json file, run:

dprint add mago
# or install from npm
dprint add npm:@dprint/mago

Note: You do not need Mago installed globally as dprint will run Mago from the .wasm file in a sandboxed environment.

Configuration

To add configuration, specify a "mago" key in your dprint.json:

{
  "mago": {
    "printWidth": 100,
    "useTabs": true,
  },
  "plugins": [
    // ...etc...
  ],
}

For an overview of the config, see https://dprint.dev/plugins/mago/config/

Note: The plugin does not understand Mago's configuration file because it runs sandboxed in a Wasm runtime—it has no access to the file system in order to read Mago's config.

JS Formatting API

Versioning

This repo automatically upgrades to the latest version of Mago once a day. You can check which version of Mago is being used by looking at the mago-formatter entry in the Cargo.toml file in this repo:

https://github.com/dprint/dprint-plugin-mago/blob/main/Cargo.toml

At the moment, the version of this plugin does not reflect the version of Mago. This is just in case there are any small bug fixes that need to be made as this plugin is quite new. After a while I'll try to match the versions.