fix: typegen globals expansion (#711)

Author: arboleya

.changeset/sixty-bugs-ring.md

@@ -0,0 +1,5 @@
+---
+"@fuel-ts/abi-typegen": patch
+---
+
+Fixing globals pattern expasion for `--inputs` paths

packages/abi-typegen/README.md

@@ -34,11 +34,11 @@ $ fuels-typegen -h
 Usage: fuels-typegen -i ../out/*-abi.json -o ./generated/
 
 Options:
-  -V, --version            output the version number
-  -i, --input <path|glob>  input path/global to your abi json files
-  -o, --output <dir>       directory path for generated files
-  -s, --silent             omit output messages
-  -h, --help               display help for command
+  -V, --version                output the version number
+  -i, --inputs <path|glob...>  input paths/globals to your abi json files
+  -o, --output <dir>           directory path for generated files
+  -s, --silent                 omit output messages
+  -h, --help                   display help for command
 ```
 
 ## Generating types

packages/abi-typegen/package.json

@@ -52,6 +52,7 @@
     "transpile:hbs": "ts-node ./scripts/transpile.hbs.ts",
     "prebuild": "pnpm transpile:hbs",
     "build": "tsup --dts",
+    "build:watch": "tsup --dts --watch",
     "build:fixtures": "ts-node ./test/fixtures/buildAll.ts"
   }
 }

packages/abi-typegen/src/cli.test.ts

@@ -22,11 +22,11 @@ describe('cli.ts', () => {
     });
 
     // compute filepaths
-    const input = join(tempDir, '/out/debug/*-abi.json');
+    const inputs = [join(tempDir, '/out/debug/*-abi.json')];
     const output = join(tempDir, 'generated');
 
     // executes program
-    const argv = ['node', 'fuels-typegen', '-i', input, '-o', output];
+    const argv = ['node', 'fuels-typegen', '-i', inputs.join(' '), '-o', output];
     const fn = () => run({ argv, programName: 'cli.js:test' });
     const { error } = await executeAndCatch(fn);
 
@@ -37,7 +37,7 @@ describe('cli.ts', () => {
 
     expect(runTypegen).toHaveBeenNthCalledWith(1, {
       cwd: process.cwd(),
-      input,
+      inputs,
       output,
       silent: false,
     });

packages/abi-typegen/src/cli.ts

@@ -1,22 +1,23 @@
 import { versions } from '@fuel-ts/versions';
 import { Command } from 'commander';
-import { resolve } from 'path';
 
 import { runTypegen } from './runTypegen';
 
-export function runCliAction(options: Record<string, string>) {
-  const cwd = process.cwd();
-
-  const input = resolve(options.input);
-  const output = resolve(options.output);
-  const silent = Boolean(options.silent);
+export interface ICliParams {
+  inputs: string[];
+  output: string;
+  silent: boolean;
+}
 
-  runTypegen({ cwd, input, output, silent });
+export function runCliAction(options: ICliParams) {
+  const cwd = process.cwd();
+  const { inputs, output, silent } = options;
+  runTypegen({ cwd, inputs, output, silent: !!silent });
 }
 
 export function configureCliOptions(program: Command) {
   program
-    .requiredOption('-i, --input <path|glob>', 'input path/global to your abi json files')
+    .requiredOption('-i, --inputs <path|glob...>', 'input paths/globals to your abi json files')
     .requiredOption('-o, --output <dir>', 'directory path for generated files')
     .option('-s, --silent', 'omit output messages')
     .action(runCliAction);

packages/abi-typegen/src/runTypegen.test.ts

@@ -2,6 +2,8 @@ import { existsSync } from 'fs';
 import { sync as globSync } from 'glob';
 import { join } from 'path';
 import rimraf from 'rimraf';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import shelljs from 'shelljs';
 
 import { contractPaths } from '../test/fixtures';
 import { executeAndCatch } from '../test/utils/executeAndCatch';
@@ -20,17 +22,23 @@ describe('runTypegen.js', () => {
       autoBuild,
     });
 
+    // duplicates ABI JSON so we can validate if all inputs
+    // are being collected (and not only the first one)
+    const from = join(tempDir, 'out/debug/full-abi.json');
+    const to = join(tempDir, 'out/debug/full2-abi.json');
+    shelljs.cp(from, to);
+
     // compute filepaths
     const cwd = process.cwd();
-    const input = join(tempDir, '/out/debug/*-abi.json');
+    const inputs = [join(tempDir, '/out/debug/*-abi.json')];
     const output = join(tempDir, 'generated');
     const silent = true;
 
     // executes program
     const fn = () =>
       runTypegen({
         cwd,
-        input,
+        inputs,
         output,
         silent,
       });
@@ -45,10 +53,11 @@ describe('runTypegen.js', () => {
       join(output, 'index.ts'),
       join(output, 'common.d.ts'),
       join(output, `${normalizedContractName}Abi.d.ts`),
+      join(output, `${normalizedContractName}2Abi.d.ts`),
       join(output, 'factories', `${normalizedContractName}Abi__factory.ts`),
     ];
 
-    expect(files.length).toEqual(4);
+    expect(files.length).toEqual(5);
 
     files.forEach((f) => {
       expect(existsSync(f)).toEqual(true);

packages/abi-typegen/src/runTypegen.ts

@@ -10,13 +10,13 @@ import type { IFile } from './interfaces/IFile';
 export interface IGenerateFilesParams {
   cwd: string;
   filepaths?: string[];
-  input?: string;
+  inputs?: string[];
   output: string;
   silent?: boolean;
 }
 
 export function runTypegen(params: IGenerateFilesParams) {
-  const { cwd, input, output, silent, filepaths: originalFilepaths } = params;
+  const { cwd, inputs, output, silent, filepaths: originalFilepaths } = params;
 
   const cwdBasename = basename(cwd);
 
@@ -30,8 +30,8 @@ export function runTypegen(params: IGenerateFilesParams) {
   */
   let filepaths: string[] = [];
 
-  if (!originalFilepaths?.length && input) {
-    filepaths = globSync(input, { cwd });
+  if (!originalFilepaths?.length && inputs?.length) {
+    filepaths = inputs.flatMap((i) => globSync(i, { cwd }));
   } else if (originalFilepaths?.length) {
     filepaths = originalFilepaths;
   } else {