grunt-iniscan

iniscan Grunt plugin

Grunt plugin for running iniscan

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-iniscan --save-dev

Make sure you have iniscan installed

composer require psecio/iniscan

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-iniscan');

The "iniscan" task

Overview

In your project's Gruntfile, add a section named iniscan to the data object passed into grunt.initConfig().

grunt.initConfig({
  iniscan: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.bin

Type: String Default value: 'iniscan'

iniscan executable binary.

In case you do not provide iniscan binary path you need to have it on PATH environment variable otherwise plugin will raise an error

options.path

Type: String Default value: undefined

Path to custom php.ini. If not provided then php-cli loaded php.ini file will be used.

options.threshold

Type: String Default value: WARNING

Minimum rule threshold to scan upon. One of WARNING, ERROR or FATAL

options.format

Type: String Default value: 'console'

Output report format. One of console, html, json or xml

options.context

Type: String Default value: 'prod'

Context to scan rules against, rules out of the specified context won't be checked.

options.php

Type: String Default value: undefined

PHP version to scan upon. If none provided current php-cli PHP_VERSIONis used.

options.output

Type: String Default value: undefined

Output path to save iniscan reports.

Output file name will be iniscan-output{.format} except for console format which won't have extension

Usage Example

grunt.initConfig({
  iniscan: {
    all {
      options: {
        threshold: 'ERROR',
        format: 'json',
        failOnly: true
      }
    }
  },
});

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.