[cli]: rework logic to support nested packages

zgid123 · Apr 14, 2024 · d8bda80 · d8bda80
1 parent 78d0820
commit d8bda80
Show file tree

Hide file tree

Showing 32 changed files with 818 additions and 353 deletions.
diff --git a/examples/fastify/src/protobufTypings/example.interface.ts b/examples/fastify/src/protobufTypings/example.interface.ts
@@ -1,5 +1,7 @@
 import type { Metadata, GrpcTimestamp, ServiceClient } from '@grpc.ts/core';
 
+import type { INested as INestedV1Nested } from './nested_example.interface';
+
 export const PACKAGE_NAME = 'example.v1';
 
 export const messageEnum = {
@@ -17,6 +19,7 @@ export type TMessageEnum = 'unknown' | 'info';
 export interface IMessage {
   message: string;
   createdAt: GrpcTimestamp;
+  nested: INestedV1Nested;
 }
 
 export interface ISendMessageRequest {

diff --git a/examples/fastify/src/protobufTypings/example2.interface.ts b/examples/fastify/src/protobufTypings/example2.interface.ts
@@ -1,10 +1,18 @@
 import type { Metadata, GrpcTimestamp, ServiceClient } from '@grpc.ts/core';
 
+import type {
+  IMessage as IExampleV1Message,
+  ISendMessageRequest as IExampleV1SendMessageRequest,
+} from './example.interface';
+import type { INested as INestedV1Nested } from './nested_example.interface';
+
 export const PACKAGE_NAME = 'example2.v1';
 
 export interface IMessage {
   message: string;
   createdAt: GrpcTimestamp;
+  exampleMessage: IExampleV1Message;
+  nested: INestedV1Nested;
 }
 
 export interface ISendMessageRequest {
@@ -20,11 +28,11 @@ export const EXAMPLE_SERVICE = 'ExampleService';
 
 export interface IExampleService extends ServiceClient {
   SendMessage(
-    params: ISendMessageRequest,
+    params: IExampleV1SendMessageRequest,
     metadata?: Metadata,
   ): Promise<IGetMessageResponse>;
   sendMessage(
-    params: ISendMessageRequest,
+    params: IExampleV1SendMessageRequest,
     metadata?: Metadata,
   ): Promise<IGetMessageResponse>;
 }
diff --git a/examples/fastify/src/protobufTypings/example3.interface.ts b/examples/fastify/src/protobufTypings/example3.interface.ts
@@ -1,9 +1,12 @@
 /* eslint-disable @typescript-eslint/ban-types */
 import type { Metadata, GrpcTimestamp, ServiceClient } from '@grpc.ts/core';
 
+import type { INested as INestedV1Nested } from './nested_example.interface';
+
 export interface IMessage {
   message: string;
   createdAt: GrpcTimestamp;
+  nested: INestedV1Nested;
 }
 
 export interface ISendMessageRequest {

diff --git a/examples/fastify/src/protobufTypings/nested_example.interface.ts b/examples/fastify/src/protobufTypings/nested_example.interface.ts
@@ -0,0 +1,8 @@
+import type { GrpcTimestamp } from '@grpc.ts/core';
+
+export const PACKAGE_NAME = 'nested.v1';
+
+export interface INested {
+  nested: string;
+  createdAt: GrpcTimestamp;
+}
diff --git a/examples/nestjs/protobufTypings/example.interface.ts b/examples/nestjs/protobufTypings/example.interface.ts
@@ -1,5 +1,7 @@
 import type { Metadata, GrpcTimestamp, ServiceClient } from '@grpc.ts/core';
 
+import type { INested as INestedV1Nested } from './nested_example.interface';
+
 export const PACKAGE_NAME = 'example.v1';
 
 export const messageEnum = {
@@ -17,6 +19,7 @@ export type TMessageEnum = 'unknown' | 'info';
 export interface IMessage {
   message: string;
   createdAt: GrpcTimestamp;
+  nested: INestedV1Nested;
 }
 
 export interface ISendMessageRequest {

diff --git a/examples/nestjs/protobufTypings/example2.interface.ts b/examples/nestjs/protobufTypings/example2.interface.ts
@@ -1,10 +1,18 @@
 import type { Metadata, GrpcTimestamp, ServiceClient } from '@grpc.ts/core';
 
+import type {
+  IMessage as IExampleV1Message,
+  ISendMessageRequest as IExampleV1SendMessageRequest,
+} from './example.interface';
+import type { INested as INestedV1Nested } from './nested_example.interface';
+
 export const PACKAGE_NAME = 'example2.v1';
 
 export interface IMessage {
   message: string;
   createdAt: GrpcTimestamp;
+  exampleMessage: IExampleV1Message;
+  nested: INestedV1Nested;
 }
 
 export interface ISendMessageRequest {
@@ -20,11 +28,11 @@ export const EXAMPLE_SERVICE = 'ExampleService';
 
 export interface IExampleService extends ServiceClient {
   SendMessage(
-    params: ISendMessageRequest,
+    params: IExampleV1SendMessageRequest,
     metadata?: Metadata,
   ): Promise<IGetMessageResponse>;
   sendMessage(
-    params: ISendMessageRequest,
+    params: IExampleV1SendMessageRequest,
     metadata?: Metadata,
   ): Promise<IGetMessageResponse>;
 }
diff --git a/examples/nestjs/protobufTypings/example3.interface.ts b/examples/nestjs/protobufTypings/example3.interface.ts
@@ -1,9 +1,12 @@
 /* eslint-disable @typescript-eslint/ban-types */
 import type { Metadata, GrpcTimestamp, ServiceClient } from '@grpc.ts/core';
 
+import type { INested as INestedV1Nested } from './nested_example.interface';
+
 export interface IMessage {
   message: string;
   createdAt: GrpcTimestamp;
+  nested: INestedV1Nested;
 }
 
 export interface ISendMessageRequest {

diff --git a/examples/nestjs/protobufTypings/nested_example.interface.ts b/examples/nestjs/protobufTypings/nested_example.interface.ts
@@ -0,0 +1,8 @@
+import type { GrpcTimestamp } from '@grpc.ts/core';
+
+export const PACKAGE_NAME = 'nested.v1';
+
+export interface INested {
+  nested: string;
+  createdAt: GrpcTimestamp;
+}
diff --git a/examples/proto/example.proto b/examples/proto/example.proto
@@ -2,6 +2,8 @@ syntax = "proto3";
 
 import "google/protobuf/timestamp.proto";
 
+import "nested_example.proto";
+
 package example.v1;
 
 enum MessageEnum {
@@ -12,6 +14,7 @@ enum MessageEnum {
 message Message {
   string message = 1;
   google.protobuf.Timestamp created_at = 2;
+  nested.v1.Nested nested = 3;
 }
 
 message SendMessageRequest {

diff --git a/examples/proto/example2.proto b/examples/proto/example2.proto
@@ -2,11 +2,16 @@ syntax = "proto3";
 
 import "google/protobuf/timestamp.proto";
 
+import "example.proto";
+import "nested_example.proto";
+
 package example2.v1;
 
 message Message {
   string message = 1;
   google.protobuf.Timestamp created_at = 2;
+  example.v1.Message example_message = 3;
+  nested.v1.Nested nested = 4;
 }
 
 message SendMessageRequest {
@@ -17,5 +22,5 @@ message SendMessageRequest {
 message GetMessageResponse { Message message = 1; }
 
 service ExampleService {
-  rpc SendMessage(SendMessageRequest) returns (GetMessageResponse);
+  rpc SendMessage(example.v1.SendMessageRequest) returns (GetMessageResponse);
 }
diff --git a/examples/proto/example3.proto b/examples/proto/example3.proto
@@ -3,9 +3,12 @@ syntax = "proto3";
 import "google/protobuf/empty.proto";
 import "google/protobuf/timestamp.proto";
 
+import "nested_example.proto";
+
 message Message {
   string message = 1;
   google.protobuf.Timestamp created_at = 2;
+  nested.v1.Nested nested = 3;
 }
 
 message SendMessageRequest {

diff --git a/examples/proto/nested_example.proto b/examples/proto/nested_example.proto
@@ -0,0 +1,10 @@
+syntax = "proto3";
+
+import "google/protobuf/timestamp.proto";
+
+package nested.v1;
+
+message Nested {
+  string nested = 1;
+  google.protobuf.Timestamp created_at = 2;
+}
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@grpc.ts/cli",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "license": "MIT",
   "directories": {
     "lib": "lib"

diff --git a/packages/cli/src/interface.ts b/packages/cli/src/interface.ts
@@ -6,10 +6,6 @@ export interface IConfigProps {
   paths?: string | string[];
 }
 
-export interface IOptionsProps {
-  external?: string[];
-}
-
 export interface IMessageProps {
   name: string;
   type: string;
@@ -39,6 +35,11 @@ export interface INamespaceDataProps {
 
 export type TParseNamespaceReturn = [string, INamespaceDataProps];
 
-export interface ICachedEnumsProps {
-  [key: string]: boolean;
+export interface IProtoDataProps {
+  filePath: string;
+  packageName: string;
+  noDependency: boolean;
+  data: INamespaceDataProps;
+  ownedMessages: Record<string, string>;
+  dependencies: Record<string, INamespaceDataProps>;
 }
diff --git a/packages/cli/src/run.ts b/packages/cli/src/run.ts
@@ -1,114 +1,15 @@
-import { glob } from 'glob';
-import { resolve } from 'path';
-import { format } from 'prettier';
-import { load } from 'protobufjs';
-import { cwd } from 'node:process';
-import { writeFile, mkdir } from 'node:fs/promises';
+import { loadData } from './tasks/loadData';
+import { loadConfig } from './utils/configuration';
+import { createContent } from './tasks/createContent';
+import { topologicalGroup } from './tasks/topologicalGroup';
 
-import { parse, wrapArray, loadConfig, combine } from './utils';
-import {
-  createImportType,
-  createExportEnums,
-  createExportMessages,
-  createExportServices,
-  createExportPackageName,
-} from './utils/contentHelper';
+async function generate(): Promise<void> {
+  const config = await loadConfig();
+  const protoData = await loadData(config);
 
-async function generate() {
-  const { external, output, paths } = await loadConfig();
-  const filePaths = await glob(
-    wrapArray(paths).map((path) => resolve(cwd(), path)),
-  );
+  const groupedProtoData = topologicalGroup(protoData);
 
-  Promise.all(
-    filePaths.map(async (filePath) => {
-      const root = await load(filePath);
-
-      const data = root.toJSON().nested;
-
-      if (!data) {
-        console.warn('No data from proto file');
-
-        return;
-      }
-
-      const result = parse(data, {
-        external,
-      });
-
-      let fileContent = createExportPackageName(result[0][0]);
-      let hasMetadata = false;
-      let hasGrpcTimestamp = false;
-      let hasService = false;
-      let hasBanType = false;
-
-      result.forEach(([_, packageData]) => {
-        const [enumsContent, cachedEnums] = createExportEnums(
-          packageData.enums,
-        );
-
-        const [messagesContent, containsGrpcTimestamp] = createExportMessages(
-          packageData.messages,
-          cachedEnums,
-        );
-
-        if (containsGrpcTimestamp) {
-          hasGrpcTimestamp = containsGrpcTimestamp;
-        }
-
-        if (packageData.services.length) {
-          hasService = true;
-          hasMetadata = true;
-        }
-
-        const [servicesContent, containsBanType] = createExportServices(
-          packageData.services,
-        );
-
-        if (containsBanType) {
-          hasBanType = containsBanType;
-        }
-
-        fileContent = combine(
-          {
-            joinWith: '\n',
-          },
-          fileContent,
-          enumsContent,
-          messagesContent,
-          servicesContent,
-        );
-      });
-
-      const fileName = filePath.slice(
-        filePath.lastIndexOf('/') + 1,
-        filePath.length - '.proto'.length,
-      );
-
-      fileContent = await createImportType(fileContent, {
-        hasService,
-        hasBanType,
-        hasMetadata,
-        hasGrpcTimestamp,
-      });
-
-      await mkdir(output, { recursive: true });
-
-      writeFile(
-        `${output}/${fileName}.interface.ts`,
-        await format(fileContent, {
-          singleQuote: true,
-          trailingComma: 'all',
-          jsxSingleQuote: true,
-          parser: 'typescript',
-          arrowParens: 'always',
-        }),
-        {
-          encoding: 'utf8',
-        },
-      );
-    }),
-  );
+  createContent(groupedProtoData, config);
 }
 
 generate();