Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juliangut/grunt-security-checker
Grunt plugin for running security-checker
https://github.com/juliangut/grunt-security-checker
Last synced: 23 days ago
JSON representation
Grunt plugin for running security-checker
- Host: GitHub
- URL: https://github.com/juliangut/grunt-security-checker
- Owner: juliangut
- License: bsd-3-clause
- Created: 2015-05-09T16:13:41.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-05-20T16:46:41.000Z (over 8 years ago)
- Last Synced: 2024-10-03T03:44:24.778Z (about 1 month ago)
- Language: JavaScript
- Size: 11.7 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://npmjs.org/package/grunt-security-checker)
[](https://github.com/juliangut/grunt-security-checker/blob/master/LICENSE)
[](https://npmjs.org/package/grunt-security-checker)
[](https://npmjs.org/package/grunt-security-checker)
# security-checker Grunt plugin
> Grunt plugin for running [security-checker](https://github.com/sensiolabs/security-checker)
## Getting Started
This plugin requires Grunt `>=0.4.0`
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install grunt-security-checker --save-dev
```
Make sure you have security-checker installed
```shell
composer require sensiolabs/security-checker
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-security-checker');
```
## The "security_checker" task
### Overview
In your project's Gruntfile, add a section named `security-checker` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
security_checker: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
```
### 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
```js
grunt.initConfig({
security_checker: {
all {
options: {
format: 'json'
},
file: './test/composer.lock'
}
},
});
```
## Contributing
Found a bug or have a feature request? [Please open a new issue](https://github.com/juliangut/grunt-security-checker/issues). Have a look at existing issues before.
See file [CONTRIBUTING.md](https://github.com/juliangut/grunt-security-checker/blob/master/CONTRIBUTING.md)
## License
See file [LICENSE](https://github.com/juliangut/grunt-security-checker/blob/master/LICENSE) included with the source code for a copy of the license terms.