Skip to content

chore: replace inline link-checker scripts with ethersphere submodule#790

Open
NoahMaizels wants to merge 3 commits intomasterfrom
chore/link-checker-submodule
Open

chore: replace inline link-checker scripts with ethersphere submodule#790
NoahMaizels wants to merge 3 commits intomasterfrom
chore/link-checker-submodule

Conversation

@NoahMaizels
Copy link
Copy Markdown
Collaborator

Summary

  • Removes scripts/check_links.py and scripts/check_live_links.py (2131 lines)
  • Forks NoahMaizels/docusaurus-link-checker to ethersphere/docusaurus-link-checker and adds it as a git submodule at tools/docusaurus-link-checker
  • Updates check:links npm script to point at the submodule
  • Adds build:check convenience script (build + link check in one command)
  • Documents submodule init, all supported flags, and usage examples in README

Usage after this PR

# initialise submodule after a fresh clone
git submodule update --init

# run link checker (will prompt for local/live mode)
npm run check:links

# pass flags through
npm run check:links -- --mode live --site-domain docs.ethswarm.org
npm run check:links -- --mode local --no-external --threads 16

# build + check in one step
npm run build:check

Test plan

  • Fresh clone → git submodule update --initnpm run check:links launches the checker
  • npm run check:links -- --mode local --no-external skips external URLs
  • npm run build:check runs a full build then launches the checker
  • scripts/check_links.py and scripts/check_live_links.py no longer exist

🤖 Generated with Claude Code

Moves the two link-checker Python scripts out of scripts/ and into the
canonical ethersphere/docusaurus-link-checker submodule at
tools/docusaurus-link-checker. Updates check:links npm script to point
at the submodule, adds a build:check convenience script, and documents
usage (flags, submodule init) in README.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify bot commented Apr 7, 2026

Deploy Preview for test-twitter-preview-testing-3 ready!

Name Link
🔨 Latest commit aaaefde
🔍 Latest deploy log https://app.netlify.com/projects/test-twitter-preview-testing-3/deploys/69d4bc800915bf000752d735
😎 Deploy Preview https://deploy-preview-790--test-twitter-preview-testing-3.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

NoahMaizels and others added 2 commits April 7, 2026 15:11
Using `npm run check:links` in the chain doesn't forward extra args
correctly — npm's `--` passthrough only appends to the outermost
command, so flags would land on `npm run` not on the python script.
Call python directly so `npm run build:check -- --mode live` works.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Adds precheck:links hook so npm run check:links always pulls the latest
submodule commit before running.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant