Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revamp the API and configuration to allow for more modular rules to be added #119

Merged
merged 457 commits into from
Nov 14, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
457 commits
Select commit Hold shift + click to select a range
be6f51e
Adding some tags!
ted-humpal Mar 8, 2017
4a887bd
Merge pull request #8 from ted-humpal/patch-1
romeovs Mar 8, 2017
8bff3fe
Added/removed dirs and files from npmignore
Mar 24, 2017
fa32346
Added the bundle script to the prepublish script so that the webpack …
Mar 24, 2017
c715c45
Updated urls to point to this repo instead of the forked from repo
Mar 24, 2017
2ffa8ac
Added a CONTRIBUTING page and linked to it from the README.
Mar 26, 2017
d85328e
Added some more scripts for helping with the version and publish proc…
Mar 26, 2017
36589bf
Merge pull request #9 from erin-doyle/publish_improvements
romeovs Mar 27, 2017
d0401be
1. Updated eslint and plugin versions
Apr 9, 2017
3cb951f
Merge pull request #12 from romeovs/eslint_update
Apr 9, 2017
3173a1d
Fixed #10 where if a tagName is being checked for reserved in the DOM…
Apr 18, 2017
f3fdef5
Merge pull request #13 from romeovs/Issue-10_fix
Apr 24, 2017
e41ba68
Fixed #11 from being too strict testing for use-onblur-not-onchange. …
Apr 24, 2017
2b0e710
Merge pull request #14 from romeovs/Issue-11_fix
Apr 27, 2017
2b9d870
Added a script to automatically add the commit revision numbers and c…
Apr 30, 2017
3e21b53
Updated the CHANGELOG.md to include the changesets from the 0.3.3 Rel…
Apr 30, 2017
2ec548d
Version 0.3.4
Apr 30, 2017
286907a
Updated the the karma dependencies and made some changes to the karma…
May 1, 2017
8e6d829
Minor package.json updates
May 1, 2017
a7eb16f
Fixed #16 inappropriately referencing this in a context where this is…
May 26, 2017
81dc28a
Merge pull request #17 from romeovs/Issue-16_fix
May 30, 2017
c2f7d62
Version 0.3.5
May 30, 2017
dcde81d
Merge pull request #18 from romeovs/Issue-16_fix
May 31, 2017
b3130b4
Merge remote-tracking branch 'upstream/master'
Jun 1, 2017
9293073
Don't throw violations for valid inputs with type="submit" (#132)
Robdel12 Jun 11, 2017
8aff35a
[doc] reflect what needs to happen (#129)
Swaagie Jun 11, 2017
e426ced
Resolve Issue 122 by not testing null results of ReactDOM.findDOMNode…
CoreyKumpAL Jun 11, 2017
d931532
0.3.4
wyattdanger Jun 11, 2017
b8f4e58
Update ReactDOM for react v16 compatibility
ebenpack Oct 11, 2017
b083bed
Version 0.3.6
Oct 12, 2017
875c4d3
Update options validation for v16 compatibility
ebenpack Oct 14, 2017
161f6fe
Removed /lib/index.js from version control
Oct 15, 2017
f2d5fcf
only add id when we need it for includeSrcNode
romeovs Apr 5, 2016
90bf8a3
clean up code
romeovs Apr 5, 2016
8a00a58
move test running code to separate file
romeovs Apr 5, 2016
e7a971a
refactor a lot and use findDOMNode instead of getElementById
romeovs Apr 5, 2016
8ffdc8c
inject ReactDOM from options
romeovs Apr 5, 2016
1813089
refactor errors and warnings, add outerHTML to error
romeovs Apr 5, 2016
57f21da
fix bug where props were null and triggerd a faulty ref
romeovs Apr 5, 2016
51fb649
remove object.assign dep, as it is no longer needed
romeovs Apr 5, 2016
8bc78b7
fix bug where restoring original function is a TypeError
romeovs Apr 5, 2016
ae006e1
use different mechanism of storing refs, so root-level DOM elements w…
romeovs Apr 5, 2016
4115af1
inject ReactDOM in the tests
romeovs Apr 5, 2016
54d12dc
pass element id to filterFn to comply with API
romeovs Apr 5, 2016
94ddb6e
test just runs test
romeovs Apr 5, 2016
3efed1a
improve docs, add info about fork and future plans
romeovs Apr 6, 2016
928a33c
add message to filterFn args, like in docs
romeovs Apr 6, 2016
7c563b8
add info about fixed issues
romeovs Apr 6, 2016
6579ce4
remove contribution rules
romeovs Apr 6, 2016
262068f
enable js for all examples
romeovs Apr 6, 2016
8248248
switch to more modern babel
romeovs Apr 6, 2016
77821b3
remove older react deps
romeovs Apr 6, 2016
dfb39f7
add eslint as linter
romeovs Apr 6, 2016
56e52a1
ignore npm-debug.log
romeovs Apr 6, 2016
be539b8
prepare tests for es6
romeovs Apr 6, 2016
edf08b8
move tests to tests/ folder
romeovs Apr 6, 2016
c934a3b
remove superfluous test.webpack.js
romeovs Apr 6, 2016
cbda7a0
move changelog preview script to package.json
romeovs Apr 6, 2016
a034a28
clean up webpack config
romeovs Apr 6, 2016
2d34c09
add bundle script
romeovs Apr 6, 2016
acc63d6
mv source files to src, and output to lib. dist remains for webpacked…
romeovs Apr 6, 2016
0bda24a
reduce lint
romeovs Apr 6, 2016
737f2d5
update module path
romeovs Apr 7, 2016
a1c2ba0
fix all tests
romeovs Apr 7, 2016
d69726b
big refactor - make A11y a separate class and start implementing new …
romeovs Apr 7, 2016
85f5ff3
lint it out
romeovs Apr 7, 2016
0f84539
lint it out
romeovs Apr 7, 2016
0513c65
add comments
romeovs Apr 7, 2016
a1f8a57
add command for mocha testing (no-browser)
romeovs Apr 7, 2016
9574131
add new testing code, that uses rules
romeovs Apr 7, 2016
166949e
make use of new testing class
romeovs Apr 7, 2016
20e5599
fix case where a ref string was already set
romeovs Apr 8, 2016
2a0a349
write tests for options checker
romeovs Apr 8, 2016
e21636d
split tests into browser/node/shared
romeovs Apr 8, 2016
3b7159a
just use react-dom
romeovs Apr 8, 2016
9da1d87
start adding tests for A11y class
romeovs Apr 8, 2016
7791eae
add list of devices for rules
romeovs Apr 8, 2016
f2a4dc4
pass as much info as possible to the reporter
romeovs Apr 8, 2016
e3b66a9
provide even more info to reporter
romeovs Apr 8, 2016
8bc8798
add test for img-uses-alt rule
romeovs Apr 8, 2016
549c4d3
remove old tests
romeovs Apr 8, 2016
8897eb0
make tests more async
romeovs Apr 8, 2016
aa7f8be
add rule tests for karma
romeovs Apr 8, 2016
c61ccdb
rename defaults to options as it messes with some editors
romeovs Apr 8, 2016
d65490e
add helper method for sync testing, and write test helpers
romeovs Apr 8, 2016
a84b64a
add tests for NOT warnign and for label-uses-for
romeovs Apr 8, 2016
a57c141
omit helpers file in test
romeovs Apr 8, 2016
b1e0416
omit browser for node tests
romeovs Apr 8, 2016
c45668b
make sure the reporter recieves all it needs
romeovs Apr 8, 2016
1c054bf
remove superfluous flag
romeovs Apr 8, 2016
02fbbb1
add mouse-events-map-to-key-events rule
romeovs Apr 8, 2016
89bc376
check for invalid rule configs
romeovs Apr 8, 2016
e9db063
document new api
romeovs Apr 8, 2016
c05f556
conform API to what's in the docs
romeovs Apr 8, 2016
72f3a7e
add url to mouse-events rule
romeovs Apr 8, 2016
ccce302
show url in default reporter
romeovs Apr 8, 2016
eabdc41
differentiate between browser and server tests in script
romeovs Apr 8, 2016
18a17f3
fix this instance
romeovs Apr 8, 2016
6789b9a
make ReactDOM detection work on server side
romeovs Apr 9, 2016
8b46008
check for instance on owner before trying to use it
romeovs Apr 9, 2016
5ee602a
make default reporter use displayName correctly
romeovs Apr 9, 2016
e3f1cfc
remove console.log
romeovs Apr 9, 2016
c2f0160
move options checking to options.js completely, allow omission of Rea…
romeovs Apr 9, 2016
7f8e898
make default logging more readable on server
romeovs Apr 9, 2016
30297ee
document that ReactDOM is optional on server
romeovs Apr 9, 2016
ae6c6a6
spelling and grammar
romeovs Apr 9, 2016
049c901
make phrasing more generous, brush up examples
romeovs Apr 9, 2016
a75cede
clean up util module and add some utilities
romeovs Apr 9, 2016
d41c37b
default opts is empty {}
romeovs Apr 9, 2016
286508a
use new util module structure
romeovs Apr 9, 2016
ab70372
move tests for ReactDOM, as they only apply on client
romeovs Apr 9, 2016
334fbcd
add listens-to util
romeovs Apr 9, 2016
30890e1
make test options complu with new API
romeovs Apr 9, 2016
9c5770b
add etst for click-but-no-role
romeovs Apr 9, 2016
d08e29e
fix import path
romeovs Apr 9, 2016
12a5751
fix bug where rule tests interfered with each other
romeovs Apr 9, 2016
faace44
add rule name to reporter info
romeovs Apr 9, 2016
830f9db
make regex more specific
romeovs Apr 9, 2016
3075be4
remove console.log
romeovs Apr 9, 2016
2ae718d
change rule names to match eslint-plugin-jsx-a11y
romeovs Apr 9, 2016
1770f34
omit aria-hidden elements from presentational tests
romeovs Apr 9, 2016
e4785f8
allow rules that only have the _any_ key to return a function immediatly
romeovs Apr 9, 2016
eb7e0cd
simplify rule
romeovs Apr 9, 2016
66651e6
fix options disambiguation ReactDOM vs opts
romeovs Apr 9, 2016
adea90c
implement button-role-space
romeovs Apr 9, 2016
314cc98
implement no-access-key
romeovs Apr 9, 2016
dadaba9
add no-hash-ref rule
romeovs Apr 9, 2016
8d05ff3
remove redundant arg
romeovs Apr 9, 2016
30f5cc1
add redundant-alt rule
romeovs Apr 9, 2016
aa76ddb
implement use-onblur-not-onchange
romeovs Apr 9, 2016
8c6fe59
allow onchange on readOnly and disabled elements
romeovs Apr 9, 2016
d44ceaa
add util to check if prop is to be considered true
romeovs Apr 9, 2016
497d78b
use trueish
romeovs Apr 9, 2016
1236d1b
implement valid-aria-role
romeovs Apr 9, 2016
99c8f2d
fix spacing in string
romeovs Apr 9, 2016
f8d1794
improce test on redundant-alt
romeovs Apr 9, 2016
228484f
implement hidden-uses-tabindex
romeovs Apr 9, 2016
947d25d
correct devices in hidden-uses-tabindex
romeovs Apr 9, 2016
d1b41e9
add tabindex-uses-button rule
romeovs Apr 9, 2016
5ab7f6b
fix bug in props normalisation
romeovs Apr 9, 2016
5f84455
make trueish and listensTo more robust
romeovs Apr 9, 2016
a3b06a2
add tests for util
romeovs Apr 9, 2016
63018ac
test util/browser
romeovs Apr 9, 2016
c17e4e5
reduce lint
romeovs Apr 9, 2016
ac8dbf5
switch to more static rule definitions
romeovs Apr 11, 2016
3c48db8
add task to write docs
romeovs Apr 11, 2016
844ca67
require affects in the reporter
romeovs Apr 11, 2016
1a5f16f
normalize props before handing them to test
romeovs Apr 11, 2016
6d40627
convert hidden-uses-tabindex
romeovs Apr 11, 2016
95d4658
fix button-role space
romeovs Apr 15, 2016
a900f6d
inject react in tests so pass an fail exports can use them
romeovs Apr 15, 2016
36838c5
add label-uses-for
romeovs Apr 15, 2016
4f660d5
inject react instead of importing it
romeovs Apr 15, 2016
c9f8996
convert mouse-events-map-to-key-events
romeovs Apr 15, 2016
a7669fb
also inject react in mkdocs
romeovs Apr 15, 2016
5820fd6
add w bit more whitespace to eventual docs
romeovs Apr 15, 2016
4528248
convert onclick-uses-role
romeovs Apr 15, 2016
2400444
convert onclick-uses-tabindex
romeovs Apr 15, 2016
04e803c
add has-props helper
romeovs Apr 15, 2016
ecaa968
convert no-access-key
romeovs Apr 15, 2016
c665e9b
convert no-hash-ref.js
romeovs Apr 15, 2016
2ab056c
add descriptions
romeovs Apr 15, 2016
c7eb1a2
expand what docs can do (show options), warnings about exports
romeovs Apr 15, 2016
74afae0
convert redundant-alt
romeovs Apr 15, 2016
975895b
allow options in tests
romeovs Apr 15, 2016
a73e6d4
fix no-hash-ref
romeovs Apr 15, 2016
899a2ec
add ctx
romeovs Apr 15, 2016
d3ff108
convert use-onblur-not-onchange
romeovs Apr 15, 2016
097aedd
valid-aria-role
romeovs Apr 15, 2016
7b976cd
convert tabindex-uses-button
romeovs Apr 15, 2016
6aced4c
rename audit to AX
romeovs Apr 15, 2016
c258116
add all related ursl to docs
romeovs Apr 15, 2016
5099bd3
extract some aria, dom and role info into util
romeovs Apr 15, 2016
2a2d5e1
expand has-prop to work with arrays of props
romeovs Apr 15, 2016
8850af7
implement no-unsuppoerted-elements-use-aria
romeovs Apr 15, 2016
b2f803d
add docs (generated by mkdocs)
romeovs Apr 15, 2016
7688d11
fix some supid typos
romeovs Apr 15, 2016
345e58b
disable no-unsupp.. until normalizeProps is fixed
romeovs Apr 15, 2016
e2be925
fix error in mkdocs links
romeovs Apr 15, 2016
e9d9278
remove prop normalization (this causes confusion)
romeovs Apr 16, 2016
742d852
use de-normalize `aria-hidden`
romeovs Apr 16, 2016
cca81b4
fix test for aria-hidden
romeovs Apr 16, 2016
e4598c8
remove normalisation guards for trueish as well
romeovs Apr 16, 2016
e392f9b
remove all references of ariaHidden and the likes
romeovs Apr 16, 2016
93b54b4
update docs after removing ariaHidden
romeovs Apr 16, 2016
0ddcf20
ensure every rule has pass, fail and description
romeovs Apr 16, 2016
a3a9b55
refactor mkdocs
romeovs Apr 16, 2016
604d13e
use refactored docs!
romeovs Apr 16, 2016
d2fd246
reenable no-unsupported-element-uses-aria
romeovs Apr 16, 2016
98e4117
remove redundant test pattern
romeovs Apr 16, 2016
1d94acb
make all tests dual on browser and node
romeovs Apr 16, 2016
1aa294b
expand test for util
romeovs Apr 16, 2016
b8fa2bd
explain a bit on how to write plugins
romeovs Apr 16, 2016
91a6b08
add link to plugins docs
romeovs Apr 16, 2016
5c70a74
clarify some parts and add link to examples
romeovs Apr 16, 2016
e48f677
move plugin rules to rules prop
romeovs Apr 16, 2016
e9b7bb2
1.0.0
romeovs Apr 16, 2016
f246bc4
remove references to next branch and elaborate example
romeovs Apr 16, 2016
d23af5e
do not show url message if no url is present
romeovs Apr 16, 2016
4fbd7bc
add avoid-positive-tabindex
romeovs Apr 16, 2016
2ec3a93
show url to Google Audit page when AX is present
romeovs Apr 16, 2016
db3033a
add babel-runtime for async
romeovs Apr 16, 2016
07b3db5
test run async
romeovs Apr 16, 2016
5cdbbf4
make the rule index a bit lighter
romeovs Apr 16, 2016
4584efe
make testRules a util function
romeovs Apr 16, 2016
12bf6ac
fix typo in variable name
romeovs Apr 16, 2016
7352c2f
properly forward url and AX
romeovs Apr 16, 2016
047b6d8
reduce lint
romeovs Apr 16, 2016
055137e
fix async test typo
romeovs Apr 17, 2016
870c95f
remove __forceSync, as it makes no sense now
romeovs Apr 17, 2016
aa1c76f
remove calls to __forceSync
romeovs Apr 17, 2016
6006faa
add link to rule docs
romeovs Apr 17, 2016
1d2ebc9
don't do dynamic imports on modules as this is hard for packagers
romeovs Apr 18, 2016
34b6008
fix bug where test-rules doesn't catch false positives
romeovs Apr 24, 2016
b7f9fae
fix false positive
romeovs Apr 24, 2016
cc11117
fix false positives
romeovs Apr 24, 2016
f5f25b0
fix false positives
romeovs Apr 24, 2016
8dd0930
mention the fact that all rules are turned off by default
romeovs Apr 24, 2016
252a8eb
remove test-rules from source tree, so it doen't show warnings and ne…
romeovs Apr 24, 2016
5368bcb
allow src to exist on npm
romeovs May 10, 2016
f33f24b
run build on postinstall
romeovs May 10, 2016
bd98df6
Update package.json
romeovs Sep 26, 2016
691813f
Adding some tags!
ted-humpal Mar 8, 2017
28526c8
Added/removed dirs and files from npmignore
Mar 24, 2017
6900d78
Added the bundle script to the prepublish script so that the webpack …
Mar 24, 2017
8343d64
Updated urls to point to this repo instead of the forked from repo
Mar 24, 2017
d4f1795
Added a CONTRIBUTING page and linked to it from the README.
Mar 26, 2017
cc94032
Added some more scripts for helping with the version and publish proc…
Mar 26, 2017
8ebb4f1
1. Updated eslint and plugin versions
Apr 9, 2017
e33f1fa
Fixed #10 where if a tagName is being checked for reserved in the DOM…
Apr 18, 2017
e94f387
Fixed #11 from being too strict testing for use-onblur-not-onchange. …
Apr 24, 2017
46cbffd
Added a script to automatically add the commit revision numbers and c…
Apr 30, 2017
a3ace85
Updated the CHANGELOG.md to include the changesets from the 0.3.3 Rel…
Apr 30, 2017
c0c815a
Version 0.3.4
Apr 30, 2017
df94435
Updated the the karma dependencies and made some changes to the karma…
May 1, 2017
f4d032d
Minor package.json updates
May 1, 2017
2041271
Fixed #16 inappropriately referencing this in a context where this is…
May 26, 2017
e40b8de
Version 0.3.5
May 30, 2017
d5cd8ae
Update ReactDOM for react v16 compatibility
ebenpack Oct 11, 2017
ea3f481
Version 0.3.6
Oct 12, 2017
4f2d7dc
Update options validation for v16 compatibility
ebenpack Oct 14, 2017
cc6c600
Merge remote-tracking branch 'origin/master'
Oct 15, 2017
55e159a
Added a matrix to the travis configuration with more recent node vers…
Oct 16, 2017
735010a
Added the babel-register package as travis is complaining when buildi…
Oct 16, 2017
b34a9a0
Add travis build fixes
ebenpack Oct 15, 2017
a3d83bd
Fix karma tests; remove DOMNode
ebenpack Oct 15, 2017
067cf71
Fix DOMNode for v16
ebenpack Oct 15, 2017
c4b4460
Revert DOMNode removal
ebenpack Oct 15, 2017
2628c05
Cleanup
ebenpack Oct 15, 2017
518c752
Fix authors field
romeovs Oct 16, 2017
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"presets": [
"es2015",
"stage-0",
"react"
],
"plugins": [
"transform-runtime"
]
}
2 changes: 2 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
lib/
webpack.config.js
54 changes: 54 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
{
"env": {
"browser": true,
"node": true,
"es6": true,
"mocha": true
},
"parserOptions": {
"ecmaVersion": 2017,
"sourceType": "module",
"ecmaFeatures": {
"jsx": true,
"modules": true
}
},
"extends": [
"airbnb"
],
"plugins": [
"babel",
"mocha",
"react"
],
"rules": {
"babel/new-cap": 1,
"comma-dangle": ["error", "never"],
"complexity": ["warn", { "max": 7 }],
"generator-star-spacing": 1,
"id-length": ["error", { "exceptions": ["_", "x", "y", "z", "i", "e", "t"] }],
"import/no-named-as-default": 0, // connected/test-only components
"import/no-extraneous-dependencies": ["error", {"devDependencies": true}], // tests
"indent": ["error", 4, {"SwitchCase": 2}],
"max-len": [1, 120, 2, {"ignoreComments": true}],
"no-await-in-loop": 1,
"no-param-reassign": ["error", { "props": false }],
"no-plusplus": ["error", { "allowForLoopAfterthoughts": true }],
"no-underscore-dangle": "off",
"no-use-before-define": [2, "nofunc"],
"no-unused-vars": "warn",
"object-shorthand": 1,
"quotes": [2, "single"],
"react/forbid-prop-types": [1, { "forbid": ["any"] }], // used in conjunction with the transform-react-remove-prop-types babel plugin
"react/jsx-filename-extension": [1, { "extensions": [".js", ".jsx"] }],
"react/jsx-indent": ["error", 4],
"react/jsx-indent-props": ["error", 4],
"react/jsx-uses-react": 2,
"react/jsx-uses-vars": 2,
"react/no-find-dom-node": "warn", // TODO: change this to error and fix findings
"react/prop-types": 0, // not currently working for stateless components: https://github.com/yannickcr/eslint-plugin-react/issues/803
"react/react-in-jsx-scope": 2,
"strict": [2, "never"],
"vars-on-top": "error"
}
}
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
dist
dist/
lib/
node_modules/
npm-debug.log
2 changes: 0 additions & 2 deletions .jshintignore

