Skip to content

Commit

Permalink
Merge branch 'main' into tstamm/merge-formats
Browse files Browse the repository at this point in the history
  • Loading branch information
timostamm authored Feb 9, 2024
2 parents 2f8394b + a02f88f commit af14994
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion packages/protoc-gen-es/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,6 @@ Possible values:
the default behavior.
- `js_import_style=legacy_commonjs` generate CommonJS `require()` calls.


### `keep_empty_files=true`

By default, [protoc-gen-es](https://www.npmjs.com/package/@bufbuild/protoc-gen-es)
Expand All @@ -127,3 +126,14 @@ omit empty files from the plugin output. This option disables pruning of
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`.

0 comments on commit af14994

Please sign in to comment.