Skip to content

docs(swc_es_ast): add typescript-eslint AST compatibility note#11598

Merged
kdy1 merged 1 commit intomainfrom
kdy1/docs-swc-es-ast-typescript-eslint-compat
Feb 28, 2026
Merged

docs(swc_es_ast): add typescript-eslint AST compatibility note#11598
kdy1 merged 1 commit intomainfrom
kdy1/docs-swc-es-ast-typescript-eslint-compat

Conversation

@kdy1
Copy link
Copy Markdown
Member

@kdy1 kdy1 commented Feb 28, 2026

Summary

  • add a note to crates/swc_es_ast/AGENTS.md
  • document that swc_es_ast should remain compatible with the typescript-eslint AST

Testing

  • not run (documentation-only change)

@kdy1 kdy1 requested a review from a team as a code owner February 28, 2026 23:50
Copilot AI review requested due to automatic review settings February 28, 2026 23:50
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Feb 28, 2026

⚠️ No Changeset found

Latest commit: ffea2f8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@kdy1 kdy1 merged commit c7bfebe into main Feb 28, 2026
23 checks passed
@kdy1 kdy1 deleted the kdy1/docs-swc-es-ast-typescript-eslint-compat branch February 28, 2026 23:51
@github-actions github-actions Bot added this to the Planned milestone Feb 28, 2026
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Feb 28, 2026

PR Review

Summary: Documentation-only change adding a compatibility note to crates/swc_es_ast/AGENTS.md.

Assessment

This is a clean, minimal documentation change. The added note that swc_es_ast should remain compatible with the typescript-eslint AST is a valuable instruction for AI agents and contributors working in this crate — it establishes an important design constraint that helps prevent accidental breaking changes.

Code quality: Good. The note follows the existing bullet-point style of the file.

No concerns regarding bugs, performance, security, or test coverage — this is purely a documentation change and correctly skips testing.

LGTM.

Copilot AI reviewed Feb 28, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds documentation guidance for swc_es_ast to remain compatible with the typescript-eslint AST, clarifying an expected compatibility constraint for this crate.

Changes:

  • Added a note in crates/swc_es_ast/AGENTS.md stating swc_es_ast should remain compatible with the typescript-eslint AST.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 28, 2026

Binary Sizes

File Size
swc.linux-x64-gnu.node 28M (28742088 bytes)

Commit: 66aaf4c

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented Mar 1, 2026

Merging this PR will not alter performance

✅ 190 untouched benchmarks

Comparing kdy1/docs-swc-es-ast-typescript-eslint-compat (ffea2f8) with main (f11fd70)

Open in CodSpeed

@github-actions github-actions Bot modified the milestones: Planned, 1.15.18 Mar 1, 2026
@swc-project swc-project locked as resolved and limited conversation to collaborators Mar 31, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

No one assigned

Labels

None yet

Milestone

1.15.18

Development

Successfully merging this pull request may close these issues.

2 participants

@kdy1