@dxos/protobuf-compiler 2.33.9-dev.6b3d59af → 2.33.9-dev.6efa8ddf

package/src/generator/file-generator.ts

@@ -9,6 +9,7 @@ import * as ts from 'typescript';
 import { CODEC_MODULE, ModuleSpecifier } from '../module-specifier';
 import { getSafeNamespaceIdentifier, parseFullyQualifiedName } from '../namespaces';
 import { SubstitutionsMap } from '../parser';
+import { GeneratorContext } from './context';
 import { createDeclarations, createTypeDictionary } from './declaration-generator';
 import { createSerializerDefinition } from './serializer-definition-generator';
 import { createServicesDictionary } from './service';
@@ -24,7 +25,12 @@ const createSubstitutionsImport = (substitutionsModule: ModuleSpecifier, context
 
 export const createNamespaceSourceFile = (types: pb.ReflectionObject[], substitutions: SubstitutionsMap, outDir: string, namespace: string, substitutionsModule: ModuleSpecifier | undefined, otherNamespaces: string[]) => {
   const outFile = join(outDir, getFileNameForNamespace(namespace));
-  const declarations: ts.Statement[] = Array.from(createDeclarations(types, substitutions));
+  const ctx: GeneratorContext = {
+    outputFilename: outFile,
+    subs: substitutions
+  };
+
+  const declarations: ts.Statement[] = Array.from(createDeclarations(types, ctx));
 
   const substitutionsImport = substitutionsModule && createSubstitutionsImport(substitutionsModule, dirname(outFile));
 

package/src/generator/message.ts

@@ -2,16 +2,20 @@
 // Copyright 2020 DXOS.org
 //
 
+import { dirname, relative } from 'path';
 import * as protobufjs from 'protobufjs';
 import * as ts from 'typescript';
 
-import { SubstitutionsMap } from '../parser';
+import { GeneratorContext } from './context';
 import { attachDocComment } from './doc-comment';
 import { getFieldType } from './field';
 
 const f = ts.factory;
 
-export const createMessageDeclaration = (type: protobufjs.Type, subs: SubstitutionsMap) => {
+/**
+ * {@link file://./../configure.ts#l5}
+ */
+export const createMessageDeclaration = (type: protobufjs.Type, ctx: GeneratorContext) => {
   const declaration = f.createInterfaceDeclaration(
     undefined,
     [f.createToken(ts.SyntaxKind.ExportKeyword)],
@@ -19,11 +23,13 @@ export const createMessageDeclaration = (type: protobufjs.Type, subs: Substituti
     undefined,
     undefined,
     type.fieldsArray.map(field => {
+      const isRequired = field.required || (!field.getOption('proto3_optional') && !field.repeated && !field.map && !field.partOf);
+
       const signature = f.createPropertySignature(
         undefined,
         field.name.includes('.') ? f.createStringLiteral(field.name) : field.name,
-        field.required ? undefined : f.createToken(ts.SyntaxKind.QuestionToken),
-        getFieldType(field, subs)
+        isRequired ? undefined : f.createToken(ts.SyntaxKind.QuestionToken),
+        getFieldType(field, ctx.subs)
       );
 
       const docComment = getFieldDocComment(field);
@@ -31,11 +37,16 @@ export const createMessageDeclaration = (type: protobufjs.Type, subs: Substituti
     })
   );
 
-  if (!type.comment) {
+  const commentSections = type.comment ? [type.comment] : [];
+  if (type.filename) {
+    commentSections.push(`Defined in:\n  {@link file://./${relative(dirname(ctx.outputFilename), type.filename)}}`);
+  }
+
+  if (commentSections.length === 0) {
     return declaration;
   }
 
-  return attachDocComment(declaration, type.comment);
+  return attachDocComment(declaration, commentSections.join('\n\n'));
 };
 
 const getFieldDocComment = (field: protobufjs.Field) => {

package/src/generator/service.ts

@@ -2,12 +2,14 @@
 // Copyright 2020 DXOS.org
 //
 
-import assert from 'assert';
+import assert from 'node:assert';
+import { dirname, relative } from 'path';
 import * as protobufjs from 'protobufjs';
 import * as ts from 'typescript';
 
 import { normalizeFullyQualifiedName } from '../namespaces';
 import { SubstitutionsMap } from '../parser';
+import { GeneratorContext } from './context';
 import { attachDocComment } from './doc-comment';
 import { types, getTypeReference } from './types';
 
@@ -45,7 +47,7 @@ const createRpcMethodType = (method: protobufjs.Method, service: protobufjs.Serv
   );
 };
 
-export const createServiceDeclaration = (type: protobufjs.Service, subs: SubstitutionsMap): ts.InterfaceDeclaration => {
+export const createServiceDeclaration = (type: protobufjs.Service, ctx: GeneratorContext): ts.InterfaceDeclaration => {
   const declaration = f.createInterfaceDeclaration(
     undefined,
     [f.createToken(ts.SyntaxKind.ExportKeyword)],
@@ -59,14 +61,23 @@ export const createServiceDeclaration = (type: protobufjs.Service, subs: Substit
           undefined,
           mapRpcMethodName(method.name),
           undefined,
-          createRpcMethodType(method, type, subs)
+          createRpcMethodType(method, type, ctx.subs)
         );
 
         return method.comment ? attachDocComment(sig, method.comment) : sig;
       })
   );
 
-  return type.comment ? attachDocComment(declaration, type.comment) : declaration;
+  const commentSections = type.comment ? [type.comment] : [];
+  if (type.filename) {
+    commentSections.push(`Defined in:\n  {@link file://./${relative(dirname(ctx.outputFilename), type.filename)}}`);
+  }
+
+  if (commentSections.length === 0) {
+    return declaration;
+  }
+
+  return attachDocComment(declaration, commentSections.join('\n\n'));
 };
 
 function * getServices (root: protobufjs.NamespaceBase): Generator<protobufjs.Service> {

package/src/module-specifier.ts

@@ -2,7 +2,7 @@
 // Copyright 2020 DXOS.org
 //
 
-import assert from 'assert';
+import assert from 'node:assert';
 import { isAbsolute, resolve, relative } from 'path';
 
 /**

package/src/namespaces.ts

@@ -2,7 +2,7 @@
 // Copyright 2020 DXOS.org
 //
 
-import assert from 'assert';
+import assert from 'node:assert';
 import * as pb from 'protobufjs';
 import * as ts from 'typescript';