README.md

git

form8ion plugin for managing projects versioned with git

Table of Contents

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

Features

• Initializes a git repository for a project
• Configures git to handle line endings across operating systems
• Manages ignoring files and directories from being versioned
• Detects an existing git repository configured for a project

Usage

Installation

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

Example

Import

import {scaffold, test, lift} from '@form8ion/git';

Execute

const projectRoot = process.cwd();

await scaffold({projectRoot});

if (await test({projectRoot})) {
  await lift({projectRoot, results: {vcsIgnore: {file: [], directories: []}}});
}

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test