Skip to content
This repository was archived by the owner on Mar 19, 2021. It is now read-only.

Commit 9169ffa

Browse files
author
Marcy Sutton
committed
Merge branch 'develop'
2 parents 9b20eef + cbfcb89 commit 9169ffa

5 files changed

Lines changed: 76 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
<a name="1.2.0"></a>
2+
# [1.2.0](https://github.com/dequelabs/axe-cli/compare/1.0.2...1.2.0) (2017-10-31)
3+
4+
5+
### Features
6+
7+
* Allow running from file:// and ftp(s):// ([#41](https://github.com/dequelabs/axe-cli/issues/41)) ([aa3d937](https://github.com/dequelabs/axe-cli/commit/aa3d937))
8+
* Link to DeqeuU courses/testingmethods ([#38](https://github.com/dequelabs/axe-cli/issues/38)) ([8c0e661](https://github.com/dequelabs/axe-cli/commit/8c0e661))
9+
* support exit codes ([e14e2d5](https://github.com/dequelabs/axe-cli/commit/e14e2d5)), closes [#20](https://github.com/dequelabs/axe-cli/issues/20) [#22](https://github.com/dequelabs/axe-cli/issues/22)
110

211

312
<a name="1.1.1"></a>

CONTRIBUTING.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Contributing
2+
3+
## Contributor License Agreement
4+
5+
In order to contribute, you must accept the [contributor license agreement](https://cla-assistant.io/dequelabs/axe-core) (CLA). Acceptance of this agreement will be checked automatically and pull requests without a CLA cannot be merged.
6+
7+
## Contribution Guidelines
8+
9+
Submitting code to the project? Please review and follow the axe-core
10+
[Git commit and pull request guidelines](https://github.com/dequelabs/axe-core/blob/develop/doc/code-submission-guidelines.md).
11+
12+
### Code Quality
13+
14+
Although we do not have official code style guidelines, we can and will request you to make changes
15+
if we think that your code is sloppy. You can take clues from the existing code base to see what we
16+
consider to be reasonable code quality. Please be prepared to make changes that we ask of you even
17+
if you might not agree with the request(s).
18+
19+
Pull requests that change the tabs of a file (spacing or changes from spaces to tabs and vice versa)
20+
will not be accepted. Please respect the coding style of the files you are changing and adhere to that.
21+
22+
That having been said, we prefer:
23+
24+
1. Tabs over spaces
25+
2. Single quotes for string literals
26+
3. Function definitions like `function functionName(arguments) {`
27+
4. Variable function definitions like `Class.prototype.functionName = function (arguments) {`
28+
5. Use of 'use strict'
29+
6. Variables declared at the top of functions
30+
31+
### Testing
32+
33+
We expect all code to be covered by tests. We don't have or want code coverage metrics but we will review tests and suggest changes when we think the test(s) do(es) not adequately exercise the code/code changes.
34+
35+
### Documentation and Comments
36+
37+
Functions should contain a preceding comment block with [jsdoc](http://usejsdoc.org/) style documentation of the function. For example:
38+
39+
```
40+
/**
41+
* Runs the Audit; which in turn should call `run` on each rule.
42+
* @async
43+
* @param {Context} context The scope definition/context for analysis (include/exclude)
44+
* @param {Object} options Options object to pass into rules and/or disable rules or checks
45+
* @param {Function} fn Callback function to fire when audit is complete
46+
*/
47+
```
48+
49+
## Setting up your environment
50+
51+
In order to get going, fork and clone the repository. Then, if you do not have [Node.js](https://nodejs.org/download/) installed, install it!
52+
53+
Once the basic infrastructure is installed, from the repository root, do the following:
54+
55+
```
56+
npm install
57+
```
58+
59+
To run axe-cli from your development environment, run:
60+
61+
```
62+
node index.js www.deque.com
63+
```
64+

index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ axeTestUrls(urls, program, {
143143
'issues can automatically be detected. \nManual testing is ' +
144144
'always required. For more information see:\n%s\n'
145145
), link(
146-
'https://dequeuniversity.com/curriculum/courses/archive/1.0/testing'
146+
'https://dequeuniversity.com/curriculum/courses/testingmethods'
147147
));
148148
}).catch((e) => {
149149
console.log(' ');

lib/utils.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
module.exports.parseUrl = function parseUrl(url) {
2-
if (url.substr(0,4) !== 'http') {
2+
if (!/[a-z]+:\/\//.test(url)) {
33
return 'http://' + url;
44
}
55
return url;

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "axe-cli",
3-
"version": "1.1.1",
3+
"version": "1.2.0",
44
"description": "A CLI for accessibility testing using axe-core",
55
"main": "index.js",
66
"engines": {

0 commit comments

Comments
 (0)