@connectrpc/protoc-gen-connect-query - npm Package Compare versions

Comparing version 1.1.3 to 1.2.0

dist/cjs/package.json

 {
     "name": "@connectrpc/protoc-gen-connect-query",
-    "version": "1.1.3",
+    "version": "1.2.0",
     "description": "Code generator for connect-query",
@@ -5,0 +5,0 @@ "license": "Apache-2.0",

package.json

 {
   "name": "@connectrpc/protoc-gen-connect-query",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "Code generator for connect-query",
@@ -29,3 +29,3 @@ "license": "Apache-2.0",
     "typescript": "^5.3.3",
-    "@connectrpc/connect-query": "1.1.3"
+    "@connectrpc/connect-query": "1.2.0"
   },
@@ -32,0 +32,0 @@ "dependencies": {

README.md

@@ -17,2 +17,3 @@ # @connectrpc/protoc-gen-connect-query
     - [`js_import_style`](#js_import_style)
+    - [`ts_nocheck=false`](#ts_nocheckfalse)
   - [Example Generated Code](#example-generated-code)
@@ -199,6 +200,2 @@
 
-### `keep_empty_files=true`
-
-This option exists for other plugins but is not applicable to `protoc-gen-connect-query` because, unlike most other plugins, it does not generate a maximum of one output file for every input proto file. Instead, it generates one output file per service. If you provide a valid proto file that contains no services, `protoc-gen-connect-query` will have no output.
-
 ### `js_import_style`
@@ -218,4 +215,19 @@
 
+### `keep_empty_files=true`
+
+This option exists for other plugins but is not applicable to `protoc-gen-connect-query` because, unlike most other plugins, it does not generate a maximum of one output file for every input proto file. Instead, it generates one output file per service. If you provide a valid proto file that contains no services, `protoc-gen-connect-query` will have no output.
+
+### `ts_nocheck=false`
+
+By default, [protoc-gen-connect-query](https://www.npmjs.com/package/@connectrpc/protoc-gen-connect-query)
+(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
 
 See [`eliza.proto`](../../examples/react/basic/eliza.proto) for example inputs, and look [here](../../examples/react/basic/src/gen) to see the outputs those files generate.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

38505

increased by1.77%

Number of lines in readme file

231

increased by5.48%

No dependency changes