This file was deleted.

5 changes: 0 additions & 5 deletions .jshintrc

This file was deleted.

6 changes: 2 additions & 4 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
CONTRIBUTING.md
bower.json
lib
*.log
test
karma.conf.js
scripts
webpack.config.js
15 changes: 13 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
language: node_js

node_js:
- "0.10"
- "stable"
- "8"
- "7"
- "6"
- "4"

before_script:
- export DISPLAY=:99.0
- sh -e /etc/init.d/xvfb start
- sh -e /etc/init.d/xvfb start

cache: yarn

matrix:
fast_finish: true
29 changes: 27 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,32 @@
v0.3.3 - Fri, 15 Apr 2016 19:32:24 GMT
0.3.6 - Thu, 12 Oct 2017 12:50:02 GMT
-------------------------------------

- [b8f4e58](../../commit/b8f4e58) Update ReactDOM for react v16 compatibility


v0.3.5 - Tue, 30 May 2017 14:23:58 GMT
-----------------------------------------

- [a7eb16f](../../commit/a7eb16f) Fixed #16 inappropriately referencing this in a context where this is actually undefined.


v0.3.4 - Sun, 30 Apr 2017 20:48:28 GMT
--------------------------------------

-
- [e41ba68](../../commit/e41ba68) Fixed #11 from being too strict testing for use-onblur-not-onchange. Now it should pass if onChange is used in addition to onBlur.
- [3173a1d](../../commit/3173a1d) Fixed #10 where if a tagName is being checked for reserved in the DOM object but does not exist in the DOM object an exception was being thrown
- [d0401be](../../commit/d0401be) 1. Updated eslint and plugin versions 2. Added the AirBnB eslint config to inherit 3. Fixed all linter findings


