Skip to content

Commit 2284469

Browse files
Update documentation (microsoft#79)
Description of changes Includes minor documentation updates to `CONTRIBUTING.md` and `update-toolkit-package.js`.
1 parent 8ee2226 commit 2284469

File tree

2 files changed

+22
-8
lines changed

2 files changed

+22
-8
lines changed

CONTRIBUTING.md

-8
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,6 @@ git remote add upstream https://github.com/microsoft/vscode-webview-ui-toolkit-s
4242
git fetch upstream main
4343
```
4444

45-
### Install dependencies
46-
47-
Install the project dependencies.
48-
49-
```
50-
npm install
51-
```
52-
5345
### Create a branch
5446

5547
Create a branch for local development. Once that is complete, you can start making your changes locally.

scripts/update-toolkit-package.js

+22
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,28 @@ const execShellCommand = util.promisify(exec);
1111
*
1212
* Run `node scripts/update-toolkit-package.js` from the root directory
1313
* of this repository.
14+
*
15+
* Updating the script:
16+
*
17+
* To update this script to include a new directory, add a new call to the
18+
* `installLatestToolkitPackage` function within the `main` function below.
19+
*
20+
* Rule of thumb:
21+
*
22+
* You should probably only update this script if new samples are being created
23+
* using a new web framework (this should be rare).
24+
*
25+
* If that is the case, however, a root level directory should have been added
26+
* with the name of the web framework. The extension architecture should have
27+
* also followed the conventions of other extensions––meaning the `@vscode/webview-ui-toolkit`
28+
* package should be installed within a `webview-ui` directory.
29+
*
30+
* Assuming all of the above holds true, you should be able to simply update this
31+
* script by including a new call to the `installLatestToolkitPackage` function
32+
* with the following syntax:
33+
*
34+
* `await installLatestToolkitPackage('name-of-framework-dir', 'webview-ui');`
35+
*
1436
*/
1537
async function main() {
1638
console.log('Updating toolkit package to latest version...');

0 commit comments

Comments
 (0)