@bufbuild/protoplugin 2.0.0-alpha.1 → 2.0.0-alpha.2

package/dist/cjs/ecmascript/file-preamble.js

@@ -64,6 +64,9 @@ function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsNoCheck)
             break;
         }
     }
+    for (const o of (0, source_code_info_js_1.getFeatureOptionStrings)(file)) {
+        builder.push(`// option ${o};\n`);
+    }
     builder.push("/* eslint-disable */\n");
     if (tsNoCheck) {
         builder.push("// @ts-nocheck\n");

package/dist/cjs/ecmascript/jsdoc.js

@@ -15,6 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatJsDocBlock = exports.createJsDocTextFromDesc = void 0;
 const source_code_info_js_1 = require("../source-code-info.js");
+const reflect_1 = require("@bufbuild/protobuf/reflect");
 function createJsDocTextFromDesc(desc) {
     const comments = (0, source_code_info_js_1.getComments)(desc);
     let text = "";
@@ -50,18 +51,29 @@ function createJsDocTextFromDesc(desc) {
         case "extension":
             text += `@generated from extension: ${(0, source_code_info_js_1.getDeclarationString)(desc)};`;
             break;
+        case "message":
+        case "enum": {
+            text += `@generated from ${desc.toString()}`;
+            const featureOptions = (0, source_code_info_js_1.getFeatureOptionStrings)(desc);
+            if (featureOptions.length > 0) {
+                text += `\n@generated with ${featureOptions.length > 1 ? "options" : "option"} ${featureOptions.join(", ")}`;
+            }
+            break;
+        }
         default:
             text += `@generated from ${desc.toString()}`;
             break;
     }
-    let deprecated = desc.deprecated;
+    let deprecated;
     switch (desc.kind) {
-        case "enum":
-        case "message":
-        case "service":
-            deprecated = deprecated || desc.file.deprecated;
+        case "field":
+        case "enum_value":
+        case "rpc":
+            deprecated = desc.deprecated;
             break;
         default:
+            deprecated =
+                desc.deprecated || (0, reflect_1.parentTypes)(desc).some((d) => d.deprecated);
             break;
     }
     if (deprecated) {

package/dist/cjs/ecmascript/parameter.js

@@ -21,7 +21,7 @@ function parseParameter(parameter, parseExtraOption) {
     let bootstrapWkt = false;
     let keepEmptyFiles = false;
     const rewriteImports = [];
-    let importExtension = ".js";
+    let importExtension = "";
     let jsImportStyle = "module";
     const rawParameters = [];
     for (const { key, value, raw } of splitParameter(parameter)) {

package/dist/cjs/ecmascript/schema.js

@@ -92,8 +92,16 @@ function getFilesToGenerate(request, minimumEdition, maximumEdition) {
             }
         }
     }
+    // Our goal is to provide options with source retention to plugin authors.
+    // CodeGeneratorRequest.proto_file elides options with source retention for
+    // files to generate. For these files, we take the file from source_file_descriptors,
+    // which does include options with source retention.
+    const allProtoWithSourceOptions = request.protoFile.map((protoFile) => {
+        const sourceFile = request.sourceFileDescriptors.find((s) => s.name == protoFile.name);
+        return sourceFile !== null && sourceFile !== void 0 ? sourceFile : protoFile;
+    });
     const registry = (0, reflect_1.createFileRegistry)((0, protobuf_1.create)(wkt_1.FileDescriptorSetDesc, {
-        file: request.protoFile,
+        file: allProtoWithSourceOptions,
     }));
     const allFiles = [];
     const filesToGenerate = [];

package/dist/cjs/source-code-info.d.ts

@@ -1,4 +1,4 @@
-import type { DescField, DescEnumValue, DescExtension, DescComments, AnyDesc, DescFile } from "@bufbuild/protobuf";
+import { type AnyDesc, type DescComments, type DescEnumValue, type DescExtension, type DescField, type DescFile } from "@bufbuild/protobuf";
 /**
  * Get comments on the package element in the protobuf source.
  */
@@ -11,6 +11,11 @@ export declare function getSyntaxComments(desc: DescFile): DescComments;
  * Get comments on the element in the protobuf source.
  */
 export declare function getComments(desc: Exclude<AnyDesc, DescFile>): DescComments;
+/**
+ * Get feature options set on the element in the protobuf source. This returns
+ * compact (e.g. fields) or regular options (e.g. files) as an array of strings.
+ */
+export declare function getFeatureOptionStrings(desc: AnyDesc): string[];
 /**
  * Return a string that matches the definition of a field in the protobuf
  * source. Does not take custom options into account.

package/dist/cjs/source-code-info.js

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDeclarationString = exports.getComments = exports.getSyntaxComments = exports.getPackageComments = void 0;
+exports.getDeclarationString = exports.getFeatureOptionStrings = exports.getComments = exports.getSyntaxComments = exports.getPackageComments = void 0;
 const protobuf_1 = require("@bufbuild/protobuf");
 const reflect_1 = require("@bufbuild/protobuf/reflect");
 const wkt_1 = require("@bufbuild/protobuf/wkt");
@@ -22,7 +22,7 @@ const wkt_1 = require("@bufbuild/protobuf/wkt");
  */
 function getPackageComments(desc) {
     return findComments(desc.proto.sourceCodeInfo, [
-        FieldNumber.FileDescriptorProto_Package,
+        wkt_1.FileDescriptorProtoDesc.field.package.number,
     ]);
 }
 exports.getPackageComments = getPackageComments;
@@ -31,7 +31,7 @@ exports.getPackageComments = getPackageComments;
  */
 function getSyntaxComments(desc) {
     return findComments(desc.proto.sourceCodeInfo, [
-        FieldNumber.FileDescriptorProto_Syntax,
+        wkt_1.FileDescriptorProtoDesc.field.syntax.number,
     ]);
 }
 exports.getSyntaxComments = getSyntaxComments;
@@ -46,11 +46,11 @@ function getComments(desc) {
             path = desc.parent
                 ? [
                     ...getComments(desc.parent).sourcePath,
-                    FieldNumber.DescriptorProto_EnumType,
+                    wkt_1.DescriptorProtoDesc.field.enumType.number,
                     desc.parent.proto.enumType.indexOf(desc.proto),
                 ]
                 : [
-                    FieldNumber.FileDescriptorProto_EnumType,
+                    wkt_1.FileDescriptorProtoDesc.field.enumType.number,
                     desc.file.proto.enumType.indexOf(desc.proto),
                 ];
             file = desc.file;
@@ -58,7 +58,7 @@ function getComments(desc) {
         case "oneof":
             path = [
                 ...getComments(desc.parent).sourcePath,
-                FieldNumber.DescriptorProto_OneofDecl,
+                wkt_1.DescriptorProtoDesc.field.oneofDecl.number,
                 desc.parent.proto.oneofDecl.indexOf(desc.proto),
             ];
             file = desc.parent.file;
@@ -67,11 +67,11 @@ function getComments(desc) {
             path = desc.parent
                 ? [
                     ...getComments(desc.parent).sourcePath,
-                    FieldNumber.DescriptorProto_NestedType,
+                    wkt_1.DescriptorProtoDesc.field.nestedType.number,
                     desc.parent.proto.nestedType.indexOf(desc.proto),
                 ]
                 : [
-                    FieldNumber.FileDescriptorProto_MessageType,
+                    wkt_1.FileDescriptorProtoDesc.field.messageType.number,
                     desc.file.proto.messageType.indexOf(desc.proto),
                 ];
             file = desc.file;
@@ -79,7 +79,7 @@ function getComments(desc) {
         case "enum_value":
             path = [
                 ...getComments(desc.parent).sourcePath,
-                FieldNumber.EnumDescriptorProto_Value,
+                wkt_1.EnumDescriptorProtoDesc.field.value.number,
                 desc.parent.proto.value.indexOf(desc.proto),
             ];
             file = desc.parent.file;
@@ -87,7 +87,7 @@ function getComments(desc) {
         case "field":
             path = [
                 ...getComments(desc.parent).sourcePath,
-                FieldNumber.DescriptorProto_Field,
+                wkt_1.DescriptorProtoDesc.field.field.number,
                 desc.parent.proto.field.indexOf(desc.proto),
             ];
             file = desc.parent.file;
@@ -96,18 +96,18 @@ function getComments(desc) {
             path = desc.parent
                 ? [
                     ...getComments(desc.parent).sourcePath,
-                    FieldNumber.DescriptorProto_Extension,
+                    wkt_1.DescriptorProtoDesc.field.extension.number,
                     desc.parent.proto.extension.indexOf(desc.proto),
                 ]
                 : [
-                    FieldNumber.FileDescriptorProto_Extension,
+                    wkt_1.FileDescriptorProtoDesc.field.extension.number,
                     desc.file.proto.extension.indexOf(desc.proto),
                 ];
             file = desc.file;
             break;
         case "service":
             path = [
-                FieldNumber.FileDescriptorProto_Service,
+                wkt_1.FileDescriptorProtoDesc.field.service.number,
                 desc.file.proto.service.indexOf(desc.proto),
             ];
             file = desc.file;
@@ -115,7 +115,7 @@ function getComments(desc) {
         case "rpc":
             path = [
                 ...getComments(desc.parent).sourcePath,
-                FieldNumber.ServiceDescriptorProto_Method,
+                wkt_1.ServiceDescriptorProtoDesc.field.method.number,
                 desc.parent.proto.method.indexOf(desc.proto),
             ];
             file = desc.parent.file;
@@ -124,6 +124,30 @@ function getComments(desc) {
     return findComments(file.proto.sourceCodeInfo, path);
 }
 exports.getComments = getComments;
+/**
+ * Get feature options set on the element in the protobuf source. This returns
+ * compact (e.g. fields) or regular options (e.g. files) as an array of strings.
+ */
+function getFeatureOptionStrings(desc) {
+    var _a, _b;
+    const strings = [];
+    const features = (_a = desc.proto.options) === null || _a === void 0 ? void 0 : _a.features;
+    if (features !== undefined) {
+        const r = (0, reflect_1.reflect)(wkt_1.FeatureSetDesc, features);
+        for (const f of r.fields) {
+            if (f.fieldKind != "enum" || !r.isSet(f)) {
+                continue;
+            }
+            const val = r.get(f);
+            const name = (_b = f.enum.values.find((v) => v.number == val)) === null || _b === void 0 ? void 0 : _b.name;
+            if (name !== undefined) {
+                strings.push(`features.${f.name} = ${name}`);
+            }
+        }
+    }
+    return strings;
+}
+exports.getFeatureOptionStrings = getFeatureOptionStrings;
 /**
  * Return a string that matches the definition of a field in the protobuf
  * source. Does not take custom options into account.
@@ -137,7 +161,6 @@ function getDeclarationString(desc) {
         }
         return str;
     }
-    const file = desc.kind === "extension" ? desc.file : desc.parent.file;
     const parts = [];
     function typeName(f) {
         if (f.message) {
@@ -152,12 +175,10 @@ function getDeclarationString(desc) {
         case "scalar":
         case "enum":
         case "message":
-            if (file.edition === wkt_1.Edition.EDITION_PROTO2 &&
-                (0, protobuf_1.isFieldSet)(wkt_1.FieldDescriptorProtoDesc, desc.proto, "label") &&
-                desc.proto.label == wkt_1.FieldDescriptorProto_Label.REQUIRED) {
+            if (fieldHasRequiredKeyword(desc)) {
                 parts.push("required");
             }
-            if (desc.optional) {
+            if (fieldHasOptionalKeyword(desc)) {
                 parts.push("optional");
             }
             parts.push(typeName(desc));
@@ -176,10 +197,10 @@ function getDeclarationString(desc) {
     const options = [];
     const protoOptions = desc.proto.options;
     if (protoOptions !== undefined &&
-        (0, protobuf_1.isFieldSet)(wkt_1.FieldOptionsDesc, protoOptions, "packed")) {
+        (0, protobuf_1.isFieldSet)(protoOptions, wkt_1.FieldOptionsDesc.field.packed)) {
         options.push(`packed = ${protoOptions.packed.toString()}`);
     }
-    if ((0, protobuf_1.isFieldSet)(wkt_1.FieldDescriptorProtoDesc, desc.proto, "defaultValue")) {
+    if ((0, protobuf_1.isFieldSet)(desc.proto, wkt_1.FieldDescriptorProtoDesc.field.defaultValue)) {
         let defaultValue = desc.proto.defaultValue;
         if (desc.proto.type == wkt_1.FieldDescriptorProto_Type.BYTES ||
             desc.proto.type == wkt_1.FieldDescriptorProto_Type.STRING) {
@@ -191,19 +212,45 @@ function getDeclarationString(desc) {
         options.push(`json_name = "${desc.jsonName}"`);
     }
     if (protoOptions !== undefined &&
-        (0, protobuf_1.isFieldSet)(wkt_1.FieldOptionsDesc, protoOptions, "jstype")) {
+        (0, protobuf_1.isFieldSet)(protoOptions, wkt_1.FieldOptionsDesc.field.jstype)) {
         options.push(`jstype = ${wkt_1.FieldOptions_JSType[protoOptions.jstype]}`);
     }
     if (protoOptions !== undefined &&
-        (0, protobuf_1.isFieldSet)(wkt_1.FieldOptionsDesc, protoOptions, "deprecated")) {
+        (0, protobuf_1.isFieldSet)(protoOptions, wkt_1.FieldOptionsDesc.field.deprecated)) {
         options.push(`deprecated = true`);
     }
+    options.push(...getFeatureOptionStrings(desc));
     if (options.length > 0) {
         parts.push("[" + options.join(", ") + "]");
     }
     return parts.join(" ");
 }
 exports.getDeclarationString = getDeclarationString;
+/**
+ * Whether this field was declared with `required` in the protobuf source.
+ */
+function fieldHasRequiredKeyword(field) {
+    const edition = (field.kind == "extension" ? field.file : field.parent.file)
+        .edition;
+    return (edition == wkt_1.Edition.EDITION_PROTO2 &&
+        field.proto.label == wkt_1.FieldDescriptorProto_Label.REQUIRED);
+}
+/**
+ * Whether this field was declared with `optional` in the protobuf source.
+ * Note that message fields are always optional. It is impossible to determine
+ * whether the keyword was used.
+ */
+function fieldHasOptionalKeyword(field) {
+    const edition = (field.kind == "extension" ? field.file : field.parent.file)
+        .edition;
+    if (edition == wkt_1.Edition.EDITION_PROTO2) {
+        return (!field.oneof && field.proto.label == wkt_1.FieldDescriptorProto_Label.OPTIONAL);
+    }
+    if (edition == wkt_1.Edition.EDITION_PROTO3) {
+        return field.proto.proto3Optional;
+    }
+    return false;
+}
 /**
  * Find comments.
  */
@@ -223,10 +270,10 @@ function findComments(sourceCodeInfo, sourcePath) {
         }
         return {
             leadingDetached: location.leadingDetachedComments,
-            leading: (0, protobuf_1.isFieldSet)(wkt_1.SourceCodeInfo_LocationDesc, location, "leadingComments")
+            leading: (0, protobuf_1.isFieldSet)(location, wkt_1.SourceCodeInfo_LocationDesc.field.leadingComments)
                 ? location.leadingComments
                 : undefined,
-            trailing: (0, protobuf_1.isFieldSet)(wkt_1.SourceCodeInfo_LocationDesc, location, "trailingComments")
+            trailing: (0, protobuf_1.isFieldSet)(location, wkt_1.SourceCodeInfo_LocationDesc.field.trailingComments)
                 ? location.trailingComments
                 : undefined,
             sourcePath,
@@ -237,23 +284,3 @@ function findComments(sourceCodeInfo, sourcePath) {
         sourcePath,
     };
 }
-/**
- * The following field numbers are used to find comments in
- * google.protobuf.SourceCodeInfo.
- */
-var FieldNumber;
-(function (FieldNumber) {
-    FieldNumber[FieldNumber["FileDescriptorProto_Package"] = 2] = "FileDescriptorProto_Package";
-    FieldNumber[FieldNumber["FileDescriptorProto_MessageType"] = 4] = "FileDescriptorProto_MessageType";
-    FieldNumber[FieldNumber["FileDescriptorProto_EnumType"] = 5] = "FileDescriptorProto_EnumType";
-    FieldNumber[FieldNumber["FileDescriptorProto_Service"] = 6] = "FileDescriptorProto_Service";
-    FieldNumber[FieldNumber["FileDescriptorProto_Extension"] = 7] = "FileDescriptorProto_Extension";
-    FieldNumber[FieldNumber["FileDescriptorProto_Syntax"] = 12] = "FileDescriptorProto_Syntax";
-    FieldNumber[FieldNumber["DescriptorProto_Field"] = 2] = "DescriptorProto_Field";
-    FieldNumber[FieldNumber["DescriptorProto_NestedType"] = 3] = "DescriptorProto_NestedType";
-    FieldNumber[FieldNumber["DescriptorProto_EnumType"] = 4] = "DescriptorProto_EnumType";
-    FieldNumber[FieldNumber["DescriptorProto_Extension"] = 6] = "DescriptorProto_Extension";
-    FieldNumber[FieldNumber["DescriptorProto_OneofDecl"] = 8] = "DescriptorProto_OneofDecl";
-    FieldNumber[FieldNumber["EnumDescriptorProto_Value"] = 2] = "EnumDescriptorProto_Value";
-    FieldNumber[FieldNumber["ServiceDescriptorProto_Method"] = 2] = "ServiceDescriptorProto_Method";
-})(FieldNumber || (FieldNumber = {}));

package/dist/esm/ecmascript/file-preamble.js

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 import { Edition } from "@bufbuild/protobuf/wkt";
-import { getPackageComments, getSyntaxComments } from "../source-code-info.js";
+import { getPackageComments, getSyntaxComments, getFeatureOptionStrings, } from "../source-code-info.js";
 export function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsNoCheck) {
     const builder = [];
     const trimSuffix = (str, suffix) => str.endsWith(suffix) ? str.substring(0, str.length - suffix.length) : str;
@@ -61,6 +61,9 @@ export function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsN
             break;
         }
     }
+    for (const o of getFeatureOptionStrings(file)) {
+        builder.push(`// option ${o};\n`);
+    }
     builder.push("/* eslint-disable */\n");
     if (tsNoCheck) {
         builder.push("// @ts-nocheck\n");

package/dist/esm/ecmascript/jsdoc.js

@@ -11,7 +11,8 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-import { getComments, getDeclarationString } from "../source-code-info.js";
+import { getComments, getDeclarationString, getFeatureOptionStrings, } from "../source-code-info.js";
+import { parentTypes } from "@bufbuild/protobuf/reflect";
 export function createJsDocTextFromDesc(desc) {
     const comments = getComments(desc);
     let text = "";
@@ -47,18 +48,29 @@ export function createJsDocTextFromDesc(desc) {
         case "extension":
             text += `@generated from extension: ${getDeclarationString(desc)};`;
             break;
+        case "message":
+        case "enum": {
+            text += `@generated from ${desc.toString()}`;
+            const featureOptions = getFeatureOptionStrings(desc);
+            if (featureOptions.length > 0) {
+                text += `\n@generated with ${featureOptions.length > 1 ? "options" : "option"} ${featureOptions.join(", ")}`;
+            }
+            break;
+        }
         default:
             text += `@generated from ${desc.toString()}`;
             break;
     }
-    let deprecated = desc.deprecated;
+    let deprecated;
     switch (desc.kind) {
-        case "enum":
-        case "message":
-        case "service":
-            deprecated = deprecated || desc.file.deprecated;
+        case "field":
+        case "enum_value":
+        case "rpc":
+            deprecated = desc.deprecated;
             break;
         default:
+            deprecated =
+                desc.deprecated || parentTypes(desc).some((d) => d.deprecated);
             break;
     }
     if (deprecated) {

package/dist/esm/ecmascript/parameter.js

@@ -18,7 +18,7 @@ export function parseParameter(parameter, parseExtraOption) {
     let bootstrapWkt = false;
     let keepEmptyFiles = false;
     const rewriteImports = [];
-    let importExtension = ".js";
+    let importExtension = "";
     let jsImportStyle = "module";
     const rawParameters = [];
     for (const { key, value, raw } of splitParameter(parameter)) {

package/dist/esm/ecmascript/schema.js

@@ -88,8 +88,16 @@ function getFilesToGenerate(request, minimumEdition, maximumEdition) {
             }
         }
     }
+    // Our goal is to provide options with source retention to plugin authors.
+    // CodeGeneratorRequest.proto_file elides options with source retention for
+    // files to generate. For these files, we take the file from source_file_descriptors,
+    // which does include options with source retention.
+    const allProtoWithSourceOptions = request.protoFile.map((protoFile) => {
+        const sourceFile = request.sourceFileDescriptors.find((s) => s.name == protoFile.name);
+        return sourceFile !== null && sourceFile !== void 0 ? sourceFile : protoFile;
+    });
     const registry = createFileRegistry(create(FileDescriptorSetDesc, {
-        file: request.protoFile,
+        file: allProtoWithSourceOptions,
     }));
     const allFiles = [];
     const filesToGenerate = [];

package/dist/esm/source-code-info.d.ts

@@ -1,4 +1,4 @@
-import type { DescField, DescEnumValue, DescExtension, DescComments, AnyDesc, DescFile } from "@bufbuild/protobuf";
+import { type AnyDesc, type DescComments, type DescEnumValue, type DescExtension, type DescField, type DescFile } from "@bufbuild/protobuf";
 /**
  * Get comments on the package element in the protobuf source.
  */
@@ -11,6 +11,11 @@ export declare function getSyntaxComments(desc: DescFile): DescComments;
  * Get comments on the element in the protobuf source.
  */
 export declare function getComments(desc: Exclude<AnyDesc, DescFile>): DescComments;
+/**
+ * Get feature options set on the element in the protobuf source. This returns
+ * compact (e.g. fields) or regular options (e.g. files) as an array of strings.
+ */
+export declare function getFeatureOptionStrings(desc: AnyDesc): string[];
 /**
  * Return a string that matches the definition of a field in the protobuf
  * source. Does not take custom options into account.

package/dist/esm/source-code-info.js

@@ -11,15 +11,15 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-import { isFieldSet } from "@bufbuild/protobuf";
-import { ScalarType, protoCamelCase } from "@bufbuild/protobuf/reflect";
-import { Edition, FieldDescriptorProto_Label, FieldDescriptorProto_Type, FieldDescriptorProtoDesc, FieldOptions_JSType, FieldOptionsDesc, SourceCodeInfo_LocationDesc, } from "@bufbuild/protobuf/wkt";
+import { isFieldSet, } from "@bufbuild/protobuf";
+import { protoCamelCase, reflect, ScalarType, } from "@bufbuild/protobuf/reflect";
+import { Edition, FieldDescriptorProto_Label, FieldDescriptorProto_Type, FieldDescriptorProtoDesc, FieldOptions_JSType, FieldOptionsDesc, FeatureSetDesc, SourceCodeInfo_LocationDesc, FileDescriptorProtoDesc, DescriptorProtoDesc, EnumDescriptorProtoDesc, ServiceDescriptorProtoDesc, } from "@bufbuild/protobuf/wkt";
 /**
  * Get comments on the package element in the protobuf source.
  */
 export function getPackageComments(desc) {
     return findComments(desc.proto.sourceCodeInfo, [
-        FieldNumber.FileDescriptorProto_Package,
+        FileDescriptorProtoDesc.field.package.number,
     ]);
 }
 /**
@@ -27,7 +27,7 @@ export function getPackageComments(desc) {
  */
 export function getSyntaxComments(desc) {
     return findComments(desc.proto.sourceCodeInfo, [
-        FieldNumber.FileDescriptorProto_Syntax,
+        FileDescriptorProtoDesc.field.syntax.number,
     ]);
 }
 /**
@@ -41,11 +41,11 @@ export function getComments(desc) {
             path = desc.parent
                 ? [
                     ...getComments(desc.parent).sourcePath,
-                    FieldNumber.DescriptorProto_EnumType,
+                    DescriptorProtoDesc.field.enumType.number,
                     desc.parent.proto.enumType.indexOf(desc.proto),
                 ]
                 : [
-                    FieldNumber.FileDescriptorProto_EnumType,
+                    FileDescriptorProtoDesc.field.enumType.number,
                     desc.file.proto.enumType.indexOf(desc.proto),
                 ];
             file = desc.file;
@@ -53,7 +53,7 @@ export function getComments(desc) {
         case "oneof":
             path = [
                 ...getComments(desc.parent).sourcePath,
-                FieldNumber.DescriptorProto_OneofDecl,
+                DescriptorProtoDesc.field.oneofDecl.number,
                 desc.parent.proto.oneofDecl.indexOf(desc.proto),
             ];
             file = desc.parent.file;
@@ -62,11 +62,11 @@ export function getComments(desc) {
             path = desc.parent
                 ? [
                     ...getComments(desc.parent).sourcePath,
-                    FieldNumber.DescriptorProto_NestedType,
+                    DescriptorProtoDesc.field.nestedType.number,
                     desc.parent.proto.nestedType.indexOf(desc.proto),
                 ]
                 : [
-                    FieldNumber.FileDescriptorProto_MessageType,
+                    FileDescriptorProtoDesc.field.messageType.number,
                     desc.file.proto.messageType.indexOf(desc.proto),
                 ];
             file = desc.file;
@@ -74,7 +74,7 @@ export function getComments(desc) {
         case "enum_value":
             path = [
                 ...getComments(desc.parent).sourcePath,
-                FieldNumber.EnumDescriptorProto_Value,
+                EnumDescriptorProtoDesc.field.value.number,
                 desc.parent.proto.value.indexOf(desc.proto),
             ];
             file = desc.parent.file;
@@ -82,7 +82,7 @@ export function getComments(desc) {
         case "field":
             path = [
                 ...getComments(desc.parent).sourcePath,
-                FieldNumber.DescriptorProto_Field,
+                DescriptorProtoDesc.field.field.number,
                 desc.parent.proto.field.indexOf(desc.proto),
             ];
             file = desc.parent.file;
@@ -91,18 +91,18 @@ export function getComments(desc) {
             path = desc.parent
                 ? [
                     ...getComments(desc.parent).sourcePath,
-                    FieldNumber.DescriptorProto_Extension,
+                    DescriptorProtoDesc.field.extension.number,
                     desc.parent.proto.extension.indexOf(desc.proto),
                 ]
                 : [
-                    FieldNumber.FileDescriptorProto_Extension,
+                    FileDescriptorProtoDesc.field.extension.number,
                     desc.file.proto.extension.indexOf(desc.proto),
                 ];
             file = desc.file;
             break;
         case "service":
             path = [
-                FieldNumber.FileDescriptorProto_Service,
+                FileDescriptorProtoDesc.field.service.number,
                 desc.file.proto.service.indexOf(desc.proto),
             ];
             file = desc.file;
@@ -110,7 +110,7 @@ export function getComments(desc) {
         case "rpc":
             path = [
                 ...getComments(desc.parent).sourcePath,
-                FieldNumber.ServiceDescriptorProto_Method,
+                ServiceDescriptorProtoDesc.field.method.number,
                 desc.parent.proto.method.indexOf(desc.proto),
             ];
             file = desc.parent.file;
@@ -118,6 +118,29 @@ export function getComments(desc) {
     }
     return findComments(file.proto.sourceCodeInfo, path);
 }
+/**
+ * Get feature options set on the element in the protobuf source. This returns
+ * compact (e.g. fields) or regular options (e.g. files) as an array of strings.
+ */
+export function getFeatureOptionStrings(desc) {
+    var _a, _b;
+    const strings = [];
+    const features = (_a = desc.proto.options) === null || _a === void 0 ? void 0 : _a.features;
+    if (features !== undefined) {
+        const r = reflect(FeatureSetDesc, features);
+        for (const f of r.fields) {
+            if (f.fieldKind != "enum" || !r.isSet(f)) {
+                continue;
+            }
+            const val = r.get(f);
+            const name = (_b = f.enum.values.find((v) => v.number == val)) === null || _b === void 0 ? void 0 : _b.name;
+            if (name !== undefined) {
+                strings.push(`features.${f.name} = ${name}`);
+            }
+        }
+    }
+    return strings;
+}
 /**
  * Return a string that matches the definition of a field in the protobuf
  * source. Does not take custom options into account.
@@ -131,7 +154,6 @@ export function getDeclarationString(desc) {
         }
         return str;
     }
-    const file = desc.kind === "extension" ? desc.file : desc.parent.file;
     const parts = [];
     function typeName(f) {
         if (f.message) {
@@ -146,12 +168,10 @@ export function getDeclarationString(desc) {
         case "scalar":
         case "enum":
         case "message":
-            if (file.edition === Edition.EDITION_PROTO2 &&
-                isFieldSet(FieldDescriptorProtoDesc, desc.proto, "label") &&
-                desc.proto.label == FieldDescriptorProto_Label.REQUIRED) {
+            if (fieldHasRequiredKeyword(desc)) {
                 parts.push("required");
             }
-            if (desc.optional) {
+            if (fieldHasOptionalKeyword(desc)) {
                 parts.push("optional");
             }
             parts.push(typeName(desc));
@@ -170,10 +190,10 @@ export function getDeclarationString(desc) {
     const options = [];
     const protoOptions = desc.proto.options;
     if (protoOptions !== undefined &&
-        isFieldSet(FieldOptionsDesc, protoOptions, "packed")) {
+        isFieldSet(protoOptions, FieldOptionsDesc.field.packed)) {
         options.push(`packed = ${protoOptions.packed.toString()}`);
     }
-    if (isFieldSet(FieldDescriptorProtoDesc, desc.proto, "defaultValue")) {
+    if (isFieldSet(desc.proto, FieldDescriptorProtoDesc.field.defaultValue)) {
         let defaultValue = desc.proto.defaultValue;
         if (desc.proto.type == FieldDescriptorProto_Type.BYTES ||
             desc.proto.type == FieldDescriptorProto_Type.STRING) {
@@ -185,18 +205,44 @@ export function getDeclarationString(desc) {
         options.push(`json_name = "${desc.jsonName}"`);
     }
     if (protoOptions !== undefined &&
-        isFieldSet(FieldOptionsDesc, protoOptions, "jstype")) {
+        isFieldSet(protoOptions, FieldOptionsDesc.field.jstype)) {
         options.push(`jstype = ${FieldOptions_JSType[protoOptions.jstype]}`);
     }
     if (protoOptions !== undefined &&
-        isFieldSet(FieldOptionsDesc, protoOptions, "deprecated")) {
+        isFieldSet(protoOptions, FieldOptionsDesc.field.deprecated)) {
         options.push(`deprecated = true`);
     }
+    options.push(...getFeatureOptionStrings(desc));
     if (options.length > 0) {
         parts.push("[" + options.join(", ") + "]");
     }
     return parts.join(" ");
 }
+/**
+ * Whether this field was declared with `required` in the protobuf source.
+ */
+function fieldHasRequiredKeyword(field) {
+    const edition = (field.kind == "extension" ? field.file : field.parent.file)
+        .edition;
+    return (edition == Edition.EDITION_PROTO2 &&
+        field.proto.label == FieldDescriptorProto_Label.REQUIRED);
+}
+/**
+ * Whether this field was declared with `optional` in the protobuf source.
+ * Note that message fields are always optional. It is impossible to determine
+ * whether the keyword was used.
+ */
+function fieldHasOptionalKeyword(field) {
+    const edition = (field.kind == "extension" ? field.file : field.parent.file)
+        .edition;
+    if (edition == Edition.EDITION_PROTO2) {
+        return (!field.oneof && field.proto.label == FieldDescriptorProto_Label.OPTIONAL);
+    }
+    if (edition == Edition.EDITION_PROTO3) {
+        return field.proto.proto3Optional;
+    }
+    return false;
+}
 /**
  * Find comments.
  */
@@ -216,10 +262,10 @@ function findComments(sourceCodeInfo, sourcePath) {
         }
         return {
             leadingDetached: location.leadingDetachedComments,
-            leading: isFieldSet(SourceCodeInfo_LocationDesc, location, "leadingComments")
+            leading: isFieldSet(location, SourceCodeInfo_LocationDesc.field.leadingComments)
                 ? location.leadingComments
                 : undefined,
-            trailing: isFieldSet(SourceCodeInfo_LocationDesc, location, "trailingComments")
+            trailing: isFieldSet(location, SourceCodeInfo_LocationDesc.field.trailingComments)
                 ? location.trailingComments
                 : undefined,
             sourcePath,
@@ -230,23 +276,3 @@ function findComments(sourceCodeInfo, sourcePath) {
         sourcePath,
     };
 }
-/**
- * The following field numbers are used to find comments in
- * google.protobuf.SourceCodeInfo.
- */
-var FieldNumber;
-(function (FieldNumber) {
-    FieldNumber[FieldNumber["FileDescriptorProto_Package"] = 2] = "FileDescriptorProto_Package";
-    FieldNumber[FieldNumber["FileDescriptorProto_MessageType"] = 4] = "FileDescriptorProto_MessageType";
-    FieldNumber[FieldNumber["FileDescriptorProto_EnumType"] = 5] = "FileDescriptorProto_EnumType";
-    FieldNumber[FieldNumber["FileDescriptorProto_Service"] = 6] = "FileDescriptorProto_Service";
-    FieldNumber[FieldNumber["FileDescriptorProto_Extension"] = 7] = "FileDescriptorProto_Extension";
-    FieldNumber[FieldNumber["FileDescriptorProto_Syntax"] = 12] = "FileDescriptorProto_Syntax";
-    FieldNumber[FieldNumber["DescriptorProto_Field"] = 2] = "DescriptorProto_Field";
-    FieldNumber[FieldNumber["DescriptorProto_NestedType"] = 3] = "DescriptorProto_NestedType";
-    FieldNumber[FieldNumber["DescriptorProto_EnumType"] = 4] = "DescriptorProto_EnumType";
-    FieldNumber[FieldNumber["DescriptorProto_Extension"] = 6] = "DescriptorProto_Extension";
-    FieldNumber[FieldNumber["DescriptorProto_OneofDecl"] = 8] = "DescriptorProto_OneofDecl";
-    FieldNumber[FieldNumber["EnumDescriptorProto_Value"] = 2] = "EnumDescriptorProto_Value";
-    FieldNumber[FieldNumber["ServiceDescriptorProto_Method"] = 2] = "ServiceDescriptorProto_Method";
-})(FieldNumber || (FieldNumber = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protoplugin",
-  "version": "2.0.0-alpha.1",
+  "version": "2.0.0-alpha.2",
   "license": "(Apache-2.0 AND BSD-3-Clause)",
   "description": "Helps to create your own Protocol Buffers code generators.",
   "repository": {
@@ -36,7 +36,7 @@
     }
   },
   "dependencies": {
-    "@bufbuild/protobuf": "2.0.0-alpha.1",
+    "@bufbuild/protobuf": "2.0.0-alpha.2",
     "@typescript/vfs": "^1.4.0",
     "typescript": "4.5.2"
   },