v0.3.3 - Mon, 3 Apr 2017 23:01:39 GMT
--------------------------------------

- [d85328e](../../commit/d85328e) Added some more scripts for helping with the version and publish process and added descriptions of the scripts in the CONTRIBUTING.md
- [2ffa8ac](../../commit/2ffa8ac) Added a CONTRIBUTING page and linked to it from the README.
- [c715c45](../../commit/c715c45) Updated urls to point to this repo instead of the forked from repo
- [fa32346](../../commit/fa32346) Added the bundle script to the prepublish script so that the webpack bundle gets included in the npm package. Also disabled the release script and removed the rf-release package as this does not seem to be tagging or publishing to npm properly.
- [8bff3fe](../../commit/8bff3fe) Added/removed dirs and files from npmignore
- [be6f51e](../../commit/be6f51e) Adding some tags! Added <svg> and <path>


v0.3.2 - Tue, 15 Mar 2016 00:16:50 GMT
Expand Down
130 changes: 102 additions & 28 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,118 @@
### Tests
# Contributing to react-a11y

All commits that fix bugs or add features need a test.
## Setting up the workspace

`<blink>` Do not merge code without tests.`</blink>`
Before you can submit a Pull Request you'll need to do the following:

### Commit Subjects for Public API Changes
1. Fork the repository on GitHub

