prettier-plugin-motoko
v0.10.2
Published
A code formatter for the Motoko smart contract language.
Downloads
2,413
Readme
Motoko Formatter ·
A Prettier plugin for the Motoko programming language.
Setup
After making sure Node.js is installed on your local machine, run the following command in your Motoko project directory:
npm install --save-dev prettier prettier-plugin-motoko
Command-line usage
Format your Motoko files using the Prettier CLI:
npx prettier --write --plugin=prettier-plugin-motoko **/*.mo
Check if your Motoko files are correctly formatted:
npx prettier --check --plugin=prettier-plugin-motoko **/*.mo
Alternatively, check out mo-fmt
for a standalone Motoko formatter CLI:
mo-fmt **/*
mo-fmt -c **/*
VS Code support
- Works out of the box with the Motoko extension.
- Compatible with the the Prettier extension.
Customization
Configure the formatter by creating a .prettierrc
file in your project directory (full documentation).
Add the following line to your config file:
{
"plugins": ["prettier-plugin-motoko"],
}
Example .prettierrc
configuration with default values:
{
"plugins": ["prettier-plugin-motoko"],
"bracketSpacing": true,
"printWidth": 80,
"semi": true,
"tabWidth": 2,
"trailingComma": "es5",
"useTabs": false
}
Multiple languages
Prettier will apply the same configuration to Motoko, JavaScript, CSS, HTML, and any other supported languages.
You can specifically configure Motoko files using a configuration override in your .prettierrc
file:
{
"overrides": [{
"files": "*.mo",
"options": {
"bracketSpacing": true
}
}]
}
Ignoring code
Skip formatting a statement using a prettier-ignore
comment:
// prettier-ignore
func ignored<A>(a:A){a};
func formatted<B>(b : B) { b };
Contributing
Feel free to submit a GitHub issue to report a bug or suggest a feature.
If you're interested in becoming an open-source contributor, be sure to check out the open issues in case anything catches your eye.