Skip to content

Commit 05a9dea

Browse files
committed
Switch build instructions and scripts to pnpm
Updated documentation and package.json scripts to use pnpm instead of npm for dependency management and build tasks. Added notes about pnpm workspaces and publishing steps in INSTALL.md to clarify the workflow.
1 parent 0c7266d commit 05a9dea

File tree

3 files changed

+31
-6
lines changed

3 files changed

+31
-6
lines changed

packages/tools/vscode-objectql/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ cd objectql/packages/tools/vscode-objectql
1212

1313
2. Install dependencies:
1414
```bash
15-
npm install
15+
pnpm install
1616
```
1717

1818
3. Open in VS Code:

packages/tools/vscode-objectql/INSTALL.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,28 +10,53 @@ This guide shows how to build and install the ObjectQL VSCode extension.
1010

1111
## Build from Source
1212

13+
⚠️ **Note:** This project uses `pnpm` workspaces. Ensure you are running commands from the root or using strictly `pnpm`.
14+
1315
1. **Navigate to the extension directory:**
1416
```bash
1517
cd packages/tools/vscode-objectql
1618
```
1719

1820
2. **Install dependencies:**
1921
```bash
20-
npm install
22+
pnpm install
2123
```
2224

2325
3. **Compile TypeScript:**
2426
```bash
25-
npm run compile
27+
pnpm run compile
2628
```
2729

2830
4. **Package the extension:**
2931
```bash
30-
npm run package
32+
pnpm run package
3133
```
3234

3335
This creates a `.vsix` file (e.g., `vscode-objectql-0.1.0.vsix`).
3436

37+
## Publishing (Maintainers Only)
38+
39+
To publish a new version to the VS Code Marketplace:
40+
41+
1. **Install vsce:**
42+
```bash
43+
pnpm add -g @vscode/vsce
44+
```
45+
46+
2. **Login to Azure DevOps:**
47+
```bash
48+
vsce login <publisher_id>
49+
```
50+
51+
3. **Publish:**
52+
```bash
53+
# Increment version number automatically
54+
pnpm version patch # or minor, major
55+
56+
# Publish
57+
pnpm run publish
58+
```
59+
3560
## Install the Extension
3661

3762
### Method 1: Install from VSIX (Recommended)

packages/tools/vscode-objectql/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,10 +207,10 @@
207207
}
208208
},
209209
"scripts": {
210-
"vscode:prepublish": "npm run compile",
210+
"vscode:prepublish": "pnpm run compile",
211211
"compile": "tsc -p ./",
212212
"watch": "tsc -watch -p ./",
213-
"pretest": "npm run compile",
213+
"pretest": "pnpm run compile",
214214
"test": "echo 'No tests defined for vscode-objectql extension yet'",
215215
"package": "vsce package",
216216
"publish": "vsce publish"

0 commit comments

Comments
 (0)