README.md

prettier

form8ion plugin for projects that manage code style with prettier

Table of Contents

• Usage
  • Installation
  • Example
    • Import
    • Execute
• Contributing
  • Dependencies
  • Verification

Features

• Configures prettier in the scaffolded project to extend the provided shareable config
• Installs the provided shareable config
• Installs the related eslint config and configures eslint to use it

Notes

• prettier will only be configured if a config scope is defined
• the shareable config is expected to define a dependency on prettier, so the scaffolded project will not be configured to depend directly on prettier
• the pretter and eslint config names are defined by convention, so packages that are named as @<your-scope>/prettier-config and @<your-scope>/eslint-config-prettier are expected to exist

Usage

Installation

$ npm install @form8ion/prettier --save-prod

Example

Import

import {scaffold} from '@form8ion/prettier';

Execute

(async () => {
  await scaffold({projectRoot: process.cwd(), config: {scope: '@foo'}});
})();

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test