Skip to content

Remove API Extractor minor-version restriction [skip chg] - #12043

Open
Jialin Huang (JialinHuang803) wants to merge 1 commit into
microsoft:mainfrom
JialinHuang803:jialinhuang803-api-extractor-range
Open

Jialin Huang (JialinHuang803) wants to merge 1 commit into
microsoft:mainfrom
JialinHuang803:jialinhuang803-api-extractor-range

Conversation

@JialinHuang803

Copy link
Copy Markdown
Member

Summary

Restore the @microsoft/api-extractor catalog range from ~7.58.1 to ^7.58.1 and synchronize the matching lockfile catalog specifier. The resolved version remains 7.58.13; every other lockfile entry is unchanged. No source, tests, or other dependencies change.

Context

#11643 introduced the minor-version restriction. Azure/typespec-azure#5370 describes a downstream Spector harness dependency on private ExtractorConfig._defaultConfig, removed in API Extractor 7.59.0. Azure/typespec-azure#5212 already replaced that access with public ExtractorConfig.loadFile via a temporary JSON file, but retained the restriction.

This is the upstream prerequisite for Azure/typespec-azure#5563: its Versions consistency check requires the Azure catalog to match the core submodule exactly. The downstream core pointer will be advanced separately after this PR merges. This PR does not close the Azure issue.

An upstream tracked-source search found no _defaultConfig access. The programmatic API Extractor consumer in packages/tspd/src/ref-doc/api-extractor.ts uses public ExtractorConfig.prepare and Extractor.invoke. No remaining pin-specific blocker was found in the repository, original PR discussion, or open API Extractor issues.

Validation

  • Passed frozen-lockfile dependency installation with scripts disabled; pnpm reported the lockfile was up to date and skipped resolution.
  • Passed pnpm run check-lockfile, pnpm lint, and git diff --check.
  • Passed YAML parsing and assertions that both files differ only by the requested range, the catalog specifiers agree, and the locked version is still 7.58.13.
  • Passed a focused Prettier check of pnpm-workspace.yaml using the repository formatting options, omitting unrelated plugins. pnpm-lock.yaml is excluded by .prettierignore.
  • pnpm run check-catalog is blocked by an existing Windows path-separator issue: its packages/typespec-vscode/package.json exception does not match the computed backslash path, so the existing explicit @types/vscode version is reported. No unrelated fix is included.
  • Full pnpm format is blocked by the unbuilt local TypeSpec Prettier plugin (packages/prettier-plugin-typespec/dist/index.js). Full builds and tests were not run for this range-only change.

These checks do not validate API Extractor 7.59.0 or any newer resolved version. [skip chg] uses the repository's supported changelog-check exemption for this development dependency range-only change.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

No unresolved review issues remain, and the locked version is unchanged.

Review effort: Lite
Findings: None

What changed in this PR

Broadens the API Extractor catalog range while retaining the resolved version 7.58.13.

Changes:

  • Changes the catalog range from ~7.58.1 to ^7.58.1.
  • Synchronizes the lockfile catalog specifier.
File Description
pnpm-workspace.yaml Updates the API Extractor catalog range.
pnpm-lock.yaml Synchronizes the catalog specifier without changing resolution.
Files not reviewed (1)
  • pnpm-lock.yaml: Generated file

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@azure-sdk-automation

Copy link
Copy Markdown

You can try these changes here

🛝 Playground 🌐 Website 🛝 VSCode Extension

This branch has not been deployed

No deployments
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.

2 participants