feat: add vscode package & add jsdoc #160
Merged
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new @unioc/vscode package to support building VSCode extensions with Unioc, updates the monorepo workspace, and adds JS-doc for the BunApp.
- Add
packages/vscodewith build, test, and TypeScript configs plus core extension scaffolding (bootstrap,CommandPlugin,Commanddecorator). - Update
pnpm-workspace.yamlandpackages/unioc/package.jsonto include the new VSCode package. - Enhance
server/web-bunapp with detailed JSDoc compatibility table.
Reviewed Changes
Copilot reviewed 14 out of 15 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| pnpm-workspace.yaml | Include packages/vscode and add @nestjs/core to built deps |
| packages/vscode/vitest.config.ts | Add Vitest config with SWC plugin |
| packages/vscode/tsdown.config.ts | Add tsdown build config with SWC rollup plugin |
| packages/vscode/tsconfig.json | Define TypeScript compiler options for VSCode package |
| packages/vscode/src/plugins/command-plugin.ts | Implement CommandPlugin to register VSCode commands |
| packages/vscode/src/index.ts | Export public APIs (VSCodeBootstrap, Command, CommandPlugin) |
| packages/vscode/src/command.ts | Define @Command decorator and Command interface |
| packages/vscode/src/bootstrap.ts | Provide VSCodeBootstrap base class with activation/deactivation |
| packages/vscode/package.json | Manifest for @unioc/vscode with dependencies and exports |
| packages/vscode/README.md | Basic README pointing to Unioc documentation |
| packages/unioc/package.json | Add workspace dependency on @unioc/vscode |
| packages/server/web-bun/src/app.ts | Add JSDoc table detailing decorator compatibility for BunApp |
| .changeset/fancy-mice-boil.md | Patch changeset for @unioc/vscode README |
| .changeset/easy-humans-sell.md | Initial patch changeset for @unioc/vscode |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
Comments suppressed due to low confidence (1)
packages/vscode/src/plugins/command-plugin.ts:8
- [nitpick] The plugin name prefix
nailyis inconsistent with the package namespace. Consider renaming it to reflect the@unioc/vscodescope, e.g.,unioc:vscode:command-plugin.
name: 'naily:vscode:command-plugin',
| decoratorVersion: '2021-12', | ||
| }, | ||
| }, | ||
| }) as any, |
There was a problem hiding this comment.
Avoid casting the SWC plugin to any. Consider providing the correct plugin type or extending the Vitest config typings instead of using as any.
Suggested change
| }) as any, | |
| }) as ReturnType<typeof swc.vite>, |
Copilot uses AI. Check for mistakes.
| * ### The function to be called before the extension is initialized. | ||
| * | ||
| * 🚄 All extensions will implement this method to run the extension. | ||
| * The sub-extensions normally will helps the user to call the {@linkcode vscode.Extension.activate} method. |
There was a problem hiding this comment.
Minor grammar: change will helps to will help.
Suggested change
| * The sub-extensions normally will helps the user to call the {@linkcode vscode.Extension.activate} method. | |
| * The sub-extensions normally will help the user to call the {@linkcode vscode.Extension.activate} method. |
Copilot uses AI. Check for mistakes.
| @@ -0,0 +1,5 @@ | |||
| --- | |||
| "@unioc/vscode": patch | |||
There was a problem hiding this comment.
There are two patch changesets for @unioc/vscode. Consider consolidating them into a single changeset to avoid conflicting version bumps.
Copilot uses AI. Check for mistakes.
Comment on lines
+1
to
+5
| --- | ||
| "@unioc/vscode": patch | ||
| --- | ||
|
|
||
| feat: first commit |
There was a problem hiding this comment.
Duplicate patch changeset found for @unioc/vscode. Merge with the other changeset to keep releases consistent.
Suggested change
| --- | |
| "@unioc/vscode": patch | |
| --- | |
| feat: first commit | |
| # This changeset file has been removed because its contents were merged into another changeset for `@unioc/vscode`. |
Copilot uses AI. Check for mistakes.
unioc
@unioc/adapter-midway
@unioc/adapter-nestjs
@unioc/commander
create-unioc
@unioc/core
@unioc/decorator
@unioc/meta
@unioc/reflector
@unioc/shared
@unioc/web
@unioc/web-bun
@unioc/web-express
@unioc/web-koa
commit: |
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.
No description provided.