Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs to pin to v1.x for Protobuf-ES #193

Merged
merged 5 commits into from
Aug 6, 2024
Merged

Update docs to pin to v1.x for Protobuf-ES #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
27451b5
Update docs
smaye81 Aug 6, 2024
dc5cea9
Pin versions
smaye81 Aug 6, 2024
9a588be
Missed on
smaye81 Aug 6, 2024
a70ec2d
Pin Next also
smaye81 Aug 6, 2024
c6653a8
Fixed package name
smaye81 Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/node/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ $ cd connect-example
$ npm init -y
$ npm install typescript tsx
$ npx tsc --init
$ npm install @bufbuild/buf @bufbuild/protoc-gen-es @bufbuild/protobuf @connectrpc/protoc-gen-connect-es @connectrpc/connect
$ npm install @bufbuild/buf @bufbuild/protoc-gen-es@"^1.0.0" @bufbuild/protobuf@"^1.0.0" @connectrpc/protoc-gen-connect-es@"^1.0.0" @connectrpc/connect@"^1.0.0"
```

## Define a service
Expand Down
6 changes: 3 additions & 3 deletions docs/node/server-plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ with your Connect RPCs. Use the plugin from [@connectrpc/connect-fastify](https:
with Fastify:

```bash
$ npm install fastify @connectrpc/connect @connectrpc/connect-node @connectrpc/connect-fastify
$ npm install fastify @connectrpc/connect@"^1.0.0" @connectrpc/connect-node@"^1.0.0" @connectrpc/connect-fastify@"^1.0.0"
```

```ts
Expand Down Expand Up @@ -101,7 +101,7 @@ using the latest React features. With [@connectrpc/connect-next](https://www.npm
you can serve your Connect RPCs via Next.js API Routes.

```bash
$ npm install next @connectrpc/connect @connectrpc/connect-node @connectrpc/connect-next
$ npm install next@"^13.0.0" @connectrpc/connect@"^1.0.0" @connectrpc/connect-node@"^1.0.0" @connectrpc/connect-next@"^1.0.0"
```

To enable the server plugin, create the file `pages/api/[[...connect]].ts` in your project:
Expand Down Expand Up @@ -143,7 +143,7 @@ popular because of its simplicity. Use the middleware provided by [@connectrpc/c
to add your Connect RPCs to Express:

```bash
$ npm install express @connectrpc/connect @connectrpc/connect-node @connectrpc/connect-express
$ npm install express @connectrpc/connect@"^1.0.0" @connectrpc/connect-node@"^1.0.0" @connectrpc/connect-express@"^1.0.0"
```

```ts
Expand Down
4 changes: 2 additions & 2 deletions docs/web/generating-code.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ The code we will generate has three runtime dependencies:
First, let's install `buf`, the plugins and runtime dependencies:

```bash
$ npm install --save-dev @bufbuild/buf @connectrpc/protoc-gen-connect-es @bufbuild/protoc-gen-es
$ npm install @connectrpc/connect @connectrpc/connect-web @bufbuild/protobuf
$ npm install --save-dev @bufbuild/buf @connectrpc/protoc-gen-connect-es@"^1.0.0" @bufbuild/protoc-gen-es@"^1.0.0"
$ npm install @connectrpc/connect@"^1.0.0" @connectrpc/connect-web@"^1.0.0" @bufbuild/protobuf@"^1.0.0"
```

Next, tell Buf to use the two plugins with a new configuration file:
Expand Down
4 changes: 2 additions & 2 deletions docs/web/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ the types we need on the fly:

```bash
$ npm config set @buf:registry https://buf.build/gen/npm/v1
$ npm install @buf/connectrpc_eliza.connectrpc_es @connectrpc/connect @connectrpc/connect-web
$ npm install @buf/connectrpc_eliza.connectrpc_es@1.4.0-20230913231627-233fca715f49.3 @connectrpc/connect@"^v1.0.0" @connectrpc/connect-web@"^v1.0.0"
```

(You can generate code locally if you prefer. We'll explain remote and local
Expand Down Expand Up @@ -241,7 +241,7 @@ We ran the following commands to build the app:
$ npm create vite@latest -- connect-example --template react-ts
$ cd connect-example
$ npm config set @buf:registry https://buf.build/gen/npm/v1
$ npm install @buf/connectrpc_eliza.connectrpc_es @connectrpc/connect @connectrpc/connect-web
$ npm install @buf/connectrpc_eliza.connectrpc_es@1.4.0-20230913231627-233fca715f49.3 @connectrpc/connect@"^1.0.0" @connectrpc/connect-web@"^1.0.0"
$ npm run dev
```

Expand Down
2 changes: 1 addition & 1 deletion docs/web/query.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Connect-Query is a wrapper around [TanStack Query](https://tanstack.com/query) (
### Install

```sh
npm install @connectrpc/connect-query @connectrpc/connect-web
npm install @connectrpc/connect-query@"^1.0.0" @connectrpc/connect-web@"^1.0.0"
```

### Usage
Expand Down
Loading