Practical overview
When it fits
Use it when Solidity files need consistent Prettier formatting in a project workflow or a documented standalone browser integration.
Who it is for
- Developers maintaining Solidity contracts in a Prettier-based project.
- Teams adding a Solidity formatting check to a lint workflow.
- Developers building a browser integration that loads Prettier’s standalone bundle and the Solidity plugin.
Documented uses
- Format Solidity contract files from a Node.js project.
- List Solidity files that differ from the configured formatting.
- Configure Solidity-specific Prettier options alongside rules for other file types.
- Call Prettier formatting in a browser integration using the plugin.
Requirements & limits
- Node.js use requires both Prettier and prettier-plugin-solidity.
- The README recommends explicitly adding the plugin to configuration because Prettier 3 removed plugin search.
- The plugin only formats valid Solidity code; syntax errors result in a parser error.
- The compiler option can influence formatting where Solidity compiler versions change syntax handling, including multiline imports around version 0.7.4.
- The documented browser route loads Prettier’s standalone bundle before the plugin.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Format Solidity files in a Node.js project
Install the Prettier plugin and run it to format Solidity contract files.
Before you start
- A Node.js project
- Solidity contract files
- Prettier and prettier-plugin-solidity installed as development dependencies
Steps
Install the packages with the command below.
npm install --save-dev prettier prettier-plugin-solidityRun the command below to format the matching contract files.
npx prettier --write --plugin=prettier-plugin-solidity 'contracts/**/*.sol'
Expected outcome
Prettier writes formatted output for the Solidity files matched by the supplied glob.
Guide limitations
- The plugin formats valid Solidity code; syntax errors produce a parser error.
- The documented command targets the
contractsdirectory pattern shown in the README.
Check Solidity formatting in a project lint command
Use Prettier to list Solidity files that differ from the configured formatting.
Before you start
- A Node.js project
- Prettier and prettier-plugin-solidity installed as development dependencies
- Solidity contract files
Steps
Add a lint script using
prettier --list-different --plugin=prettier-plugin-solidity 'contracts/**/*.sol'.Run the lint script as part of the project’s linting workflow.
Expected outcome
Prettier lists files that differ from the formatter’s output.
Guide limitations
- The documented workflow checks formatting differences; it does not describe Solidity compilation or code auditing.
- The plugin requires valid Solidity code and throws a parser error for syntax errors.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 9 October 2026
- Original website title
- prettier-solidity/prettier-plugin-solidity · Official homepage title · retained in its source language