prettier-plugin-scaffdog

A Prettier plugin for scaffdog templates that automatically format syntax.

Usage no npm install needed!

<script type="module">
  import prettierPluginScaffdog from 'https://cdn.skypack.dev/prettier-plugin-scaffdog';
</script>

README

prettier-plugin-scaffdog

A Prettier plugin for scaffdog templates that automatically format syntax :dog:

- {{inputs["name"]    | camel   }}
+ {{ inputs.name | camel }}

Installation

Install via npm:

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

This plugin is automatically resolved by Prettier, so you can start using it immediately after installation.

Resolving your scaffdog configuration

This plugin reads the scaffdog project configuration. This behavior is necessary to resolve custom tags and Markdown file paths. By default, it searches for .scaffdog in the same directory as the Prettier configuration file (e.g. prettier.config.js).

If the project path cannot be resolved automatically, e.g. the scaffdog project exists in a different file path, use the scaffdogProject option to specify a path relative to the Prettier configuration file.

// prettier.config.js
module.exports = {
  scaffdogProject: './relative/path/.scaffdog',
};