ts2workflows 0.7.0 → 0.8.0

package/README.md

@@ -16,6 +16,12 @@ Converting Typescript code in a file samples/sample1.ts into GCP Workflows YAML
 npx ts2workflows samples/sample1.ts
 ```
 
+Compile multiple files and write result to an output directory `workflowsfiles`. This will write one output file corresponding to each input file in a directory given by the `--outdir` argument. The output files are named similarly to the input files but using `.yaml` as the file extension. The output directory will be created if it doesn't exist. Supplying the TSConfig with the `--project` argument makes compiling multiple files faster.
+
+```sh
+npx ts2workflows --project samples/tsconfig.json --outdir workflowsfiles samples/*.ts
+```
+
 When developing ts2workflows, you can run the transpiler directly from the source directory:
 
 ```sh
@@ -29,10 +35,10 @@ One benefit of writing the workflow programs in Typescript is that the sources c
 This example command shows how to type check source files in the [samples](samples) directory using the standard Typescript compiler `tsc`. The command prints typing errors or finishes silently, if there are no errors.
 
 ```sh
-npx tsc --project tsconfig.workflows.json
+npx tsc --project samples/tsconfig.json
 ```
 
-The file [tsconfig.workflows.json](tsconfig.workflows.json) contains a sample configuration for type checking workflow sources.
+The file [samples/tsconfig.json](samples/tsconfig.json) contains a sample configuration for type checking workflow sources.
 
 Type annotations for [Workflows standard library functions and expression helpers](https://cloud.google.com/workflows/docs/reference/stdlib/overview) and for some [connectors](https://cloud.google.com/workflows/docs/reference/googleapis) are provided in [types/workflowslib.d.ts](types/workflowslib.d.ts). They are also included in the published npm module. To import type annotations in a project that has ts2workflows module as a dependency, use the following import command:
 

package/dist/cli.js

@@ -1,5 +1,7 @@
 #!/usr/bin/env node
 import * as fs from 'node:fs';
+import * as path from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { program } from 'commander';
 import { transpile } from './transpiler/index.js';
 import { WorkflowSyntaxError } from './errors.js';
@@ -7,11 +9,16 @@ import { TSError } from '@typescript-eslint/typescript-estree';
 function parseArgs() {
     program
         .name('ts2workflow')
-        .version('0.1.0')
+        .version(versionFromPackageJson())
         .description('Transpile a Typescript program into GCP Workflows YAML syntax.')
-        .argument('[FILES]', 'Path to source file(s) to compile. If not given, reads from stdin.');
-    program.parse();
+        .option('--project <path>', 'Path to TSConfig for the Typescript sources files.')
+        .option('--outdir <path>', 'Specify an output directory for where transpilation result are written.')
+        .option('--generated-file-comment', 'Include a comment stating that the result is a generated file', true)
+        .option('--no-generated-file-comment', "Don't include a comment about file being generated")
+        .argument('[FILES...]', 'Path to source file(s) to compile. If not given, reads from stdin.')
+        .parse();
     return {
+        ...program.opts(),
         sourceFiles: program.args,
     };
 }
@@ -25,32 +32,27 @@ function cliMain() {
         files = args.sourceFiles;
     }
     files.forEach((inputFile) => {
-        const inp = inputFile === '-' ? process.stdin.fd : inputFile;
-        let sourceCode = '';
         try {
-            sourceCode = fs.readFileSync(inp, 'utf8');
-            console.log(transpile(sourceCode));
-        }
-        catch (err) {
-            if (isIoError(err, 'ENOENT')) {
-                console.error(`Error: "${inp}" not found`);
-                process.exit(1);
-            }
-            else if (isIoError(err, 'EISDIR')) {
-                console.error(`Error: "${inp}" is a directory`);
+            const transpiled = generateTranspiledText(inputFile, args.generatedFileComment, args.project);
+            if (transpiled === undefined) {
                 process.exit(1);
             }
-            else if (isIoError(err, 'EAGAIN') && inp === process.stdin.fd) {
-                // Reading from stdin if there's no input causes error. This is a bug in node
-                console.error('Error: Failed to read from stdin');
-                process.exit(1);
-            }
-            else if (err instanceof WorkflowSyntaxError) {
-                prettyPrintSyntaxError(err, inputFile, sourceCode);
-                process.exit(1);
-            }
-            else if (err instanceof TSError) {
-                prettyPrintSyntaxError(err, inputFile, sourceCode);
+            writeOutput(transpiled, inputFile, args.outdir);
+        }
+        catch (err) {
+            if (isIoError(err)) {
+                let message;
+                if ('code' in err && err.code === 'EAGAIN' && inputFile === '-') {
+                    // Reading from stdin if there's no input causes error. This is a bug in node
+                    message = 'Error: Failed to read from stdin';
+                }
+                else if ('code' in err && err.code === 'EISDIR') {
+                    message = `Error: "${inputFile}" is a directory`;
+                }
+                else {
+                    message = err.message;
+                }
+                console.error(message);
                 process.exit(1);
             }
             else {
@@ -59,8 +61,56 @@ function cliMain() {
         }
     });
 }
-function isIoError(err, errorCode) {
-    return err instanceof Error && 'code' in err && err.code == errorCode;
+function generateTranspiledText(inputFile, addGeneratedFileComment, project) {
+    const inputIsStdIn = inputFile === '-';
+    const inp = inputIsStdIn ? process.stdin.fd : inputFile;
+    const sourceCode = fs.readFileSync(inp, 'utf8');
+    try {
+        const needsHeader = addGeneratedFileComment && !inputIsStdIn;
+        const header = needsHeader ? generatedFileComment(inputFile) : '';
+        const transpiled = transpile(sourceCode, inputFile, project);
+        return `${header}${transpiled}`;
+    }
+    catch (err) {
+        if (err instanceof WorkflowSyntaxError) {
+            prettyPrintSyntaxError(err, inputFile, sourceCode);
+            return undefined;
+        }
+        else if (err instanceof TSError) {
+            prettyPrintSyntaxError(err, inputFile, sourceCode);
+            return undefined;
+        }
+        else {
+            throw err;
+        }
+    }
+}
+function writeOutput(transpiled, inputFile, outdir) {
+    if (outdir !== undefined) {
+        if (!fs.existsSync(outdir)) {
+            fs.mkdirSync(outdir, { recursive: true });
+        }
+        const outputFile = createOutputFilename(inputFile, outdir);
+        fs.writeFileSync(outputFile, transpiled);
+    }
+    else {
+        process.stdout.write(transpiled);
+    }
+}
+function createOutputFilename(inputFile, outdir) {
+    const parsedInput = path.parse(inputFile);
+    return path.format({
+        dir: outdir,
+        name: parsedInput.name,
+        ext: '.yaml',
+    });
+}
+function generatedFileComment(inputFile) {
+    return (`# This file has been generated by "ts2workflows ${inputFile}"\n` +
+        '# Do not edit!\n\n');
+}
+function isIoError(err) {
+    return err instanceof Error && 'code' in err;
 }
 function prettyPrintSyntaxError(exception, inputFile, sourceCode) {
     console.error(errorDisplay(inputFile, sourceCode, exception.location));
@@ -108,6 +158,13 @@ function highlightedSourceCodeLine(sourceCode, lineNumber, start, end) {
     const markerLine = `${' '.repeat(start)}${'^'.repeat(markerLength)}`;
     return `${sourceLine}\n${markerLine}`;
 }
+function versionFromPackageJson() {
+    const currentFile = fileURLToPath(import.meta.url);
+    const currentDir = path.dirname(currentFile);
+    const packagePath = path.join(currentDir, '..', 'package.json');
+    const pjson = JSON.parse(fs.readFileSync(packagePath, 'utf-8'));
+    return pjson.version ?? '???';
+}
 if (import.meta.url.endsWith(process.argv[1]) ||
     process.argv[1].endsWith('/ts2workflows')) {
     cliMain();

package/dist/transpiler/expressions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"expressions.d.ts","sourceRoot":"","sources":["../../src/transpiler/expressions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAkB,MAAM,sCAAsC,CAAA;AAC/E,OAAO,EAGL,UAAU,EAGV,SAAS,EAMV,MAAM,uBAAuB,CAAA;AAI9B,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,CAAC,UAAU,GAAG,UAAU,CAO3E;AAED,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,QAAQ,CAAC,gBAAgB,GAC9B,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,UAAU,CAAC,CAgCxC;AAED,wBAAgB,+BAA+B,CAC7C,IAAI,EAAE,QAAQ,CAAC,gBAAgB,GAC9B,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAG5B;AAgOD,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,QAAQ,CAAC,gBAAgB,GAC9B,UAAU,CAcZ;AA0JD,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAG3D;AAED,wBAAgB,2BAA2B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAGvE;AAoDD,wBAAgB,aAAa,CAC3B,CAAC,SACG,QAAQ,CAAC,UAAU,GACnB,QAAQ,CAAC,QAAQ,GACjB,QAAQ,CAAC,aAAa,GACtB,IAAI,EACR,KAAK,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,EAAE,CAgBlD;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,CAElE"}
+{"version":3,"file":"expressions.d.ts","sourceRoot":"","sources":["../../src/transpiler/expressions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAkB,MAAM,sCAAsC,CAAA;AAC/E,OAAO,EAGL,UAAU,EAGV,SAAS,EAMV,MAAM,uBAAuB,CAAA;AAI9B,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,CAAC,UAAU,GAAG,UAAU,CAO3E;AAED,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,QAAQ,CAAC,gBAAgB,GAC9B,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,UAAU,CAAC,CAgCxC;AAED,wBAAgB,+BAA+B,CAC7C,IAAI,EAAE,QAAQ,CAAC,gBAAgB,GAC9B,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAG5B;AAmOD,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,QAAQ,CAAC,gBAAgB,GAC9B,UAAU,CAcZ;AA0JD,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAG3D;AAED,wBAAgB,2BAA2B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAGvE;AAoDD,wBAAgB,aAAa,CAC3B,CAAC,SACG,QAAQ,CAAC,UAAU,GACnB,QAAQ,CAAC,QAAQ,GACjB,QAAQ,CAAC,aAAa,GACtB,IAAI,EACR,KAAK,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,EAAE,CAgBlD;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,CAElE"}

package/dist/transpiler/expressions.js

@@ -87,6 +87,8 @@ function convertExpressionOrPrimitive(instance) {
             return convertExpressionOrPrimitive(instance.expression);
         case AST_NODE_TYPES.AwaitExpression:
             return convertExpressionOrPrimitive(instance.argument);
+        case AST_NODE_TYPES.TSInstantiationExpression:
+            return convertExpressionOrPrimitive(instance.expression);
         default:
             throw new WorkflowSyntaxError(`Not implemented expression type: ${instance.type}`, instance.loc);
     }

package/dist/transpiler/index.d.ts

@@ -1,2 +1,2 @@
-export declare function transpile(code: string): string;
+export declare function transpile(code: string, inputFile?: string, tsconfigPath?: string): string;
 //# sourceMappingURL=index.d.ts.map

package/dist/transpiler/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/transpiler/index.ts"],"names":[],"mappings":"AAYA,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAW9C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/transpiler/index.ts"],"names":[],"mappings":"AAaA,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,EACZ,SAAS,CAAC,EAAE,MAAM,EAClB,YAAY,CAAC,EAAE,MAAM,GACpB,MAAM,CAkBR"}

package/dist/transpiler/index.js

@@ -1,16 +1,22 @@
-import { parse, AST_NODE_TYPES, } from '@typescript-eslint/typescript-estree';
+import { AST_NODE_TYPES, parseAndGenerateServices, } from '@typescript-eslint/typescript-estree';
 import * as YAML from 'yaml';
 import { SubworkflowAST } from '../ast/steps.js';
 import { WorkflowSyntaxError } from '../errors.js';
 import { generateStepNames } from '../ast/stepnames.js';
 import { parseStatement } from './statements.js';
-export function transpile(code) {
+export function transpile(code, inputFile, tsconfigPath) {
     const parserOptions = {
         jsDocParsingMode: 'none',
         loc: true,
         range: false,
     };
-    const ast = parse(code, parserOptions);
+    if (tsconfigPath && inputFile && inputFile != '-') {
+        parserOptions.filePath = inputFile;
+        parserOptions.projectService = {
+            defaultProject: tsconfigPath,
+        };
+    }
+    const { ast } = parseAndGenerateServices(code, parserOptions);
     const workflowAst = { subworkflows: ast.body.flatMap(parseTopLevelStatement) };
     const workflow = generateStepNames(workflowAst);
     return YAML.stringify(workflow.render(), { lineWidth: 100 });

package/dist/transpiler/statements.js

@@ -199,18 +199,21 @@ function createCallStep(node, argumentsNode, resultVariable) {
         throw new WorkflowSyntaxError('The first argument must be a Function', node.loc);
     }
     let functionName;
-    if (argumentsNode[0].type === AST_NODE_TYPES.Identifier) {
-        functionName = argumentsNode[0].name;
-    }
-    else if (argumentsNode[0].type === AST_NODE_TYPES.MemberExpression) {
-        const memberExp = convertMemberExpression(argumentsNode[0]);
+    const argNode = argumentsNode[0].type === AST_NODE_TYPES.TSInstantiationExpression
+        ? argumentsNode[0].expression
+        : argumentsNode[0];
+    if (argNode.type === AST_NODE_TYPES.Identifier) {
+        functionName = argNode.name;
+    }
+    else if (argNode.type === AST_NODE_TYPES.MemberExpression) {
+        const memberExp = convertMemberExpression(argNode);
         if (!isFullyQualifiedName(memberExp)) {
-            throw new WorkflowSyntaxError('Function name must be a fully-qualified name', argumentsNode[0].loc);
+            throw new WorkflowSyntaxError('Function name must be a fully-qualified name', argNode.loc);
         }
         functionName = memberExp.toString();
     }
     else {
-        throw new WorkflowSyntaxError('Expected an identifier or a member expression', argumentsNode[0].loc);
+        throw new WorkflowSyntaxError('Expected an identifier or a member expression', argNode.loc);
     }
     let args = {};
     if (argumentsNode.length >= 2) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts2workflows",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Transpile Typescript code to GCP Workflows programs",
   "homepage": "https://github.com/aajanki/ts2workflows",
   "repository": {
@@ -20,7 +20,7 @@
     "lint": "eslint src test scripts",
     "format": "prettier . --write",
     "test": "mocha",
-    "prepare": "husky"
+    "prepare": "husky && npm run build"
   },
   "lint-staged": {
     "src/**/*.ts": [
@@ -74,8 +74,8 @@
   },
   "dependencies": {
     "@typescript-eslint/typescript-estree": "^8.0.0",
-    "commander": "^12.1.0",
+    "commander": "^13.1.0",
     "typescript": "^5.0.0",
     "yaml": "^2.4.2"
   }
-}
+}