Skip to content

fix: refine tsgo docs and type checker log#80

Merged
chenjiahan merged 2 commits into
mainfrom
david/docs-tsgo-default-comment
Jun 10, 2026
Merged

fix: refine tsgo docs and type checker log#80
chenjiahan merged 2 commits into
mainfrom
david/docs-tsgo-default-comment

Conversation

@Timeless0911

@Timeless0911 Timeless0911 commented Jun 9, 2026

Copy link
Copy Markdown
Member

This PR clarifies in the README default options snippet that the regular TypeScript checker is used by default. It also refines the production type-checker log so both regular TypeScript and tsgo modes still announce that type checking is enabled, while only the regular TypeScript path keeps the It may take some time message and suggests enabling typescript.tsgo for faster checks.

@Timeless0911 Timeless0911 requested a review from chenjiahan June 9, 2026 05:46
@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Two small changes: README.md adds a note in the default TypeScript configuration that the plugin uses the TypeScript checker by default; src/index.ts updates the production build path to log one of two logger.info messages depending on whether mergedOptions.typescript?.tsgo is set.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description clearly relates to the changeset, explaining the README clarification and conditional logging logic for TypeScript and tsgo modes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title accurately reflects the main changes: refining TypeScript-go (tsgo) documentation and updating the type checker log message based on tsgo configuration.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch david/docs-tsgo-default-comment

Comment @coderabbitai help to get the list of available commands and usage tips.

@Timeless0911 Timeless0911 changed the title docs: clarify default tsgo setting chore: refine tsgo docs and type checker log Jun 10, 2026
@chenjiahan chenjiahan changed the title chore: refine tsgo docs and type checker log fix: refine tsgo docs and type checker log Jun 10, 2026
@chenjiahan chenjiahan merged commit eebe3d8 into main Jun 10, 2026
6 checks passed
@chenjiahan chenjiahan deleted the david/docs-tsgo-default-comment branch June 10, 2026 03:40
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