You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-70Lines changed: 8 additions & 70 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,87 +32,25 @@ Here are a few things you can do that will increase the likelihood of your pull
32
32
Make sure you have a fairly recent version of vscode (>1.32) and are using nodejs
33
33
version >=v10.13.0. (Tested on v10.15.1 and v10.16.0).
34
34
35
-
This repo uses [Rush](https://rushjs.io) to handle package management, building, and other
36
-
operations across multiple projects. See the Rush "[Getting started as a developer](https://rushjs.io/pages/developer/new_developer/)" docs
37
-
for more details.
35
+
### Installing all packages
38
36
39
-
If you plan on building from the command line, it's easiest if Rush is installed globally:
37
+
From the command line, go to the directory `extensions/ql-vscode` and run
40
38
41
39
```shell
42
-
npm install -g @microsoft/rush
40
+
npm install
43
41
```
44
42
45
-
To get started, run:
43
+
### Building the extension
46
44
47
-
```shell
48
-
rush update && rush build
49
-
```
50
-
51
-
Note that when you run the `rush` command from the globally installed version, it will examine the
52
-
`rushVersion` property in the repo's `rush.json`, and if it differs from the globally installed
53
-
version, it will download, cache, and run the version of Rush specified in the `rushVersion`
54
-
property.
55
-
56
-
A few more things to know about using rush:
57
-
58
-
* Avoid running `npm` for any commands that install/link dependencies
59
-
* Instead use the *rush* equivalent: `rush add <package>`, `rush update`, etc.
60
-
* If you plan on only building via VS Code tasks, you don't need Rush installed at all, since those
61
-
tasks run `common/scripts/install-run-rush.js` to bootstrap a locally installed and cached copy of
62
-
Rush.
63
-
64
-
### Building
65
-
66
-
#### Installing all packages (instead of `npm install`)
67
-
68
-
After updating any `package.json` file, or after checking or pulling a new branch, you need to
69
-
make sure all the right npm packages are installed, which you would normally do via `npm install` in
70
-
a single-project repo. With Rush, you need to do an "update" instead:
71
-
72
-
##### From VS Code
73
-
74
-
`Terminal > Run Task... > Update`
75
-
76
-
##### From the command line
77
-
78
-
```shell
79
-
rush update
80
-
```
81
-
82
-
#### Building all projects (instead of `gulp`)
83
-
84
-
Rush builds all projects in the repo, in dependency order, building multiple projects in parallel
85
-
where possible. By default, the build also packages the extension itself into a .vsix file in the
86
-
`dist` directory. To build:
87
-
88
-
##### From VS Code
89
-
90
-
`Terminal > Run Build Task...` (or just `Ctrl+Shift+B` with the default key bindings)
91
-
92
-
##### From the command line
93
-
94
-
```shell
95
-
rush build --verbose
96
-
```
97
-
98
-
#### Forcing a clean build
99
-
100
-
Rush does a reasonable job of detecting on its own which projects need to be rebuilt, but if you need to
101
-
force a full rebuild of all projects:
102
-
103
-
##### From VS Code
104
-
105
-
`Terminal > Run Task... > Rebuild`
106
-
107
-
##### From the command line
45
+
From the command line, go to the directory `extensions/ql-vscode` and run
108
46
109
47
```shell
110
-
rush rebuild --verbose
48
+
npm run build
111
49
```
112
50
113
-
Note that `rush rebuild` performs a complete rebuild, whereas `rush build` performs an incremental build and in many cases will not need to do anything at all.
51
+
Alternatively, you can build the extension within VS Code via `Terminal > Run Build Task...` (or `Ctrl+Shift+B` with the default key bindings).
114
52
115
-
### Installing
53
+
### Installing the extension
116
54
117
55
You can install the `.vsix` file from within VS Code itself, from the Extensions container in the sidebar:
0 commit comments