Registry / devops / spire-plugin-prettier

spire-plugin-prettier

library5.0.8jsnpmunverified

Prettier plugin for the Spire monorepo toolchain. Current stable version is 5.0.8, released November 2022. Cadence is tied to Spire major releases, with patch releases roughly monthly. Key differentiators: integrates Prettier into Spire's hook system (setup, precommit, run) and provides opinionated defaults for config and ignore files, while allowing customization via options like `prettierConfig`, `autosetPrettierConfig`, and `glob`. Alternative to manual Prettier setup in Spire-based monorepos. Requires peer dependency `spire` ^4.0.0 || ^5.0.0 and Node >=12.20.

devops

npm install spire-plugin-prettier

github ↗package ↗

INSTALL

IMPORT

SIG · SPIRE-PLUGIN-PRETT

spire-plugin-prettier

devopsjavascriptv5.0.8

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.

spire-plugin-prettier

✓ module.exports = { plugins: [['spire-plugin-prettier', options]] }

✗ import spirePluginPrettier from 'spire-plugin-prettier'

Spire plugins are configured in spire.config.js or package.json, not imported like JS modules.

format command

✓ npx spire format

✗ npx prettier --write

Spire wraps prettier; use 'spire format' to run with plugin defaults.

SpireConfig

✓ // spire.config.js module.exports = { plugins: ['spire-plugin-prettier'] }

✗ export default { plugins: ['spire-plugin-prettier'] }

Spire config uses CommonJS; ESM export may not be supported.

Installs and configures spire-plugin-prettier, adds format command, and shows usage with npm script and npx.

// Install dependencies npm install --save-dev spire spire-plugin-prettier // Create spire.config.js module.exports = { plugins: [ ['spire-plugin-prettier', { command: 'format', prettierConfig: './config.js', autosetPrettierConfig: true, }] ] }; // Add script to package.json "scripts": { "format": "spire format" } // Run formatting npm run format // Or use npx npx spire format --write 'src/**/*.js'

Debug

Known issues

breakingNode engine >=12.20 required. Older Node versions will fail.

fix

Upgrade Node to v12.20 or later.

affects: >=5.0.0 <5.0.8

breakingPeer dependency spire must be ^4.0.0 || ^5.0.0. Mismatch causes install failures.

fix

Install compatible spire version: npm install spire@^5.0.0

affects: >=5.0.0

gotchaIf allowCustomConfig is false but user has a .prettierrc file, the plugin throws an error.

fix

Set allowCustomConfig: true or remove .prettierrc.

affects: >=0.0.0

gotchaautosetPrettierConfig true modifies package.json on install; may cause unintended changes in CI.

fix

Set autosetPrettierConfig: false and manually manage prettier config.

affects: >=0.0.0

deprecatedPrettier 2.x is used; Prettier 3.x may break plugin compatibility (untested).

fix

Check if plugin supports prettier v3; if not, pin prettier to v2.

affects: <6.0.0

Errors

Common errors & fixes

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

spire-plugin-prettier not installed or not in node_modules.

fix

Run npm install --save-dev spire-plugin-prettier

Invalid plugin configuration. Expected array or string.

Wrong format in spire.config.js; plugin must be a string or tuple.

fix

Use plugins: ['spire-plugin-prettier'] or plugins: [['spire-plugin-prettier', {}]]

Spire: plugin 'spire-plugin-prettier' requires a peer dependency 'spire' but none was installed.

Missing peer dependency spire.

fix

Install spire: npm install --save-dev spire

Upgrade

Version history

5.0.8latest on npm

Audit

Dependencies

spirerequiredPeer dependency – plugin operates within Spire's hook system; must be installed alongside.

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/researchgate/spire ↗

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