<commit_before># grunt-axe-webdriver

> Grunt plugin for aXe utilizing WebDriverJS

## Getting Started
This plugin requires Grunt `~0.4.5`

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-axe-webdriver --save-dev
```

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

```js
grunt.loadNpmTasks('grunt-axe-webdriver');
```

## The "axe-webdriver" task

### Overview
In your project's Gruntfile, add a section named `axe-webdriver` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
  "axe-webdriver": {
    your_browser_target: {
      // Target-specific file lists and/or options go here.
      options: {
      }
      urls: [],
      dest: "output.json"
    },
  },
});
```

### options
Type: `Object`
Default value:
```
{
  browser: 'firefox',
  threshold: 0
}
```

#### threshold
Type: `Number`
Default value: `0`

A number that represents the maximum number of allowable violations. Each violation represents a rule that fails, it may fail for an number of nodes. It is recommended that this value not be changed.

#### browser
Type: `String`
Default value: `firefox`

Which browser to run the tests in

### urls
Type: `Array[String]`
Default value: `[]`

An Array of URLs that will be tested. The default value is an empty array, you must supply at least one URL in order to successfully complete this task.

### dest
Type: `String`
Default value: undefined

An optional file to which the results of the accessibility scans will be written as a JSON Array of results objects.

### Usage Examples

#### Default Options
In this example, the default options are used in combination with a list of two URLs that are to be tested for accessibility issues. The accessibility tests wil be run in Firefox only. The results will not be output but will be tested for zero violations. If violations occur, the Grunt task will fail and interrupt the Grunt script.

```js
grunt.initConfig({
  "axe-webdriver": {
    firefox: {
      options: {},
      urls: ['http://localhost:9876/tests/test1.html', 'http://localhost:9876/tests/test2.html']
    }
  },
});<commit_msg>Test Junit output<commit_after># grunt-axe-webdriver

> Grunt plugin for aXe utilizing WebDriverJS

## Getting Started
This plugin requires Grunt `~0.4.5`

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-axe-webdriver --save-dev
```

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

```js
grunt.loadNpmTasks('grunt-axe-webdriver');
```

## The "axe-webdriver" task

### Overview
In your project's Gruntfile, add a section named `axe-webdriver` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
  "axe-webdriver": {
    your_browser_target: {
      // Target-specific file lists and/or options go here.
      options: {
      }
      urls: [],
      dest: "output.json",
      junitDest: "output.xml"
    },
  },
});
```

### options
Type: `Object`
Default value:
```
{
  browser: 'firefox',
  threshold: 0
}
```

#### threshold
Type: `Number`
Default value: `0`

A number that represents the maximum number of allowable violations. Each violation represents a rule that fails, it may fail for an number of nodes. It is recommended that this value not be changed.

#### browser
Type: `String`
Default value: `firefox`

Which browser to run the tests in

### urls
Type: `Array[String]`
Default value: `[]`

An Array of URLs that will be tested. The default value is an empty array, you must supply at least one URL in order to successfully complete this task.

### dest
Type: `String`
Default value: undefined

An optional file to which the results of the accessibility scans will be written as a JSON Array of results objects.

### junitDest
Type: `String`
Default value: undefined

An optional file to which the results of the accessibility scans will be written as a Junit XML file.

### Usage Examples

#### Default Options
In this example, the default options are used in combination with a list of two URLs that are to be tested for accessibility issues. The accessibility tests wil be run in Firefox only. The results will not be output but will be tested for zero violations. If violations occur, the Grunt task will fail and interrupt the Grunt script.

```js
grunt.initConfig({
  "axe-webdriver": {
    firefox: {
      options: {},
      urls: ['http://localhost:9876/tests/test1.html', 'http://localhost:9876/tests/test2.html']
    }
  },
});
{'fraction_non_alphanumeric': 0.10390367061565353, 'fraction_numerical': 0.0058263740532142165, 'mean_word_length': 3.956689124157844, 'pattern_counts': {'":': 4, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 1}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3883014', 'n_tokens_mistral': 1553, 'n_tokens_neox': 1481, 'n_words': 657}