Registry / web-framework / prettier-plugin-solgrid

prettier-plugin-solgrid

library0.0.14jsnpmunverified

Prettier plugin for Solidity that leverages solgrid's Rust-based formatter for fast, reliable formatting and linting. Currently at v0.0.14, released weekly with active development. Key differentiators: native Rust performance, integrated linting with autofix (including import ordering, naming conventions, and NatSpec validation), and VS Code save-time stability. Unlike prettier-plugin-solidity, it uses a native parser for better edge-case handling and offers configurable operator line breaks, import grouping, and doc comment rules.

web-framework

npm install prettier-plugin-solgrid

github ↗package ↗

INSTALL

IMPORT

SIG · PRETTIER-PLUGIN-SO

prettier-plugin-solgrid

web-frameworkjavascriptv0.0.14

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

prettier-plugin-solgrid

✓ import prettierPluginSolgrid from 'prettier-plugin-solgrid'

✗ const prettierPluginSolgrid = require('prettier-plugin-solgrid')

Plugin is ESM-only; use dynamic import or add to prettier plugins array as string.

options

✓ // In .prettierrc: { "plugins": ["prettier-plugin-solgrid"], "solidityOperatorLineBreak": true }

✗ require('prettier-plugin-solgrid') in config

Plugin options are defined in Prettier config under the 'solidity' namespace.

prettier

✓ import { format } from 'prettier'; const code = await format(soliditySource, { parser: 'solidity', plugins: ['prettier-plugin-solgrid'] });

✗ import { format } from 'prettier-plugin-solgrid'

The plugin is not a standalone formatter; use Prettier's API with parser 'solidity'.

Installs the plugin, configures Prettier for Solidity files, and formats a .sol file.

// Install // npm install --save-dev prettier prettier-plugin-solgrid // .prettierrc { "plugins": ["prettier-plugin-solgrid"], "parser": "solidity", "solidityOperatorLineBreak": true, "overrides": [{ "files": "*.sol", "options": { "parser": "solidity" } }] } // Format a file // npx prettier --write contract.sol

Debug

Known issues

breakingRequires prettier ^3.0.0; does not work with prettier v2.

fix

Upgrade prettier to v3 or later.

affects: <0.0.1

gotchaPlugin options like `solidityOperatorLineBreak` must be in the Prettier config root, not under a `solidity` subkey.

fix

Set options at top level of .prettierrc.

affects: >=0.0.10

gotchaImport ordering fix may be reverted on save in VS Code if not using the latest version (v0.0.7+).

fix

Upgrade to v0.0.7 or later.

affects: <0.0.7

deprecatedThe `operator_line_break` option v0.0.10 renamed to `solidityOperatorLineBreak` in later versions for Prettier consistency.

fix

Use `solidityOperatorLineBreak` instead.

affects: >=0.0.10

gotchaConfig loading silently ignores unknown rule settings before v0.0.12.

fix

Upgrade to v0.0.12+ to get validation errors.

affects: <0.0.12

Errors

Common errors & fixes

Error: Cannot find module 'prettier-plugin-solgrid'

Plugin not installed or not in node_modules.

fix

Run `npm install --save-dev prettier-plugin-solgrid` and ensure it's in the plugins array.

Error: [prettier] Cannot resolve parser 'solidity'

Prettier config missing parser or plugin not loaded.

fix

Add `"parser": "solidity"` and `"plugins": ["prettier-plugin-solgrid"]` to .prettierrc.

TypeError: prettier.resolveConfig is not a function

Using prettier v2 API with v3 plugin.

fix

Upgrade prettier to v3: `npm install prettier@^3.0.0`.

Upgrade

Version history

0.0.14latest on npm

Audit

Dependencies

prettierrequiredPeer dependency: required to load as a plugin

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/TateB/solgrid ↗

packagehttps://www.npmjs.com/package/prettier-plugin-solgrid ↗