README.md

remark-plugin-scaffolder

opinionated scaffolder for remark plugins

Table of Contents

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

Usage

Installation

$ npm install @form8ion/remark-plugin-scaffolder --save-prod

Example

Import

import {scaffold} from '@form8ion/remark-plugin-scaffolder';

Execute

scaffold({
  projectRoot: process.cwd(),
  projectName: 'name-of-the-project',
  packageName: '@scope/name-of-the-package',
  tests: {integration: true}
});

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test