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.

Sign up for GitHub

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

Jump to bottom

Incorrect typings for axe.RunOnly #972

Closed
stephenmathieson opened this issue Jun 26, 2018 · 3 comments
Closed

Incorrect typings for axe.RunOnly #972

stephenmathieson opened this issue Jun 26, 2018 · 3 comments
Assignees
@jeeyyy

Comments

@stephenmathieson
Copy link
Member

The TS definitions for axe.RunOnly are incorrect. As suggested by axe-core.org, the runOnly option should have a property values which is an Array of rule IDs. However, in the TS definition, RunOnly is either an Array of TagValues or a RunOnlyObject (which has properties include and exclude, making it look like it belongs to ElementContext, not RunOnly).

It looks like these definitions are built by hand, so if you're all on-board, I'd be happy to fix it.
@dylanb
Copy link
Contributor

dylanb commented Jun 26, 2018

yep, it should always be an Array of Strings which are either tags or rule IDs

jeeyyy added a commit that referenced this issue Jun 26, 2018
@jeeyyy
fix: runOnly interface issue #972
8dcbbb8
@jeeyyy jeeyyy self-assigned this Jun 26, 2018
@jeeyyy jeeyyy mentioned this issue Jun 26, 2018
Merged
7 tasks
@jeeyyy
Copy link
Contributor

jeeyyy commented Jun 26, 2018

PR - #973

@jeeyyy jeeyyy closed this as completed Jun 26, 2018
@marcysutton
Copy link
Contributor

Shouldn't the issue stay open until the PR is merged?

@jeeyyy jeeyyy reopened this Jun 26, 2018
jeeyyy added a commit that referenced this issue Jun 26, 2018
@jeeyyy
fix: typescript interface updates (#973)
f8c9905 
* fix: update type alias to enum for better typing support.

* fix: update type/ inteface names to follow TitleCase.

* fix: runOnly interface issue #972

* fix: revert to type over enum, to avoid breaking change/ major release.
@jeeyyy jeeyyy closed this as completed Jun 26, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jeeyyy jeeyyy

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@dylanb @stephenmathieson @marcysutton @jeeyyy