Skip to content

Commit

Permalink
Updated scripts and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bmingles committed Nov 1, 2024
1 parent 451ad80 commit 0f91e8c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ To run using `vscode` debugger:

4. You should see the tests start and `vscode` stop at the breakpoint.

## VSCE
[vsce](https://github.com/microsoft/vscode-vsce), short for "Visual Studio Code Extensions", is a command-line tool for packaging, publishing and managing VS Code extensions. The Deephaven extension calls `vsce` via npm scripts. Note that `vsce package` and `vsce publish` both call the `vscode:prepublish` script.

## Installation from .VSIX

This extension can also be installed directly from a `.vsix`. To get a `.vsix`, you can either:
Expand All @@ -52,7 +55,7 @@ Download one from the [releases/](releases/) folder.

or

Build a .vsix locally via `npm run package:latest`
Build a .vsix locally via `npm run package:latest` (see [VSCE](#vsce) section)

Then install in vscode:
![Install Deephaven in VS Code](docs/install.png)
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
"check:types": "npm run clean && tsc --build ./tsconfig.json && tsc -p tsconfig.unit.json --noEmit --module preserve --moduleResolution bundler && tsc -p e2e/tsconfig.json --noEmit --skipLibCheck",
"clean": "rm -rf out packages/*/tsconfig.tsbuildinfo",
"compile": "npm run check:types && node scripts/esbuild.js",
"compile:prod": "npm run check:types && npm run test:lint && node scripts/esbuild.js --production",
"icon:gen": "node icons/generate.mjs",
"package:latest": "vsce package -o releases/vscode-deephaven-latest.vsix",
"publish:prerelease": "vsce publish --pre-release",
Expand All @@ -45,7 +46,7 @@
"test:lint": "eslint . --ext ts",
"test:unit": "vitest --reporter=default --reporter=junit --outputFile=./test-reports/vitest.junit.xml",
"test": "npm run test:unit",
"vscode:prepublish": "npm run check:types && npm run test:lint && node scripts/esbuild.js --production",
"vscode:prepublish": "compile:prod",
"watch:esbuild": "node scripts/esbuild.js --watch",
"watch:tsc": "npm run clean && tsc --build ./tsconfig.json --watch",
"watch": "npm-run-all -p watch:*"
Expand Down

0 comments on commit 0f91e8c

Please sign in to comment.