Source code formatter for Solidity?

Question

Most programming languages have tools to format source code according to convention: for example, Python has autopep8 and yapf, and Go has gofmt.

Does a similar tool exist for Solidity source code, ideally according to the Solidity Style Guide?

It may be better to ask this on https://softwarerecs.stackexchange.com/ — Chenmunka, Apr 29 '16 at 12:32
would love to see this in JetBrains suite, specifically PyCharm ! — euri10, Jun 15 '16 at 08:45

score 17 · Answer 1 · answered Aug 16 '16 at 09:14

17

I've recently published a Linter for Solidity which aims to comply the the official Style Guide.

Here's the repo

The architecture is pretty similar to that of ESLint so I'm trying to make it as easy-to-use and customizable (including plugging in of custom rules) as ESLint is.

Its under active development right now.

To get started, you could install it via npm:

npm install -g solium

Browse to the root directory of your project and run

solium --init

This creates .soliumrc.json (determines which rules to enable and handles plugging in of custom rules) & .soliumignore (specifies which files and folders to ignore)

To run the linter on a single file, simply use: solium --file path/to/myfile.sol

To lint over your entire project (all .sol files), use:

solium

OR

solium --hot to enable hot reloading.

Hopefully, this improves workflow & developer productivity, since I've been facing a lot of trouble developing for Ethereum platform, because of the lack of dev tools. Hope you find it useful!

answered Aug 16 '16 at 09:14

Raghav Dua

171
1
4

3

Thanks for sharing this! Does Solium only do linting, or can it reformat files too? – Pi Delport Aug 17 '16 at 13:09
1

@PiDelport I'm not sure what you mean by reformatting. Do you mean fixing the lint errors automatically? (If yes, then) I'm currently in the process of implementing a fix mechanism, so in a week or so, yah, it will support fixing. – Raghav Dua Aug 17 '16 at 15:28
Basically that, yes: reading the code in, and then reformatting it back out according to the style guide (like autopep8 and yapf, gofmt, and so on). – Pi Delport Aug 18 '16 at 18:13
Is there any prettier plugin for VS code, like there is for javascript. I am facing this problem. I get error all the time for the indentation in my solidity code not adhering to the standard ( 4 spaces ) – Kashish Khullar Sep 30 '18 at 14:43

score 7 · Answer 2 · answered Jan 06 '19 at 18:53

7

There's a work in progress towards a plugin for prettier that formats solidity code: https://github.com/prettier-solidity/prettier-plugin-solidity As with prettier, the goal is to have an opinionated tool that takes your code, builds its AST and prints it again.

(Disclaimer: I'm one of the contributors)

answered Jan 06 '19 at 18:53

Franco Victorio

2,862
17
27

1

I think this is more than WIP now! Just tried it out and it worked flawlessly. – Paul Razvan Berg Jul 19 '19 at 23:47

firescar96 · Answer 3 · 2016-06-15T15:05:55.037

4

If you use atom.io there is a linter: https://atom.io/packages/linter-solidity

And for syntax highlighting goodies: https://atom.io/packages/language-ethereum

edited Jun 15 '16 at 15:05

answered Jun 15 '16 at 06:23

firescar96

582
1
4
10

Thanks! That only shows lint output, though, and doesn't format code, right? – Pi Delport Jun 15 '16 at 11:28
updated to add a code formatter – firescar96 Jun 16 '16 at 18:31
The highlighter performs syntax highlighting, but also doesn't format code. – Pi Delport Jun 17 '16 at 08:21
You're right, I thought it was that package, but it was another package:https://atom.io/packages/atom-beautify which I configured for solidity. – firescar96 Jun 17 '16 at 18:12
Ah, how did you configure it? – Pi Delport Jun 18 '16 at 23:00
Look at the configuration instructions on that page, you should be able to configure it to do most of the things you want. – firescar96 Jun 19 '16 at 03:58

score 3 · Answer 4 · answered Apr 18 '23 at 06:18

3

The 2023 answer is to use forge fmt. https://book.getfoundry.sh/reference/config/formatter

Do that once and be liberated from this issue

answered Apr 18 '23 at 06:18

user3677274

31
1

score 3 · Answer 5 · edited May 08 '17 at 08:15

3

https://github.com/alexstep/SublimeLinter-contrib-solium

Solium linter plugin for sublime text

edited May 08 '17 at 08:15

q9f

32,913
47
156
395

answered May 07 '17 at 21:41

Alex Step

156
1
4

score 2 · Answer 6 · answered Jun 28 '17 at 05:33

2

This is available now for IntelliJ (and related IDEs):

https://plugins.jetbrains.com/plugin/9475-intellij-solidity

answered Jun 28 '17 at 05:33

Symmetric

121
2

score 1 · Answer 7 · edited Sep 27 '17 at 17:53

1

This is a linter that provides security, style and best practice validations.

You may install it with

npm install -g solhint

For validation you need put in arguments glob expression of path to your code

solhint *.sol

I believe this tool with be useful for your project!

edited Sep 27 '17 at 17:53

carver

6,381
21
51

answered Sep 27 '17 at 06:20

alex

11
1

welcome to the community :) look here for more guide on formatting – Achala Dissanayake Sep 27 '17 at 11:50
Solhint is awesome, but OP asked for a formatter not a linter. – coolboyjules Jul 08 '18 at 22:18

score 1 · Answer 8 · answered Dec 02 '17 at 00:54

1

You can use YAKINDU Soliditiy Tools, its open source and it has some other interesting features even if it is currently in beta phase.

https://medium.com/solidity-ide/yakindu-solidity-tools-beta-released-dbcc76307bc0

answered Dec 02 '17 at 00:54

Johannes Dicks

11
1

Source code formatter for Solidity?

8 Answers8