prettier-plugin-solidity

A Prettier Plugin for automatically formatting your Solidity code.

If you like this project, please consider contributing to our Gitcoin grant!

Installation and usage

Install both

prettier

prettier-plugin-solidity

npm install --save-dev prettier prettier-plugin-solidity

Run prettier in your contracts:

npx prettier --write 'contracts/**/*.sol'

You can add a script for running prettier on all your contracts:

"prettier": "prettier --write 'contracts/**/*.sol'"

Or you can use it as part of your linting to check that all your code is prettified:

"lint": "prettier --list-different 'contracts/**/*.sol'"

Who's using it?

These are some of the projects using Prettier Solidity:

• Bancor
• Gelato
• Gnosis Protocol
• PieDAO
• Sablier
• Synthetix
• The Sandbox
• UMA
• Uniswap

Integrations

Vim

To integrate this plugin with vim, first install

vim-prettier

vim-plug

Plug 'prettier/vim-prettier', {
  \ 'do': 'yarn install && yarn add prettier-plugin-solidity',
  \ 'branch': 'release/1.x',
  \ 'for': [
    \ 'javascript',
    \ 'typescript',
    \ 'css',
    \ 'less',
    \ 'scss',
    \ 'json',
    \ 'graphql',
    \ 'markdown',
    \ 'vue',
    \ 'lua',
    \ 'php',
    \ 'python',
    \ 'ruby',
    \ 'html',
    \ 'swift',
    \ 'solidity'] }

We modified the

do

let g:prettier#exec_cmd_path = '~/.vim/bundle/vim-prettier/node_modules/.bin/prettier'

To check that everything is working, open a solidity file and run

:Prettier

If you also want to autoformat every time you write the buffer, add these lines:

let g:prettier#autoformat = 0
autocmd BufWritePre *.sol Prettier

Now Prettier will be run every time the file is saved.

VSCode

VSCode is not familiar with the solidity language, so

solidity support

code --install-extension JuanBlanco.solidity

Having done that you should proceed to install

prettier-vscode

code --install-extension esbenp.prettier-vscode

To interact with 3rd party plugins,

prettier-vscode

prettier

prettier-plugin-solidity

package.json

npm install --save-dev prettier prettier-plugin-solidity

As a final check, make sure that VSCode is configured to format files on save.

You'll notice now that

prettier

.prettierrc

{
  "overrides": [
    {
      "files": "*.sol",
      "options": {
        "printWidth": 80,
        "tabWidth": 4,
        "useTabs": false,
        "singleQuote": false,
        "bracketSpacing": false,
        "explicitTypes": "always"
      }
    }
  ]
}

Note: When you install the npm package

prettier

.prettierrc

settings.json

If you want a different configuration for your javascript and solidity files, you can add an overrides property to your

.prettierrc

Contributing

1. Fork it
2. Create your feature branch (

   git checkout -b feature/fooBar

   )
3. Commit your changes (

   git commit -am 'Add some fooBar'

   )
4. Push to the branch (

   git push origin feature/fooBar

   )
5. Create a new Pull Request

License

Distributed under the MIT license. See LICENSE for more information.