README.md

commit-convention

form8ion plugin for managing tools related to commit conventions

Table of Contents

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

Usage

Installation

$ npm install @form8ion/commit-convention --save-prod

Example

Import

import {packageManagers} from '@form8ion/javascript-core';
import {scaffold, test, lift} from '@form8ion/commit-convention';

Execute

(async () => {
  const projectRoot = process.cwd();

  await scaffold({projectRoot, configs: {}});

  if (await test({projectRoot})) {
    await lift({projectRoot, packageManager: packageManagers.NPM});
  }
})();

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test