discord-api-docs icon indicating copy to clipboard operation
discord-api-docs copied to clipboard

Improve local link checking.

Open Mehgugs opened this issue 1 year ago • 3 comments

Adds some npm boilerplate to make local link checking easier.

Mehgugs avatar Jul 25 '22 20:07 Mehgugs

changing "npm install" to run a different command seems like a bad idea

advaith1 avatar Jul 26 '22 03:07 advaith1

it doesn't run a different command it, just runs alongside the normal package install, although I'm not sure about which goes first; "postinstall" would be better here for both semantics and ensuring it runs after install

splatterxl avatar Jul 26 '22 05:07 splatterxl

I like the idea of making it easier to test links locally, but I agree with @advaith1 that npm install shouldn't be modified here. Also with this, npm run build would be run twice in the Github workflow.

For this kinda thing, could see a pre-commit or pre-push hook being helpful, but that may just be overdoing it. we can also just add instruction on the readme to run npm run build && npm run test:links without modifying the package.json scripts.

shaydewael avatar Aug 27 '22 00:08 shaydewael

Closing since this appears to be stale

appellation avatar Jan 10 '23 22:01 appellation