[Docs] Add infrastructure for auto-generating markdown table and list #837
Conversation
- 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
Codecov Report
@@ Coverage Diff @@
## main #837 +/- ##
=======================================
Coverage 99.22% 99.22%
=======================================
Files 98 98
Lines 1419 1419
Branches 479 479
=======================================
Hits 1408 1408
Misses 11 11
Continue to review full report at Codecov.
|
.github/workflows/readme.yml
Outdated
| name: 'nvm install lts/* && npm install' | ||
| with: | ||
| node-version: 'lts/*' | ||
| - run: npm run generate-list-of-rules:check No newline at end of file |
There was a problem hiding this comment.
trailing newline (reminder for myself)
| export default ({ | ||
| meta: { | ||
| docs: {}, | ||
| docs: { description: 'Enforce that a `label` tag has a text label and an associated control.' }, |
There was a problem hiding this comment.
should we add meta.docs.url here, as well, to match the others?
There was a problem hiding this comment.
Done. I've updated the README markdown, too😄.
ljharb
left a comment
ljharb
left a comment
There was a problem hiding this comment.
Looks great! Other than the missing description, I can take care of the rest during the final rebase, if you'd prefer.
package.json
Outdated
| "@babel/core": "^7.17.5", | ||
| "@babel/register": "^7.17.0" |
There was a problem hiding this comment.
these should be alphabetized (edit: @ comes first tho)
ljharb
left a comment
ljharb
left a comment
There was a problem hiding this comment.
Thanks! I'll get this rebased and landed :-)
ljharb
force-pushed
the
auto-generate-markdown-table-content
branch
from
f027dec to
9980d1d
Compare
2 participants
Description
This PR adds infrastructure to keep a11y rules in the
/rulesfolder in sync with theREADMEmarkdown content. It generates markdown list and table programmatically and makes sure their contents are kept up-to-date.Related Issue
Closes #836
Acceptance Criteria
markdown-magicREADMElist and table are generated programmaticallyREADMElist and table are kept in sync with a11y rules in the /rules folder. Every time a new a11y rule is added to /rules folder ,READMElist and table contents are refreshed programmaticallyType of Changes
Testing Steps / QA Criteria
npm installto install project dependenciesREADMEtable and list but keep in place theAUTO-GENERATED-CONTENTmarkers tellingmarkdown-magicto generate table and list contentsnpm generate-list-of-rulesto auto-generate the table and list contentsnpm generate-list-of-rulesto refresh the table and list contents