feat(tools): consolidate development tool installations into unified script [skip ci] #7530
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
We can try this out if you like it. It works OK for me. I'm glad to have the linkchecker and pyspelling available now for when I need them, was never able to get a reliable install before. |
stasadev
requested changes
Aug 15, 2025
.editorconfig
Outdated
Comment on lines
20
to
23
| # Script files | ||
| [*.sh] | ||
| indent_size = 2 | ||
|
|
There was a problem hiding this comment.
Recommended by:
- Google https://google.github.io/styleguide/shellguide.html#indentation
- GoatStyles https://styles.goatbytes.io/lang/shell/
And ChatGPT recommends 2 spaces.
There was a problem hiding this comment.
I didn't even realize that .editorconfig was changed here. I prefer 2.
There was a problem hiding this comment.
I added this to .editorconfig. My IDE uses 2 spaces by default, but declaring a rule for this is better.
## The Issue DDEV's development requires specialized tools like pyspelling, textlint, markdownlint, mkdocs, and linkspector. Currently, .envrc installs these per-project, causing overhead and slow startup. Tools are rarely used for link checking locally due to performance issues. ## How This Commit Solves The Issue ### Unified Installation Script - Created scripts/install-dev-tools.sh for one-time global installation to ~/.ddev-dev-tools/ - Supports macOS (brew) and Linux (apt) with automatic platform detection - Dynamically fetches mkdocs requirements from repository to stay current - Installs all tools: mkdocs, pyspelling, markdownlint, textlint, linkspector, aspell ### Optimized .envrc - Removed 80+ lines of per-project tool installation code - Now simply adds global tools to PATH when available - Shows helpful prompts with installation instructions when tools are missing - Executes instantly instead of checking/installing tools on every cd ### Focused Link Checking - Added make linkspector-changed - checks only files modified since main branch - Added make linkspector-dir DIR=path/ - checks specific directory - Keeps make linkspector for full CI-compatible checking - Makes link checking practical for local development workflows ### Updated Documentation - Updated docs/content/developers/building-contributing.md with unified installation approach - Updated docs/content/developers/testing-docs.md with focused linkspector usage - Clear distinction between automatic .envrc integration vs global shell profile setup ## Implementation Details **Installation Script Features:** - Cross-platform support (macOS/Linux/WSL2) - Virtual environments for Python and Node.js isolation - Fetches latest mkdocs requirements from repository - Comprehensive verification and helpful error messages **PATH Management:** - .envrc automatically adds tools when in DDEV directory - Optional global access via shell profile modification - Graceful fallback with clear installation guidance **Performance Benefits:** - One-time setup instead of per-project overhead - .envrc execution time reduced from seconds to milliseconds - Tools remain current via repository-sourced requirements 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
…nces - Added textlint-disable comments around link text that legitimately uses 'Golang' - This preserves the original link titles while avoiding false positives from terminology rules 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
…uildkite] The installation instructions for documentation development tools should only be in testing-docs.md since that's specifically about working on documentation. Removed the duplicate section from building-contributing.md to avoid confusion. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
…p ci] 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
36da68c to
26b3b6d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Issue
DDEV's development, especially for docs, requires specialized tools like pyspelling, textlint, markdownlint, mkdocs, and linkspector. Currently, .envrc installs these per-project, causing overhead and slow startup. Tools are rarely used for link checking locally due to performance issues.
How This PR Solves The Problem
Unified Installation Script
Optimized .envrc
Focused Link Checking
Updated Documentation
Implementation Details
Installation Script Features:
PATH Management:
Performance Benefits:
🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com