https://github.com/linbudulab/vscode-extension-monorepo
Develop VS Code Extensions in Monorepo! (pnpm workspace)
https://github.com/linbudulab/vscode-extension-monorepo
Last synced: 3 months ago
JSON representation
Develop VS Code Extensions in Monorepo! (pnpm workspace)
- Host: GitHub
- URL: https://github.com/linbudulab/vscode-extension-monorepo
- Owner: LinbuduLab
- License: mit
- Created: 2021-11-19T12:32:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-11-21T03:17:30.000Z (over 3 years ago)
- Last Synced: 2025-01-25T11:41:58.929Z (5 months ago)
- Language: TypeScript
- Size: 67.4 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VSCode Extension Monorepo
Develop VS Code extension in pnpm workspace.
> **In fact, I'm just getting started with VS Code Extension, and this template is really just for exploring the various APIs of the extension separately, so if you want to develop fully functional extensions, this template is probably far from adequate, but PR is welcome!**
## Get Started
To use this template, you will need to:
- Update [create-package script](scripts/create-package.ts) content, including `BASE_GITHUB_URL`, `PUBLISHER`, or any propertits you want to customize.
```typescript
const BASE_GITHUB_URL =
"https://github.com/LinbuduLab/vscode-extension-monorepo";
const PUBLISHER = "linbudu599";
```
- Update [LICENSE](LICENSE) content, as in `create-package` execution we copy license file in root to specific package dir, so that we can publish extension by `vsix`,
- Update [launch.json](.vscode/launch.json) content, configuration program should be speficified according to your actual package dir.
```json
{
"version": "0.2.0",
"configurations": [
{
"name": "Launch Extension: Sample",
"type": "extensionHost",
"request": "launch",
"program": "${workspaceFolder}\\packages\\sample\\src\\index.js",
"args": [
"--extensionDevelopmentPath=${workspaceFolder}/packages/sample"
],
"outFiles": ["${workspaceFolder}/packages/sample/**/*.js"]
},
{
"name": "Run Extension Tests",
"type": "extensionHost",
"request": "launch",
"runtimeExecutable": "${execPath}",
"args": [
"--extensionDevelopmentPath=${workspaceFolder}/packages/sample",
"--extensionTestsPath=${workspaceFolder}/packages/sample/test/suite/index"
],
"outFiles": ["${workspaceFolder}/out/test/**/*.js"]
}
]
}
```
- Run command below to build/package/publish your extension.
```bash
pnpm run watch --filter 'sample'
pnpm run pkg --filter 'sample'
pnpm run pub --filter 'sample'
```
## Release workflow
```bash
pnpm add @changesets/cli -DW
pnpm changeset init
pnpm changeset
pnpm changeset version
pnpm install
git add . && git commit -m 'feat: bump!'
pnpm publish -r
```