Change variable name and add some comments

trufflesuite · Sep 15, 2020 · 99df0e5 · 99df0e5
1 parent 84c23ba
commit 99df0e5
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 8 deletions.
diff --git a/packages/compile-solidity/index.js b/packages/compile-solidity/index.js
@@ -9,6 +9,8 @@ const { run } = require("./run");
 const { normalizeOptions } = require("./legacy/options");
 
 const Compile = {
+  // this takes an object with keys being the name and values being source
+  // material as well as an options object
   async sources({ sources, options }) {
     const compilation = await run(sources, normalizeOptions(options));
     return compilation.contracts.length > 0
@@ -25,7 +27,7 @@ const Compile = {
     ];
 
     return await Compile.sourcesWithDependencies({
-      sources: paths,
+      paths,
       options: Config.default().merge(options)
     });
   },
@@ -36,12 +38,13 @@ const Compile = {
     const paths = await Profiler.updated(options);
 
     return await Compile.sourcesWithDependencies({
-      sources: paths,
+      paths,
       options: Config.default().merge(options)
     });
   },
 
-  async sourcesWithDependencies({ sources, options }) {
+  // this takes an array of paths and options
+  async sourcesWithDependencies({ paths, options }) {
     options.logger = options.logger || console;
     options.contracts_directory = options.contracts_directory || process.cwd();
 
@@ -54,7 +57,7 @@ const Compile = {
     const config = Config.default().merge(options);
     const { allSources, compilationTargets } = await Profiler.requiredSources(
       config.with({
-        paths: sources,
+        paths,
         base_path: options.contracts_directory,
         resolver: options.resolver
       })

diff --git a/packages/compile-solidity/test/test_JSparser.js b/packages/compile-solidity/test/test_JSparser.js
@@ -36,7 +36,7 @@ describe("JSparser", () => {
     const config = Config.default().merge(options);
 
     const { compilations } = await Compile.sourcesWithDependencies({
-      sources: paths,
+      paths,
       options: config
     });
     const contractWasCompiled = compilations.some(compilation => {
@@ -63,7 +63,7 @@ describe("JSparser", () => {
 
     try {
       await Compile.sourcesWithDependencies({
-        sources: paths,
+        paths,
         options: config
       });
       assert(false, "this call should have failed!");

diff --git a/packages/compile-solidity/test/test_supplier.js b/packages/compile-solidity/test/test_supplier.js
@@ -271,7 +271,7 @@ describe("CompilerSupplier", function () {
         options = Config.default().merge(options);
 
         const { compilations } = await Compile.sourcesWithDependencies({
-          sources: paths,
+          paths,
           options
         });
         const ComplexOrdered = findOne(

diff --git a/packages/core/lib/testing/SolidityTest.js b/packages/core/lib/testing/SolidityTest.js
@@ -117,7 +117,7 @@ const SolidityTest = {
       : "OldSafeSend.sol";
 
     const { compilations } = await Compile.sourcesWithDependencies({
-      sources: [
+      paths: [
         path.join(__dirname, "Assert.sol"),
         path.join(__dirname, "AssertAddress.sol"),
         path.join(__dirname, "AssertAddressArray.sol"),