From e585bea0f382673337fd188d60a645e0fdbb5c87 Mon Sep 17 00:00:00 2001 From: Timo Stamm Date: Thu, 8 Feb 2024 12:18:03 +0100 Subject: [PATCH 1/3] Document the ts_nocheck plugin option --- packages/protoc-gen-connect-es/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/packages/protoc-gen-connect-es/README.md b/packages/protoc-gen-connect-es/README.md index 0f4a320ee..4ea569c2f 100644 --- a/packages/protoc-gen-connect-es/README.md +++ b/packages/protoc-gen-connect-es/README.md @@ -147,6 +147,16 @@ empty files, to allow for smooth interoperation with Bazel and similar tooling that requires all output files to be declared ahead of time. Unless you use Bazel, it is very unlikely that you need this option. +### `ts_nocheck=false` + +By default, [protoc-gen-es](https://www.npmjs.com/package/@bufbuild/protoc-gen-es) +(and all other plugins based on [@bufbuild/protoplugin](https://www.npmjs.com/package/@bufbuild/protoplugin)) +generate an annotation at the top of each file: `// @ts-nocheck`. + +We generate the annotation to support a wide of compiler configurations and +future changes to the language. But there can be situation where the annotation +shadows an underlying problem, for example an unresolvable import. To remove +the annotation and to enable type checks, set the plugin option `ts_nocheck=false`. ## Example generated code From d4ef0acc3d32cf54661572b21514ad603bac1546 Mon Sep 17 00:00:00 2001 From: Timo Stamm Date: Thu, 8 Feb 2024 12:20:39 +0100 Subject: [PATCH 2/3] Fix link --- packages/protoc-gen-connect-es/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/protoc-gen-connect-es/README.md b/packages/protoc-gen-connect-es/README.md index 4ea569c2f..cb1963ccd 100644 --- a/packages/protoc-gen-connect-es/README.md +++ b/packages/protoc-gen-connect-es/README.md @@ -149,7 +149,7 @@ Unless you use Bazel, it is very unlikely that you need this option. ### `ts_nocheck=false` -By default, [protoc-gen-es](https://www.npmjs.com/package/@bufbuild/protoc-gen-es) +By default, [protoc-gen-connect-es](https://www.npmjs.com/package/@connectrpc/protoc-gen-connect-es) (and all other plugins based on [@bufbuild/protoplugin](https://www.npmjs.com/package/@bufbuild/protoplugin)) generate an annotation at the top of each file: `// @ts-nocheck`. From a128c5f60312502c9ac2b658fc8b89b596631cb6 Mon Sep 17 00:00:00 2001 From: Timo Stamm Date: Fri, 9 Feb 2024 12:51:44 +0100 Subject: [PATCH 3/3] words --- packages/protoc-gen-connect-es/README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/packages/protoc-gen-connect-es/README.md b/packages/protoc-gen-connect-es/README.md index cb1963ccd..b4db1e187 100644 --- a/packages/protoc-gen-connect-es/README.md +++ b/packages/protoc-gen-connect-es/README.md @@ -153,10 +153,11 @@ By default, [protoc-gen-connect-es](https://www.npmjs.com/package/@connectrpc/pr (and all other plugins based on [@bufbuild/protoplugin](https://www.npmjs.com/package/@bufbuild/protoplugin)) generate an annotation at the top of each file: `// @ts-nocheck`. -We generate the annotation to support a wide of compiler configurations and -future changes to the language. But there can be situation where the annotation -shadows an underlying problem, for example an unresolvable import. To remove -the annotation and to enable type checks, set the plugin option `ts_nocheck=false`. +We generate the annotation to support a wide range of compiler configurations +and future changes to the language. But there can be situations where the +annotation shadows an underlying problem, for example an unresolvable import. +To remove the annotation and to enable type checks, set the plugin option +`ts_nocheck=false`. ## Example generated code