Remove typedoc from cli-kit (drop unused API-docs generation)#7723
Draft
amcaplan wants to merge 1 commit into
Draft
Remove typedoc from cli-kit (drop unused API-docs generation)#7723amcaplan wants to merge 1 commit into
amcaplan wants to merge 1 commit into
Conversation
Co-Authored-By: Claude <noreply@anthropic.com>
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
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.
What & why
typedocis a dev/doc-only devDependency in@shopify/cli-kitwhose only consumer is an API-docs generator (packages/cli-kit/scripts/build-api-docs.js). A Round-1 investigation found the generated API docs are unlinked and unindexed, and normal PR / main / release CI never invoke typedoc. The dependency nonetheless drives recurring Dependabot churn — 35 version bumps over the last 24 months. This PR removestypedocand its unused API-docs generation pipeline.This PR removes the cli-kit API-docs (TSDoc) generation capability. The docs it produced were unlinked/unindexed, so we believe nothing depends on them — but if those generated API docs ARE wanted, please object here and we'll restore the pipeline. The hand-written docs published to GitHub Pages (
docs/cli/*,docs/cli-kit/*,docs/decision-record/*) are NOT affected —pages.ymlstill builds and deploys them.What is removed
typedocdevDependency frompackages/cli-kit/package.json(+pnpm-lock.yamlrefresh).packages/cli-kit/scripts/build-api-docs.js— the sole typedoc importer.build-api-docsandopen-api-docsnx targets (packages/cli-kit/project.json) and the matching cli-kitpackage.jsonscripts.build-api-docsscript + the now-staledocs/api/cli-kit/**/*.jsknip entry (and the now-staleopenknipignoreBinariesentry for cli-kit, which only the removedopen-api-docscommand used)..github/workflows/pages.yml, plus thepackages/cli-kit/package.jsonpush-path trigger (its sole purpose was triggering typedoc regen). Jekyll build + GitHub Pages deploy of the hand-written./docssite are kept fully intact.Validation (local, on this branch)
pnpm --filter @shopify/cli-kit build→ ✅ greenpnpm --filter @shopify/cli-kit type-check→ ✅ greenpnpm --filter @shopify/cli-kit lint→ ✅ greenpnpm knip→ ✅ exit 0 (no new findings)pnpm --filter @shopify/cli-kit exec vitest run→ 1408 passed, 2 skipped. 4 failures inbase-command.test.ts > removeDuplicatedPluginsare pre-existing onmain(verified against a clean tree) and unrelated to this change, which touches no source/test files.typedoc/build-api-docs/open-api-docs/TypeDoc→ no matches.Changeset
None — removing a devDependency is invisible to consumers of the published package (devDeps are stripped on publish), and no CI gate requires one.
🤖 Automated dependency-removal initiative — AI-generated draft, needs human review.