Skip to content

Commit fac1d49

Browse files
authored
chore: provide workspace-based npm commands instead of lerna ones in README (#1465)
1 parent 938c3c1 commit fac1d49

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,8 @@ variable. For detailed instructions for each of our supported platforms, please
109109
### Install
110110

111111
```shell
112-
npm install -g lerna
113-
npm install -g typescript
114112
npm run bootstrap
113+
npm run compile-cli
115114
```
116115

117116
### Running Tests
@@ -125,31 +124,28 @@ npm test
125124
Run tests from a specific package:
126125

127126
```shell
128-
lerna run test --scope @mongosh/cli-repl
129-
```
130-
131-
Run tests with all output from packages:
132-
133-
```shell
134-
lerna run test --stream
127+
npm -w @mongosh/cli-repl run test
135128
```
136129

137130
To test against a specific version, the `MONGOSH_SERVER_TEST_VERSION`
138-
environment variable can be set to a semver string specifying a server version.
131+
environment variable can be set to a semver string specifying a server version,
132+
e.g. `MONGOSH_SERVER_TEST_VERSION='>= 7.0.0-rc0' npm -w @mongosh/cli-repl run test`.
139133

140134
### Starting the CLI
141135

142136
Via npm:
143137

144138
```shell
145-
npm run start
139+
npm run start <... connection string, CLI args, etc.>
146140
```
147141

142+
This will compile all Typescript dependencies of the CLI package first.
143+
148144
Alternatively you can also run start inside the `cli-repl` package, if you're
149145
sure everything else is compiled:
150146

151147
```shell
152-
cd packages/cli-repl && npm run start
148+
npm run -w @mongosh/cli-repl start <... connection string, CLI args, etc.>
153149
```
154150

155151
### Compiling
@@ -160,7 +156,7 @@ Compile all Typescript:
160156
npm run compile-ts
161157
```
162158

163-
Compile just the CLI:
159+
Compile just the CLI ands its dependencies:
164160

165161
```shell
166162
npm run compile-cli

0 commit comments

Comments
 (0)