Skip to content

Infrastructure for keeping a11y rules folder content in sync with README markdown content #836

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
Closed
uncommon-type opened this issue Feb 28, 2022 · 0 comments · Fixed by #837
Closed

Infrastructure for keeping a11y rules folder content in sync with README markdown content #836

uncommon-type opened this issue Feb 28, 2022 · 0 comments · Fixed by #837
Labels
documentation

Comments

@uncommon-type
Copy link
Contributor

AC:

  • README Supported Rules list and Rule strictness in different modes table should be generated programmatically
  • The list and table should be kept in sync with a11y rules in the /rules folder. Every time a new a11y rule is added to /rules folder , README list and table content should be refreshed programmatically
uncommon-type added a commit to uncommon-type/eslint-plugin-jsx-a11y that referenced this issue Feb 28, 2022
@uncommon-type
[Docs] Add infrastructure for auto-generating markdown table and list
8d8efff 
- Add readme.yml file to ensure table and list markdown content is
auto-generated from rules folder
- Add md-magic dependency and scripts to package.json for updating
readme markdown
- Add markdown.config.js file to add transformation functions to the
transforms object
- Add scripts to README markdown to keep documentation content in sync
with readme
- Disable `no-console` rule in markdown.config file in .eslintrc
- Add errorOptions property to source files for rules with extra options

Closes jsx-eslint#836
@uncommon-type uncommon-type mentioned this issue Feb 28, 2022
Merged
3 tasks
@ljharb ljharb closed this as completed in 9980d1d Mar 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
2 participants
@ljharb @uncommon-type