If your patch **changes the API or fixes a bug** please use one of the
following prefixes in your commit subject:
2. Clone your fork

- `[fixed] ...`
- `[changed] ...`
- `[added] ...`
- `[removed] ...`
```bash
git clone https://github.com/<your_username>/react-a11y.git
cd react-a11y
```

That ensures the subject line of your commit makes it into the
auto-generated changelog. Do not use these tags if your change doesn't
fix a bug and doesn't change the public API.
3. Install for development

Commits with changed, added, or removed, should probably be reviewed by
another collaborator.
```bash
npm install
```

#### When using `[changed]` or `[removed]`...
## Workflow

Please include an upgrade path with example code in the commit message.
If it doesn't make sense to do this, then it doesn't make sense to use
`[changed]` or `[removed]` :)
Lint the code:

### Docs
```bash
npm run lint
```

Please update the docs with any API changes, the code and docs should
always be in sync.
Run the tests:

### Development
```bash
npm run mocha // run tests using mocha only
npm run karma // run tests using karma only
npm run test // run tests using both mocha and karma
```

- `npm test` will fire up a karma test runner and watch for changes
Build the code:

### Build
```bash
npm run build
```

Please do not include the output of `scripts/build` in your commits, we
only do this when we release. (Also, you probably don't need to build
anyway unless you are fixing something around our global build.)
## Making changes

