Package detail

ignorable

zkochan19MIT1.1.2

Detects whether a file in a package can be ignored

ignore

readme

ignorable

Detects whether a file in a package can be ignored

npm version Build Status !--/@--

Installation

npm i -S ignorable

Usage

!--@example('./example.js')--
const ignorable = require('ignorable')

console.log(ignorable('readme.md'))
//> true

console.log(ignorable('test.js'))
//> true

console.log(ignorable.safe('test.js'))
//> false
!--/@--

API

ignorable(filename)

Returns whether true if the file does not influence the functionality of the package.

ignorable.safe(filename)

Safer than ignorable(). Does not return true for resources that might be dangerous to remove.

License

MIT © Zoltan Kochan