Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dfinity/prettier-plugin-motoko
A code formatter for the Motoko smart contract language.
https://github.com/dfinity/prettier-plugin-motoko
Last synced: 5 days ago
JSON representation
A code formatter for the Motoko smart contract language.
- Host: GitHub
- URL: https://github.com/dfinity/prettier-plugin-motoko
- Owner: dfinity
- License: apache-2.0
- Created: 2022-08-10T23:25:39.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-24T20:33:02.000Z (about 1 month ago)
- Last Synced: 2024-09-26T20:50:29.916Z (about 1 month ago)
- Language: TypeScript
- Size: 847 KB
- Stars: 28
- Watchers: 5
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-internet-computer - Motoko Formatter - A configurable Prettier plugin for Motoko. (Motoko / Monitoring)
README
# Motoko Formatter · [](https://www.npmjs.com/package/prettier-plugin-motoko) [](https://opensource.org/licenses/Apache-2.0) [](https://github.com/dfinity/prettier-plugin-motoko/issues)
> ### A [Prettier](https://prettier.io/) plugin for the [Motoko](https://internetcomputer.org/docs/current/developer-docs/build/cdks/motoko-dfinity/motoko/) programming language.
---
## Setup
After making sure [Node.js](https://nodejs.org/en/download/) is installed on your local machine, run the following command in your Motoko project directory:
```sh
npm install --save-dev prettier prettier-plugin-motoko
```
## Command-line usage
Format your Motoko files using the [Prettier CLI](https://prettier.io/docs/en/cli.html):
```sh
npx prettier --write --plugin=prettier-plugin-motoko **/*.mo
```
Check if your Motoko files are correctly formatted:
```sh
npx prettier --check --plugin=prettier-plugin-motoko **/*.mo
```
Alternatively, check out [`mo-fmt`](https://www.npmjs.com/package/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](https://marketplace.visualstudio.com/items?itemName=dfinity-foundation.vscode-motoko).
- Compatible with the the [Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode).
## Customization
Configure the formatter by creating a `.prettierrc` file in your project directory ([full documentation](https://prettier.io/docs/en/configuration.html)).
Add the following line to your config file:
```json
{
"plugins": ["prettier-plugin-motoko"],
}
```
### Example `.prettierrc` configuration with default values:
```json
{
"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](https://prettier.io/docs/en/configuration.html#configuration-overrides) in your `.prettierrc` file:
```json
{
"overrides": [{
"files": "*.mo",
"options": {
"bracketSpacing": true
}
}]
}
```
## Ignoring code
Skip formatting a statement using a `prettier-ignore` comment:
```motoko
// prettier-ignore
func ignored(a:A){a};
func formatted(b : B) { b };
```
## Contributing
Feel free to [submit a GitHub issue](https://github.com/dfinity/prettier-plugin-motoko/issues/new) 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](https://github.com/dfinity/prettier-plugin-motoko/issues) in case anything catches your eye.