Skip to content

form8ion/remark-plugin-scaffolder

Repository files navigation

remark-plugin-scaffolder

opinionated scaffolder for remark plugins

Node CI Workflow Status

Table of Contents

Usage

MIT license npm Try @form8ion/remark-plugin-scaffolder on RunKit

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

PRs Welcome Conventional Commits Commitizen friendly semantic-release Renovate

Dependencies

$ nvm install
$ npm install

Verification

$ npm test