build(docs-gen): add extension name extractor#1150
Draft
makhnatkin wants to merge 2 commits into
Draft
Conversation
Reviewer's GuideIntroduces a TypeScript‑AST–based extractor for editor extension names used by docs generation, wires it into the docs-gen package with scripts and dependencies, and adds tests for the extraction and blacklist behavior. File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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 changed
Adds the first, deliberately small version of the docs-gen extension extractor. This PR extracts only one field:
name.The output shape is already future-proofed for follow-up PRs:
{ "extensions": [ {"name": "Bold"} ] }Architecture
The extractor is split by responsibility so later PRs can add fields without reshaping the generator:
src/extract-extension-data.mjs- CLI entry point.src/extractor/config.mjs- repository paths and extension entry points.src/extractor/blacklist.mjs- internal and public extension skip lists.src/extractor/entry-points.mjs- converts configured entry points into extension refs and applies the blacklist.src/extractor/source-files.mjs- reads TS/TSX sources for an extension ref.src/extractor/ast/- TypeScript AST primitives and source scanners.src/extractor/fields/- one field controller per extracted field; currently onlyname.src/extractor/field-config.mjs- active output field registry; currently onlyname.src/extractor/index.mjs- orchestration.src/extractor/output.mjs- writestmp/docs-gen/extensions.json.src/extractor/README.md- module map and extension instructions.Blacklist
The PR includes an explicit blacklist:
BaseInputRulesBaseKeymapBaseStylesReactRendererSharedStateYfmCutValidation
git diff --check origin/mainpassed.AGENTS.mdrequires Docker/Podman, andpodman machine startreported success butpodman machine inspectimmediately showedState: stopped;podman infofailed with connection refused.