@bufbuild/protoplugin 2.0.0-beta.1 → 2.0.0-beta.2
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.
- package/README.md +12 -12
- package/package.json +8 -5
package/README.md
CHANGED
|
@@ -1,34 +1,34 @@
|
|
|
1
1
|
# @bufbuild/protoplugin
|
|
2
2
|
|
|
3
|
-
This package helps to create your own code generator plugin using the
|
|
3
|
+
This package helps to create your own code generator plugin using the
|
|
4
4
|
Protobuf-ES plugin framework.
|
|
5
5
|
|
|
6
|
-
**Protobuf-ES** is a complete implementation of [Protocol Buffers](https://developers.google.com/protocol-buffers) in TypeScript, suitable for web browsers and Node.js.
|
|
6
|
+
**Protobuf-ES** is a complete implementation of [Protocol Buffers](https://developers.google.com/protocol-buffers) in TypeScript, suitable for web browsers and Node.js.
|
|
7
7
|
|
|
8
8
|
In addition to a full Protobuf runtime library, it also provides a code generator
|
|
9
9
|
[`protoc-gen-es`](https://www.npmjs.com/package/@bufbuild/protoc-gen-es), which utilizes a plugin framework to generate base types from
|
|
10
|
-
your Protobuf schema.
|
|
10
|
+
your Protobuf schema. It is fully compatible with both Buf and protoc compilers.
|
|
11
11
|
|
|
12
12
|
And now, you can write your own **Protobuf-ES** compatible plugins using this same
|
|
13
13
|
plugin framework with the `@bufbuild/protoplugin` package.
|
|
14
14
|
|
|
15
|
-
With `@bufbuild/protoplugin`, you can generate your own TypeScript code tailored
|
|
16
|
-
to your project or needs.
|
|
15
|
+
With `@bufbuild/protoplugin`, you can generate your own TypeScript code tailored
|
|
16
|
+
to your project or needs. You also have various options for producing
|
|
17
17
|
JavaScript and TypeScript declaration files:
|
|
18
18
|
|
|
19
19
|
- Exercise full control by writing your own JavaScript and declaration file
|
|
20
|
-
generators in addition to TypeScript.
|
|
20
|
+
generators in addition to TypeScript.
|
|
21
21
|
|
|
22
22
|
- Generate TypeScript files only and let the framework generate JavaScript and
|
|
23
|
-
declaration files automatically using our internal TypeScript compiler.
|
|
23
|
+
declaration files automatically using our internal TypeScript compiler.
|
|
24
24
|
|
|
25
25
|
- Generate TypeScript files only and bring your own TypeScript compiler, using
|
|
26
|
-
it to generate JavaScript and declaration files with your own version of
|
|
27
|
-
TypeScript and your own compiler options.
|
|
26
|
+
it to generate JavaScript and declaration files with your own version of
|
|
27
|
+
TypeScript and your own compiler options.
|
|
28
28
|
|
|
29
|
-
With `@bufbuild/protoplugin`, you have all the tools at your disposal to produce
|
|
30
|
-
ECMAScript-compliant code.
|
|
29
|
+
With `@bufbuild/protoplugin`, you have all the tools at your disposal to produce
|
|
30
|
+
ECMAScript-compliant code.
|
|
31
31
|
|
|
32
32
|
## Usage
|
|
33
33
|
|
|
34
|
-
Get started now with our [plugin documentation](https://github.com/bufbuild/protobuf-es/blob/main/docs/writing_plugins.md).
|
|
34
|
+
Get started now with our [plugin documentation](https://github.com/bufbuild/protobuf-es/blob/main/docs/writing_plugins.md).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bufbuild/protoplugin",
|
|
3
|
-
"version": "2.0.0-beta.
|
|
3
|
+
"version": "2.0.0-beta.2",
|
|
4
4
|
"license": "(Apache-2.0 AND BSD-3-Clause)",
|
|
5
5
|
"description": "Helps to create your own Protocol Buffers code generators.",
|
|
6
6
|
"repository": {
|
|
@@ -9,10 +9,13 @@
|
|
|
9
9
|
"directory": "packages/protoplugin"
|
|
10
10
|
},
|
|
11
11
|
"scripts": {
|
|
12
|
-
"
|
|
12
|
+
"prebuild": "rm -rf ./dist/*",
|
|
13
13
|
"build": "npm run build:cjs && npm run build:esm",
|
|
14
|
-
"build:cjs": "../../node_modules/typescript/bin/tsc --project tsconfig.json --module commonjs --verbatimModuleSyntax false --moduleResolution node10 --outDir ./dist/cjs
|
|
15
|
-
"build:esm": "../../node_modules/typescript/bin/tsc --project tsconfig.json --outDir ./dist/esm
|
|
14
|
+
"build:cjs": "../../node_modules/typescript/bin/tsc --project tsconfig.json --module commonjs --verbatimModuleSyntax false --moduleResolution node10 --outDir ./dist/cjs && echo >./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
|
|
15
|
+
"build:esm": "../../node_modules/typescript/bin/tsc --project tsconfig.json --outDir ./dist/esm",
|
|
16
|
+
"format": "prettier --write --ignore-unknown '.' '!dist' '!.turbo'",
|
|
17
|
+
"license-header": "license-header",
|
|
18
|
+
"lint": "eslint --max-warnings 0 .",
|
|
16
19
|
"attw": "attw --pack"
|
|
17
20
|
},
|
|
18
21
|
"type": "module",
|
|
@@ -25,7 +28,7 @@
|
|
|
25
28
|
}
|
|
26
29
|
},
|
|
27
30
|
"dependencies": {
|
|
28
|
-
"@bufbuild/protobuf": "2.0.0-beta.
|
|
31
|
+
"@bufbuild/protobuf": "2.0.0-beta.2",
|
|
29
32
|
"@typescript/vfs": "^1.5.2",
|
|
30
33
|
"typescript": "5.4.5"
|
|
31
34
|
},
|