Expose pathsToExclude

Author: NikhilVerma

.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Program",
+            "skipFiles": ["<node_internals>/**"],
+            "program": "${workspaceFolder}/dist/index.js",
+            "outFiles": ["${workspaceFolder}/**/*.js"]
+        }
+    ]
+}

.vscode/settings.json

@@ -1,4 +1,5 @@
 {
     "editor.formatOnSave": true,
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.codeActionsOnSave": {}
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cldcvr/protobufjs-typescript-gen",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "main": "dist/index.js",
   "author": "Nikhil Verma <[email protected]>",
   "license": "MIT",

src/index.ts

@@ -109,7 +109,7 @@ function generateNamespace(namespace: Namespace, options: ProtoGenOptions) {
     // We have types in this namespace, we need to generate a file
     if (types.length > 0 || enums.length > 0 || services.length > 0) {
         const typeInfos = types.map((type) => getTypeInfo(type, options));
-        const serviceInfos = services.map(getServiceInfo);
+        const serviceInfos = services.map((service_) => getServiceInfo(service_, options));
 
         [...typeInfos, ...serviceInfos].forEach((typeInfo) => {
             typeInfo.imports.forEach(({ path, name }) => {
@@ -136,7 +136,7 @@ function generateNamespace(namespace: Namespace, options: ProtoGenOptions) {
         );
 
         // Ensure that type's parent has a file
-        const filePath = namespaceToPath(namespace.fullName);
+        const filePath = namespaceToPath(namespace.fullName, options);
 
         outputFileSync(`${path.join(options.outDir, filePath)}.ts`, file);
     }

src/options.ts

@@ -41,6 +41,10 @@ export function vaidateOptions(options?: UserOptions): ProtoGenOptions {
         options.ignoreNamespaces = ['grpc', 'validate', 'google'];
     }
 
+    if (!('pathsToExclude' in options)) {
+        options.pathsToExclude = ['v0'];
+    }
+
     return options as ProtoGenOptions;
 }
 
@@ -49,6 +53,7 @@ export type ProtoGenOptions = Required<UserOptions>;
 export type UserOptions = {
     outDir: string;
     protocolDir: string;
+    pathsToExclude?: string[];
     protoCwd?: string;
     ignoreNamespaces?: string[];
     cwd?: string;

src/services.ts

@@ -1,13 +1,14 @@
 import { Method, Service, Type } from 'protobufjs';
 import { getCommentBlock, getImport, Import, toLowerCaseFirstLetter } from './utils';
+import { ProtoGenOptions } from './options';
 
-export function getServiceInfo(service: Service) {
+export function getServiceInfo(service: Service, options: ProtoGenOptions) {
     let typeString = `export interface ${service.name} {\n`;
 
     let imports: Array<Import> = [];
 
     Object.values(service.methods).forEach((method) => {
-        const { code, typeImports } = getMethodCode(method);
+        const { code, typeImports } = getMethodCode(method, options);
         imports = imports.concat(typeImports);
         typeString += code;
     });
@@ -17,7 +18,7 @@ export function getServiceInfo(service: Service) {
     return { imports, typeString };
 }
 
-function getMethodCode(method: Method) {
+function getMethodCode(method: Method, options: ProtoGenOptions) {
     const typeImports: Array<Import> = [];
 
     method.resolve();
@@ -28,12 +29,14 @@ function getMethodCode(method: Method) {
 
     const { code: requestCode, import: requestImport } = getServiceTypeInfo(
         method,
-        method.resolvedRequestType
+        method.resolvedRequestType,
+        options
     );
 
     const { code: responseCode, import: responseImport } = getServiceTypeInfo(
         method,
-        method.resolvedResponseType
+        method.resolvedResponseType,
+        options
     );
 
     if (requestImport) {
@@ -53,7 +56,11 @@ function getMethodCode(method: Method) {
     };
 }
 
-function getServiceTypeInfo(method: Method, type: Type): { code: string; import: Import | null } {
+function getServiceTypeInfo(
+    method: Method,
+    type: Type,
+    options: ProtoGenOptions
+): { code: string; import: Import | null } {
     switch (type.fullName) {
         case '.google.protobuf.Value':
             return { code: 'any', import: null };
@@ -70,7 +77,7 @@ function getServiceTypeInfo(method: Method, type: Type): { code: string; import:
         default:
             return {
                 code: type.name,
-                import: getImport(method, type),
+                import: getImport(method, type, options),
             };
     }
 }

src/utils.ts

@@ -22,7 +22,11 @@ export function getCommentBlock(object: ReflectionObject) {
     return typeString ? `${typeString}\n` : '';
 }
 
-export function getImport(object: ReflectionObject, targetObject: ReflectionObject | null) {
+export function getImport(
+    object: ReflectionObject,
+    targetObject: ReflectionObject | null,
+    options: ProtoGenOptions
+) {
     if (!targetObject) {
         return null;
     }
@@ -37,7 +41,7 @@ export function getImport(object: ReflectionObject, targetObject: ReflectionObje
 
     return {
         name: targetObject.name,
-        path: namespaceToPath(targetObject.fullName).replace(`/${targetObject.name}`, ''),
+        path: namespaceToPath(targetObject.fullName, options).replace(`/${targetObject.name}`, ''),
     };
 }
 
@@ -55,13 +59,11 @@ export function getClosestNamespace(root: ReflectionObject) {
     return null;
 }
 
-export function namespaceToPath(namespace: string) {
-    const pathsToExclude = ['v0'];
-
+export function namespaceToPath(namespace: string, options: ProtoGenOptions) {
     return namespace
         .split('.')
         .filter(Boolean)
-        .filter((str) => str.length > 0 && !pathsToExclude.includes(str))
+        .filter((str) => str.length > 0 && !options.pathsToExclude.includes(str))
         .join('/');
 }
 
@@ -158,7 +160,7 @@ export function fieldToTypescriptType(field: FieldBase, options: ProtoGenOptions
 
             if (field.resolvedType?.name) {
                 type = field.resolvedType.name;
-                typeImport = getImport(field, field.resolvedType);
+                typeImport = getImport(field, field.resolvedType, options);
             } else {
                 type = 'unknown';
             }