husky

opinionated scaffolder for configuring Git hooks using husky

Table of Contents

• Usage
  • Installation
  • Example
    • Import
    • Execute
  • API
    • scaffold
      • projectRoot string (required)
      • packageManager string (required)
    • test
    • lift
      • projectRoot string (required)
      • packageManager string (required)
• Contributing
  • Dependencies
  • Verification

Usage

Installation

$ npm install @form8ion/husky --save

Example

Import

import {lift, scaffold, test} from './lib/index.cjs';

Execute

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

  await test({projectRoot: process.cwd()});

  await lift({projectRoot: process.cwd(), packageManager: 'foo'});
})();

API

scaffold

Scaffolder for configuring git hooks programatically through the use of husky

Takes a single options object as an argument, containing:

projectRoot string (required)

path to the root of the project

packageManager string (required)

chosen package manager to be used for the project

test

Predicate for determining whether the lift functionality should be applied to the current project. Identifies if husky is currently in use for the project.

Takes a single options object as an argument, containing:

projectRoot string (required)

path to the root of the project

lift

Lifter for adjusting configuration of git hooks programatically through the use of husky

Takes a single options object as an argument, containing:

projectRoot string (required)

path to the root of the project

packageManager string (required)

chosen package manager to be used for the project

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test