Merge pull request #5458 from trufflesuite/wfc-ts

eggplantzzz · web-flow · commit e385bf8b2ee0 · 2022-09-15T11:15:51.000-04:00
Internal improvement: Convert workflow-compile to TypeScript
diff --git a/packages/core/lib/build.js b/packages/core/lib/build.js
@@ -1,8 +1,8 @@
 const fse = require("fs-extra");
 const del = require("del");
-const WorkflowCompile = require("@truffle/workflow-compile");
+const WorkflowCompile = require("@truffle/workflow-compile").default;
 const BuildError = require("./errors/builderror");
-const {spawn} = require("child_process");
+const { spawn } = require("child_process");
 const spawnargs = require("spawn-args");
 const _ = require("lodash");
 const expect = require("@truffle/expect");
diff --git a/packages/core/lib/commands/compile/run.js b/packages/core/lib/commands/compile/run.js
@@ -3,7 +3,7 @@ const fse = require("fs-extra");
 
 module.exports = async function (options) {
   const TruffleError = require("@truffle/error");
-  const WorkflowCompile = require("@truffle/workflow-compile");
+  const WorkflowCompile = require("@truffle/workflow-compile").default;
   const Config = require("@truffle/config");
   const config = Config.detect(options);
 
diff --git a/packages/core/lib/commands/exec/run.js b/packages/core/lib/commands/exec/run.js
@@ -1,6 +1,6 @@
 module.exports = async function (options) {
   const Config = require("@truffle/config");
-  const WorkflowCompile = require("@truffle/workflow-compile");
+  const WorkflowCompile = require("@truffle/workflow-compile").default;
   const ConfigurationError = require("../../errors/configurationerror");
   const exec = require("@truffle/require").exec;
   const { Environment } = require("@truffle/environment");
diff --git a/packages/core/lib/commands/migrate/run.js b/packages/core/lib/commands/migrate/run.js
@@ -1,5 +1,5 @@
 module.exports = async function (options) {
-  const WorkflowCompile = require("@truffle/workflow-compile");
+  const WorkflowCompile = require("@truffle/workflow-compile").default;
   const { Environment } = require("@truffle/environment");
   const Config = require("@truffle/config");
   const determineDryRunSettings = require("./determineDryRunSettings");
diff --git a/packages/core/lib/commands/opcode/run.js b/packages/core/lib/commands/opcode/run.js
@@ -1,7 +1,7 @@
 module.exports = async function (options) {
   const Config = require("@truffle/config");
   const TruffleError = require("@truffle/error");
-  const WorkflowCompile = require("@truffle/workflow-compile");
+  const WorkflowCompile = require("@truffle/workflow-compile").default;
   const CodeUtils = require("@truffle/code-utils");
   const { Conversion, Compilations } = require("@truffle/codec");
 
diff --git a/packages/core/lib/debug/compiler.js b/packages/core/lib/debug/compiler.js
@@ -1,4 +1,4 @@
-const WorkflowCompile = require("@truffle/workflow-compile");
+const WorkflowCompile = require("@truffle/workflow-compile").default;
 const { Resolver } = require("@truffle/resolver");
 const glob = require("glob");
 const path = require("path");
diff --git a/packages/core/lib/testing/Test.js b/packages/core/lib/testing/Test.js
@@ -6,7 +6,7 @@ const {
   createInterfaceAdapter
 } = require("@truffle/interface-adapter");
 const Config = require("@truffle/config");
-const WorkflowCompile = require("@truffle/workflow-compile");
+const WorkflowCompile = require("@truffle/workflow-compile").default;
 const { Resolver } = require("@truffle/resolver");
 const TestRunner = require("./TestRunner");
 const SolidityTest = require("./SolidityTest");
diff --git a/packages/core/test/config.js b/packages/core/test/config.js
@@ -1,5 +1,5 @@
 const { assert } = require("chai");
-const WorkflowCompile = require("@truffle/workflow-compile");
+const WorkflowCompile = require("@truffle/workflow-compile").default;
 const Ganache = require("ganache");
 const provision = require("@truffle/provisioner");
 const Config = require("@truffle/config");
diff --git a/packages/core/test/lib/commands/compile.js b/packages/core/test/lib/commands/compile.js
@@ -1,5 +1,5 @@
 const assert = require("chai").assert;
-const WorkflowCompile = require("@truffle/workflow-compile");
+const WorkflowCompile = require("@truffle/workflow-compile").default;
 const MemoryStream = require("memorystream");
 const command = require("../../../lib/commands/compile");
 const path = require("path");
diff --git a/packages/core/test/lib/commands/test.js b/packages/core/test/lib/commands/test.js
@@ -4,7 +4,7 @@ const {
 } = require("../../../lib/commands/test/determineTestFilesToRun");
 const path = require("path");
 const fse = require("fs-extra");
-const WorkflowCompile = require("@truffle/workflow-compile");
+const WorkflowCompile = require("@truffle/workflow-compile").default;
 const Test = require("../../../lib/testing/Test");
 const Config = require("@truffle/config");
 const tmp = require("tmp");
diff --git a/packages/core/test/migrate.js b/packages/core/test/migrate.js
@@ -1,7 +1,7 @@
 const assert = require("chai").assert;
 const { default: Box } = require("@truffle/box");
 const Migrate = require("@truffle/migrate");
-const WorkflowCompile = require("@truffle/workflow-compile");
+const WorkflowCompile = require("@truffle/workflow-compile").default;
 const Networks = require("../lib/networks");
 const path = require("path");
 const fs = require("fs-extra");
diff --git a/packages/core/test/npm.js b/packages/core/test/npm.js
@@ -5,7 +5,7 @@ var path = require("path");
 var fse = require("fs-extra");
 var { Resolver } = require("@truffle/resolver");
 var Artifactor = require("@truffle/artifactor");
-var WorkflowCompile = require("@truffle/workflow-compile");
+var WorkflowCompile = require("@truffle/workflow-compile").default;
 
 describe("NPM integration", function () {
   var config;
diff --git a/packages/decoder/test/helpers.js b/packages/decoder/test/helpers.js
@@ -1,7 +1,7 @@
 const debugModule = require("debug");
 const debug = debugModule("decoder:test:helpers");
 
-const WorkflowCompile = require("@truffle/workflow-compile");
+const WorkflowCompile = require("@truffle/workflow-compile").default;
 const Migrate = require("@truffle/migrate");
 const Codec = require("@truffle/codec");
 const Config = require("@truffle/config");
diff --git a/packages/deployer/test/helpers/utils.js b/packages/deployer/test/helpers/utils.js
@@ -1,5 +1,5 @@
 const TruffleContract = require("@truffle/contract");
-const WorkflowCompile = require("@truffle/workflow-compile");
+const WorkflowCompile = require("@truffle/workflow-compile").default;
 const path = require("path");
 const fs = require("fs-extra");
 
diff --git a/packages/encoder/test/helpers.ts b/packages/encoder/test/helpers.ts
@@ -12,9 +12,9 @@ import * as Codec from "@truffle/codec";
 import TruffleConfig from "@truffle/config";
 import type { ContractObject as Artifact } from "@truffle/contract-schema/spec";
 import type * as Common from "@truffle/compile-common";
+import WorkflowCompile from "@truffle/workflow-compile";
 //sorry, some untyped imports here :-/
 
-const WorkflowCompile = require("@truffle/workflow-compile");
 const Deployer = require("@truffle/deployer");
 const { Resolver } = require("@truffle/resolver"); //resolver is TS too but I can't make it typecheck :-/
 
diff --git a/packages/workflow-compile/.gitignore b/packages/workflow-compile/.gitignore
@@ -59,5 +59,8 @@ typings/
 
 package-lock.json
 
+# built TS files
+dist
+
 # commit the bin directory with scripts
 !bin
diff --git a/packages/workflow-compile/README.md b/packages/workflow-compile/README.md
@@ -1,4 +1,5 @@
 # @truffle/workflow-compile
+
 Core workflow logic for the `truffle compile` command behavior
 
 ### install
@@ -10,7 +11,7 @@ $ npm install @truffle/workflow-compile
 ### Usage
 
 ```javascript
-const Contracts = require("@truffle/workflow-compile");
+import Contracts from "@truffle/workflow-compile";
 
 // expected config object
 const config = {
@@ -22,5 +23,5 @@ const config = {
 // saves them in contracts_build_directory
 Contracts.compile(config)
   .then(() => console.log("Compilation complete!"))
-  .catch(e => console.error(e))
+  .catch(e => console.error(e));
 ```
diff --git a/packages/workflow-compile/legacy/index.js b/packages/workflow-compile/legacy/index.js
@@ -3,15 +3,37 @@ const fse = require("fs-extra");
 const externalCompile = require("@truffle/external-compile");
 const solcCompile = require("@truffle/compile-solidity");
 const vyperCompile = require("@truffle/compile-vyper");
-const { prepareConfig } = require("../utils");
 const { Shims } = require("@truffle/compile-common");
+const expect = require("@truffle/expect");
+const Config = require("@truffle/config");
+const Artifactor = require("@truffle/artifactor");
+const Resolver = require("@truffle/resolver");
 
 const SUPPORTED_COMPILERS = {
   solc: solcCompile,
   vyper: vyperCompile,
   external: externalCompile
 };
 
+function prepareConfig(options) {
+  expect.options(options, ["contracts_build_directory"]);
+
+  expect.one(options, ["contracts_directory", "files"]);
+
+  // Use a config object to ensure we get the default sources.
+  const config = Config.default().merge(options);
+
+  config.compilersInfo = {};
+
+  if (!config.resolver) config.resolver = new Resolver(config);
+
+  if (!config.artifactor) {
+    config.artifactor = new Artifactor(config.contracts_build_directory);
+  }
+
+  return config;
+}
+
 const WorkflowCompile = {
   collectCompilations: async compilations => {
     let result = { outputs: {}, contracts: {} };
@@ -103,9 +125,8 @@ const WorkflowCompile = {
         const { contracts, output } = compilations.reduce(
           (a, compilation) => {
             for (const contract of compilation.contracts) {
-              a.contracts[
-                contract.contractName
-              ] = Shims.NewToLegacy.forContract(contract);
+              a.contracts[contract.contractName] =
+                Shims.NewToLegacy.forContract(contract);
             }
             a.output = a.output.concat(compilation.sourceIndexes);
             return a;
diff --git a/packages/workflow-compile/package.json b/packages/workflow-compile/package.json
@@ -13,10 +13,11 @@
     "url": "https://github.com/trufflesuite/truffle/issues"
   },
   "version": "4.0.33",
-  "main": "index.js",
+  "main": "dist/index.js",
   "scripts": {
-    "prepare": "exit 0",
-    "test": "mocha"
+    "build": "tsc",
+    "prepare": "yarn build",
+    "test": "mocha -r ts-node/register test/*.ts"
   },
   "dependencies": {
     "@truffle/artifactor": "^4.0.169",
@@ -32,10 +33,11 @@
   },
   "devDependencies": {
     "debug": "^4.3.1",
-    "mocha": "9.2.2"
+    "mocha": "9.2.2",
+    "ts-node": "10.7.0",
+    "typescript": "^4.7.4"
   },
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "6b84be7849142588ef2e3224d8a9d7c2ceeb6e4a"
+  }
 }
diff --git a/packages/workflow-compile/src/index.ts b/packages/workflow-compile/src/index.ts
@@ -1,8 +1,9 @@
-const debug = require("debug")("workflow-compile");
-const fse = require("fs-extra");
-const { prepareConfig } = require("./utils");
-const { Shims } = require("@truffle/compile-common");
-const { getTruffleDb } = require("@truffle/db-loader");
+import debugModule from "debug";
+const debug = debugModule("workflow-compile");
+import fse from "fs-extra";
+import { prepareConfig } from "./utils";
+import { Shims, Compilation } from "@truffle/compile-common";
+import { getTruffleDb } from "@truffle/db-loader";
 
 const SUPPORTED_COMPILERS = {
   solc: require("@truffle/compile-solidity").Compile,
@@ -12,15 +13,13 @@ const SUPPORTED_COMPILERS = {
 
 async function compile(config) {
   // determine compiler(s) to use
-  //
   const compilers = config.compiler
     ? config.compiler === "none"
       ? []
       : [config.compiler]
     : Object.keys(config.compilers);
 
   // invoke compilers
-  //
   const rawCompilations = await Promise.all(
     compilers.map(async name => {
       const Compile = SUPPORTED_COMPILERS[name];
@@ -43,7 +42,7 @@ async function compile(config) {
   // collect results - rawCompilations is CompilerResult[]
   // flatten the array and remove compilations without results
   const compilations = rawCompilations.reduce((a, compilerResult) => {
-    compilerResult.compilations.forEach(compilation => {
+    compilerResult.compilations.forEach((compilation: Compilation) => {
       if (compilation.contracts.length > 0) {
         a = a.concat(compilation);
       }
@@ -60,7 +59,7 @@ async function compile(config) {
   return { contracts, compilations };
 }
 
-const WorkflowCompile = {
+export default {
   async compile(options) {
     const config = prepareConfig(options);
 
@@ -156,5 +155,3 @@ const WorkflowCompile = {
     });
   }
 };
-
-module.exports = WorkflowCompile;
diff --git a/packages/workflow-compile/src/utils.ts b/packages/workflow-compile/src/utils.ts
@@ -1,9 +1,9 @@
-const Config = require("@truffle/config");
-const expect = require("@truffle/expect");
-const { Resolver } = require("@truffle/resolver");
-const Artifactor = require("@truffle/artifactor");
+import Config from "@truffle/config";
+import * as expect from "@truffle/expect";
+import { Resolver } from "@truffle/resolver";
+import Artifactor from "@truffle/artifactor";
 
-function prepareConfig(options) {
+export function prepareConfig(options: Config) {
   expect.options(options, ["contracts_build_directory"]);
 
   expect.one(options, ["contracts_directory", "files"]);
@@ -22,7 +22,7 @@ function prepareConfig(options) {
   return config;
 }
 
-function multiPromisify(func) {
+export function multiPromisify(func) {
   return (...args) =>
     new Promise((accept, reject) => {
       const callback = (err, ...results) => {
@@ -34,8 +34,3 @@ function multiPromisify(func) {
       func(...args, callback);
     });
 }
-
-module.exports = {
-  prepareConfig,
-  multiPromisify
-};
diff --git a/packages/workflow-compile/test/index.js b/packages/workflow-compile/test/index.js
diff --git a/packages/workflow-compile/test/index.ts b/packages/workflow-compile/test/index.ts
diff --git a/packages/workflow-compile/tsconfig.json b/packages/workflow-compile/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-const WorkflowCompile = require("@truffle/workflow-compile");`
	`1`	`+const WorkflowCompile = require("@truffle/workflow-compile").default;`
`2`	`2`	`const { Resolver } = require("@truffle/resolver");`
`3`	`3`	`const glob = require("glob");`
`4`	`4`	`const path = require("path");`