@form8ion/ignore-file v1.0.0

ignore-file

form8ion utility for managing ignore files

Table of Contents

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

Usage

Installation

$ npm install @form8ion/ignore-file --save-prod

Example

Import

import {exists, read, write} from '@form8ion/ignore-file';

Execute

const projectRoot = process.cwd();
const toolName = 'tool-name';

await exists({projectRoot, name: toolName});

await read({projectRoot, name: toolName});

await write({projectRoot, name: toolName, ignores: ['foo/', 'bar.js']});

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test