feat: automate fetching and sanitization of webpack ecosystem readmes#122
feat: automate fetching and sanitization of webpack ecosystem readmes#122ryzrr wants to merge 6 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
@avivkeller PTAL! |
There was a problem hiding this comment.
Pull request overview
Adds an automation script to pull README content from webpack/* loader and plugin repositories, lightly sanitize/normalize it, and emit Markdown pages that can be consumed by the existing doc generation pipeline.
Changes:
- Introduce
scripts/fetch-readmes.mjsto discover repos in thewebpackorg and fetch/write README-based docs. - Wire the new script into
package.jsonnpm scripts (includingbuild). - Ignore generated
pages/loadersandpages/pluginsoutput directories.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| scripts/fetch-readmes.mjs | New GitHub API fetch + README sanitization + page generation script for loaders/plugins. |
| package.json | Adds build targets for fetching readmes and runs them as part of npm run build. |
| .gitignore | Ignores generated loaders/plugins pages. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Implemented few fixups and additional changes. |
| const GFM_ALERT_LABELS = { | ||
| NOTE: 'Note', | ||
| TIP: 'Tip', | ||
| IMPORTANT: 'Important', | ||
| WARNING: 'Warning', | ||
| CAUTION: 'Caution', | ||
| }; | ||
| const GFM_ALERT_RE = | ||
| /^([ \t]*>[ \t]*)\[!(NOTE|TIP|IMPORTANT|WARNING|CAUTION)\][ \t]*$/gim; | ||
|
|
||
| const transformGfmAlerts = content => | ||
| content.replace( | ||
| GFM_ALERT_RE, | ||
| (_, prefix, type) => `${prefix}**${GFM_ALERT_LABELS[type]}:**` | ||
| ); |
|
Thanks for the additional PRs , fixing merge conflicts of this PR ! |
Co-authored-by: Aviv Keller <me@aviv.sh>
|
I can investigate the failure more if needed tomorrow, but Vercel is having an issue resolving import |
Sure , Actually , i tried looking for the issue but was unable to caught . But i'll also look one more time today |
|
@avivkeller can you please help me fix out the vercel error in your free time . as I cant see exactly what error is causing the build to fail |
|
@ryzrr looks like sanitization is having some issues on:
Also, it looks like some local links in those files aren't working |
|
I think some of these issues can be resolved on the README-end, just let me know what you think |
|
Yes I also think we should handle it on the readme level as major of them follows nearly same structure , only a few deviates from it |
|
No reviews from my sides, look great ! |
Issue Link : #103
Summary
Introduced
fetch-readmes.mjswhich fetches the readme of all loaders and plugins present in the webpack org and passes the md file to pipeline to generate the documentation.What kind of change does this PR introduce?
New Feature (Build/Automation Script).
Did you add tests for your changes?
NO
Does this PR introduce a breaking change?
NO
If relevant, what needs to be documented once your changes are merged or what have you already documented?
NA
Use of AI
Yes, for testing and refinement of the regex and sanitization logic