security-checker Grunt plugin
Grunt plugin for running security-checker
Getting Started
This plugin requires Grunt >=0.4.0
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-security-checker --save-dev
Make sure you have security-checker installed
composer require sensiolabs/security-checker
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "security_checker" task
Overview
In your project's Gruntfile, add a section named security-checker
to the data object passed into grunt.initConfig()
.
grunt;
Options
options.bin
Type: String
Default value: 'security-checker'
security-checker executable binary.
In case you do not provide security-checker binary path you need to have it on PATH environment variable otherwise plugin will raise an error
options.format
Type: String
Default value: undefined
Output format to use. One of text
or json
options.output
Type: String
Default value: undefined
Output path to save security-checker reports.
Output file name will be security-checker-output
Usage Example
grunt;
Contributing
Found a bug or have a feature request? Please open a new issue. Have a look at existing issues before.
See file CONTRIBUTING.md
License
See file LICENSE included with the source code for a copy of the license terms.