@aptre/protobuf-es-lite 0.4.7 → 0.4.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +20 -21
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -146,9 +146,9 @@ bundler configurations. If you prefer to generate TypeScript, use `target=ts`.
146
146
 
147
147
  ### `import_extension=.js`
148
148
 
149
- By default, [protoc-gen-es](https://www.npmjs.com/package/@bufbuild/protoc-gen-es)
150
- (and all other plugins based on [@aptre/protobuf-es-lite/protoplugin](https://www.npmjs.com/package/@aptre/protobuf-es-lite/protoplugin))
151
- uses a `.js` file extensions in import paths, even in TypeScript files.
149
+ By default, protoc-gen-es (and all other plugins based on
150
+ [protoplugin](./src/protoplugin)) uses a `.js` file extensions in import paths,
151
+ even in TypeScript files.
152
152
 
153
153
  This is unintuitive, but necessary for [ECMAScript modules in Node.js](https://www.typescriptlang.org/docs/handbook/esm-node.html).
154
154
  Unfortunately, not all bundlers and tools have caught up yet, and Deno
@@ -160,11 +160,10 @@ in import paths with the given value. For example, set
160
160
 
161
161
  ### `js_import_style`
162
162
 
163
- By default, [protoc-gen-es](https://www.npmjs.com/package/@bufbuild/protoc-gen-es)
164
- (and all other plugins based on [@aptre/protobuf-es-lite/protoplugin](https://www.npmjs.com/package/@aptre/protobuf-es-lite/protoplugin))
165
- generate ECMAScript `import` and `export` statements. For use cases where
166
- CommonJS is difficult to avoid, this option can be used to generate CommonJS
167
- `require()` calls.
163
+ By default, protoc-gen-es (and all other plugins based on
164
+ [protoplugin](./src/protoplugin)) generates ECMAScript `import` and `export`
165
+ statements. For use cases where CommonJS is difficult to avoid, this option can
166
+ be used to generate CommonJS `require()` calls.
168
167
 
169
168
  Possible values:
170
169
  - `js_import_style=module` generate ECMAScript `import` / `export` statements -
@@ -173,23 +172,23 @@ Possible values:
173
172
 
174
173
  ### `keep_empty_files=true`
175
174
 
176
- By default, [protoc-gen-es](https://www.npmjs.com/package/@bufbuild/protoc-gen-es)
177
- (and all other plugins based on [@aptre/protobuf-es-lite/protoplugin](https://www.npmjs.com/package/@aptre/protobuf-es-lite/protoplugin))
178
- omit empty files from the plugin output. This option disables pruning of
179
- empty files, to allow for smooth interoperation with Bazel and similar
180
- tooling that requires all output files to be declared ahead of time.
181
- Unless you use Bazel, it is very unlikely that you need this option.
175
+ By default, protoc-gen-es (and all other plugins based on
176
+ [protoplugin](./src/protoplugin)) omits empty files from the plugin output. This
177
+ option disables pruning of empty files, to allow for smooth interoperation with
178
+ Bazel and similar tooling that requires all output files to be declared ahead of
179
+ time. Unless you use Bazel, it is very unlikely that you need this option.
182
180
 
183
181
  ### `ts_nocheck=false`
184
182
 
185
- By default, [protoc-gen-es](https://www.npmjs.com/package/@bufbuild/protoc-gen-es)
186
- (and all other plugins based on [@aptre/protobuf-es-lite/protoplugin](https://www.npmjs.com/package/@aptre/protobuf-es-lite/protoplugin))
187
- generate an annotation at the top of each file: `// @ts-nocheck`.
183
+ By default, protoc-gen-es (and all other plugins based on
184
+ [protoplugin](./src/protoplugin)) generates an annotation at the top of each
185
+ file: `// @ts-nocheck`.
188
186
 
189
- We generate the annotation to support a wide range of compiler configurations and
190
- future changes to the language. But there can be situations where the annotation
191
- shadows an underlying problem, for example an unresolvable import. To remove
192
- the annotation and to enable type checks, set the plugin option `ts_nocheck=false`.
187
+ We generate the annotation to support a wide range of compiler configurations
188
+ and future changes to the language. But there can be situations where the
189
+ annotation shadows an underlying problem, for example an unresolvable import. To
190
+ remove the annotation and to enable type checks, set the plugin option
191
+ `ts_nocheck=false`.
193
192
 
194
193
  ## Developing on MacOS
195
194
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aptre/protobuf-es-lite",
3
3
  "description": "Lightweight Protobuf codegen for TypeScript and JavaScript.",
4
- "version": "0.4.7",
4
+ "version": "0.4.8",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
7
7
  "url": "git+ssh://git@github.com/aperturerobotics/protobuf-es-lite.git"
@@ -73,7 +73,7 @@
73
73
  "lz-string": "^1.5.0"
74
74
  },
75
75
  "devDependencies": {
76
- "@types/node": "^20.12.13",
76
+ "@types/node": "^22.7.5",
77
77
  "@typescript-eslint/eslint-plugin": "^8.0.0",
78
78
  "@typescript-eslint/parser": "^8.0.0",
79
79
  "eslint": "^9.3.0",