1. Checkout a new branch and name it accordingly to what you intend to do

```bash
git checkout -b <branch_name>
```

2. Make your intended changes, being sure to run the tests and lint the code.

## Submitting a Pull Request

1. Commit your changes (please make commits small and commit messages descriptive):

```bash
git commit -m "..."
```

2. Push to _your_ github repo:
```bash
git push origin <branch_name>
```

3. Go to the GitHub page and click "New Pull request".
4. Write a good description of the change.

After sending a pull request, other developers will review and discuss your change. Please address all the comments. Once everything is all right, one of the maintainers will merge your changes in.

## Publishing (for maintainers)
_These steps are for maintainers only and can be disregarded by contributors._

For publishing use the following workflow:

1. Make sure all code changes for this new version have already been committed.

2. Update the CHANGELOG.md by using the following command, double check the content and save (don't commit):
```bash
npm run changelog -- -t <the upcoming version>
```
where `<the upcoming version>` refers to the version number that you are preparing to publish

3. Update the version and publish. This is done by running _one_ of the following scripts:

```bash
npm version:patch # for a patch version update i.e. v1.0.0 -> v1.0.1
npm version:minor # for a minor version update i.e. v1.0.0 -> v1.1.0
npm version:major # for a major version update i.e. v.1.0.0 -> v2.0.0
```

### The publishing scripts
After running one of the above `version:*` scripts the following things will take place in this order:

1. the `preversion` script will run which does the following:

1. The tests will be run and the entire process will halt if they do not all pass

2. A check will be performed to validate that the `CHANGELOG.md` has been updated and it is the only uncommitted change in the repo. If this check fails the process will be halted.

2. the selected `version:*` script will run which does the following:

1. The version in `package.json` will be incremented as requested (patch, minor, major). _Because the `--no-git-tag-version` flag is specified this script will not yet include tagging and committing in the github repo._

3. the `postversion` script will be run which does the following:

1. A `git commit` will be made including only the `package.json` and `CHANGELOG.md` files. It will include a commit comment in the format of: "Version $npm_package_version"

2. Performs a `git tag` in the format of "v$npm_package_version"

3. Performs a `git push` and `git push --tags`

4. Runs `npm publish`


## Additional Resources
* [GitHub pull request help](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/)
Loading