Skip to content

Commit 69cdf74

Browse files
[DOC] switch from yarn to pnpm (#3863)
## Description of changes *Summarize the changes made by this PR.* - Improvements & Bug fixes - ... - New functionality - ... ## Test plan *How are these changes tested?* - [ ] Tests pass locally with `pytest` for python, `yarn test` for js, `cargo test` for rust ## Documentation Changes *Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the [docs repository](https://github.com/chroma-core/docs)?*
1 parent f0c36a4 commit 69cdf74

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

clients/js/DEVELOP.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,24 @@ environment:
1919

2020
To get started developing on the JS client libraries, you'll want to run the examples.
2121

22-
1. `yarn` to install deps.
23-
1. `yarn build` to build the library.
22+
1. `pnpm install` to install deps.
23+
1. `pnpm build` to build the library.
2424
1. `cd examples/browser` or `cd examples/node`
25-
1. `yarn` to install example deps.
26-
1. `yarn dev` to run the example.
25+
1. `pnpm install` to install example deps.
26+
1. `pnpm dev` to run the example.
2727

2828
### Generating REST Client Code
2929

3030
If you modify the REST API, you'll need to regenerate the generated code that underlies the JavaScript client libraries.
3131

32-
1. `yarn` to install deps
33-
2. `yarn genapi`
34-
3. Examples are in the `examples` folder. There is one for the browser and one for node. Run them with `yarn dev`, eg `cd examples/browser && yarn dev`
32+
1. `pnpm install` to install deps
33+
2. `pnpm genapi`
34+
3. Examples are in the `examples` folder. There is one for the browser and one for node. Run them with `pnpm dev`, eg `cd examples/browser && pnpm dev`
3535

3636
### Running tests
3737

38-
`yarn test` will launch a test docker backend, run a db cleanup and run tests.
39-
`yarn test:run` will run against the docker backend you have running. But CAUTION, it will delete data. This is the easiest and fastest way to run tests.
38+
`pnpm test` will launch a test docker backend, run a db cleanup and run tests.
39+
`pnpm test:run` will run against the docker backend you have running. But CAUTION, it will delete data. This is the easiest and fastest way to run tests.
4040

4141
### Pushing to npm
4242

@@ -76,7 +76,7 @@ git push origin js_release_alpha_A.B.C
7676

7777
#### Manually
7878

79-
`npm run release` pushes the `package.json` defined packaged to the package manager for authenticated users. It will build, test, and then publish the new version.
79+
`pnpm run release` pushes the `package.json` defined packaged to the package manager for authenticated users. It will build, test, and then publish the new version.
8080

8181
### Useful links
8282

0 commit comments

Comments
 (0)