Git Product home page Git Product logo

vile-retire's Introduction

vile-retire circle ci build status appveyor build status score-badge coverage-badge dependency-badge

A Vile plugin for identifying vulnerabilities in your JavaScript libraries (via RetireJS).

Requirements

Installation

npm i -D vile retire vile-retire

Config

The config is one to one with (most of) retire's -- style CLI options.

Example:

retire:
  config:
    package: true
    node: true
    js: true
    dropexternal: true
    nocache: true
    jspath: "sompath"
    nodepath: "somepath"
    path: "somepath"
    jsrepo: "..."
    noderepo: "..."
    proxy: "http://..."
    ignorefile: "somepath/.retireignore"

Ignoring Files

Since RetireJS actually might want to scan some directories you would otherwise ignore, such as node_modules, you can only configure that as part of the config section:

retire:
  config:
    ignore:
      - one
      - two

This list will be mapped to the --ignore option.

You can also use .retireignore as the retire CLI will pick it up.

Allowing Files

With what this plugin offers, the allow list is not really needed.

Try the --path|nodepath|jspath config options, if need be.

Versioning

This project uses Semver.

Licensing

This project is licensed under the MPL-2.0 license.

Any contributions made to this project are made under the current license.

Contributions

Current list of Contributors.

Any contributions are welcome and appreciated!

All you need to do is submit a Pull Request.

  1. Please consider tests and code quality before submitting.
  2. Please try to keep commits clean, atomic and well explained (for others).

Issues

Current issue tracker is on GitHub.

Even if you are uncomfortable with code, an issue or question is welcome.

Code Of Conduct

By participating in this project you agree to our Code of Conduct.

Maintainers

Architecture

This project is currently written in JavaScript. RetireJS provides a JSON CLI output that is currently used until a more ideal IPC option is implemented.

  • bin houses any shell based scripts
  • src is es6+ syntax compiled with Babel
  • lib generated js library

Developing

cd vile-retire
npm install
npm install retire
npm run dev
npm test

vile-retire's People

Contributors

brentlintner avatar

Watchers

 avatar

vile-retire's Issues

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.