Code Monkey home page Code Monkey logo

ignorable's Introduction

ignorable

Detects whether a file in a package can be ignored

npm version Build Status

Installation

npm i -S ignorable

Usage

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

ignorable's People

Contributors

zkochan avatar

Watchers

 avatar  avatar

Forkers

andreineculau

ignorable's Issues

curiousity killed the cat

Why do you say it's unsafe to ignore test.js and example.js ?

And why do you say it's safe to ignore AUTHORS files? it's not actually. both AUTHORS and NOTICE :s

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.