Registry / serialization / prettier-plugin-scaffdog

prettier-plugin-scaffdog

library4.1.0jsnpmunverified

A Prettier plugin for formatting scaffdog template syntax. Current stable version is 4.1.0, released with scaffdog monorepo. It automatically resolves scaffdog configuration to handle custom tags and Markdown file paths. Key differentiator: no manual configuration needed after install as Prettier auto-discovers the plugin. Active development with regular releases. Requires Node.js 18+. Supports TypeScript types for configuration.

serialization

npm install prettier-plugin-scaffdog

github ↗package ↗

INSTALL

IMPORT

SIG · PRETTIER-PLUGIN-SC

prettier-plugin-scaffdog

serializationjavascriptv4.1.0

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.

Config

✓ import { Config } from 'prettier-plugin-scaffdog'

✗ const { Config } = require('prettier-plugin-scaffdog')

Config type is exported since v4.1.0 for type-safe configuration files. ESM import preferred.

default (plugin object)

✓ import plugin from 'prettier-plugin-scaffdog'

✗ const plugin = require('prettier-plugin-scaffdog')

Plugin object for use with Prettier API. ESM import works; CJS require works too but not tree-shakable.

Install plugin, then format a scaffdog template file with Prettier CLI. Plugin auto-discovers configuration.

// 1. Install // npm install --save-dev prettier prettier-plugin-scaffdog // 2. Create a scaffdog template file: example.md // {{ inputs.name | camel }} // 3. Format with Prettier // npx prettier --write example.md // 4. The file becomes: // {{ inputs.name | camel }} // Note: No manual plugin configuration needed; Prettier auto-detects it.

Debug

Known issues

breakingRequires Node.js 18 or later

fix

Upgrade Node.js to 18+ or use version 3.x if on older Node.js.

affects: >=4.0.0

gotchaPlugin may not auto-resolve scaffdog project if run from a different directory

fix

Set scaffdogProject option in Prettier config file relative to that config file.

affects: >=1.0.0

deprecatedConfig type export is new in 4.1.0; previously types were not exported

fix

Upgrade to 4.1.0 or later to use typed config.

affects: <4.1.0

Errors

Common errors & fixes

[error] Unknown plugin: "prettier-plugin-scaffdog"

Plugin not installed or not in node_modules

fix

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

Error: Cannot find module '@scaffdog/engine'

Missing peer dependency

fix

Check that @scaffdog/engine is installed (should be a dependency of prettier-plugin-scaffdog)

Upgrade

Version history

4.1.0latest on npm

Audit

Dependencies

@scaffdog/enginerequiredCore engine for parsing and formatting scaffdog templates

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/scaffdog/scaffdog ↗

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