Merge branch 'master' of https://github.com/sc-forks/solidity-coverage

README.md

@@ -9,11 +9,11 @@
 For more details about what this is, how it works and potential limitations, see 
 [the accompanying article](https://blog.colony.io/code-coverage-for-solidity-eecfa88668c2).
 
-(solidity-coverage is a stand-alone fork of [Solcover](https://github.com/JoinColony/solcover))
+**solidity-coverage** is a stand-alone fork of [Solcover](https://github.com/JoinColony/solcover)
 
 ### Install
 ```
-$ npm install --save-dev https://github.com/sc-forks/solidity-coverage.git
+$ npm install --save-dev solidity-coverage
 ```
 
 ### Run 
@@ -71,8 +71,6 @@ testrpc is set to run on, e.g:
 + **norpc**: {Boolean} When true, solidity-coverage will not launch its own testrpc instance. This
 can be useful if you are running tests using a different vm like the 
 [`sc-forks` version of `pyethereum`](https://github.com/sc-forks/pyethereum). (Default: false).  
-+ **isTruffle**: {Boolean}: Set to false if your project does not have a migrations folder or a 
-`truffle.js` config file.
 + **dir**: {String} : By default, solidity-coverage looks for a `contracts` folder in your root
 directory. `dir` allows you to define a relative path from the root directory to the contracts
 folder. A `dir` of `./secretDirectory` would tell solidity-coverage to look for `./secretDirectory/contracts`
@@ -85,7 +83,7 @@ module.exports = {
     port: 6545,
     testrpcOptions: '-p 6545 -u 0x54fd80d6ae7584d8e9a19fe1df43f04e5282cc43',
     testCommand: 'mocha --timeout 5000',
-    norpc: true
+    norpc: true,
     dir: './secretDirectory'
 };
 ```
@@ -116,10 +114,7 @@ your tests actually reach all the conditional branches in your code. It can be f
 
 **WARNING**: This utility is in development and its accuracy is unknown. If you 
 find discrepancies between the coverage report and your suite's behavior, please open an 
-[issue](https://github.com/sc-forks/solidity-coverage/issues). The purpose of 
+[issue](https://github.com/sc-forks/solidity-coverage/issues). 
-the following examples is to help you install solidity-coverage in your own project and evaluate the 
-coverage of your own tests. The reports below are **not** meaningful analyses of the 
-the past or present state of any project's testing regime.  
 
 + **metacoin**: The default truffle project
   + [HTML reports](https://sc-forks.github.io/metacoin/)
@@ -135,14 +130,10 @@ the past or present state of any project's testing regime.
 
 Contributions are welcome! If you're opening a PR that adds features please consider writing some
 [unit tests](https://github.com/sc-forks/solidity-coverage/tree/master/test) for them. You could 
-also lint your submission by running 'npm run lint'. Bugs can be reported in the 
+also lint your submission with `npm run lint`. Bugs can be reported in the 
-[issues](https://github.com/sc-forks/solidity-coverage/issues)  
+[issues](https://github.com/sc-forks/solidity-coverage/issues).  
 
 ### Contributors
 + [@area](https://github.com/area)
 + [@cgewecke](https://github.com/cgewecke)
 + [@adriamb](https://github.com/adriamb)
-
-### TODO
-
-- [ ] Release on NPM 

bin/exec.js

@@ -56,7 +56,6 @@ const config = reqCwd.silent('./.solcover.js') || {};
 const workingDir = config.dir || '.';       // Relative path to contracts folder
 const port = config.port || 8555;           // Port testrpc listens on
 const accounts = config.accounts || 35;     // Number of accounts to testrpc launches with
-const isTruffle = config.isTruffle || true; // Is target a truffle project?
 
 // Set testrpc options
 const defaultRpcOptions = `--gasLimit ${gasLimitString} --accounts ${accounts} --port ${port}`;
@@ -82,39 +81,42 @@ if (!config.norpc) {
 // environment folder.
 log('Generating coverage environment');
 try {
-  // Common environment: /contracts/ & /test/
+  
+  // Truffle environment: 
+  // contracts/  
+  // test/ 
+  // migrations/ 
+  // truffle.js
+  
   shell.mkdir(`${coverageDir}`);
   shell.cp('-R', `${workingDir}/contracts`, `${coverageDir}`);
   shell.cp('-R', `${workingDir}/test`, `${coverageDir}`);
+  shell.cp('-R', `${workingDir}/migrations`, `${coverageDir}`);
 
-  // Truffle environment: + /migrations/, truffle.js
+  const truffleConfig = reqCwd(`${workingDir}/truffle.js`);
-  if (isTruffle) {
+
-    shell.cp('-R', `${workingDir}/migrations`, `${coverageDir}`);
+  // Coverage network opts specified: copy truffle.js whole to coverage environment
-    const truffleConfig = reqCwd(`${workingDir}/truffle.js`);
+  if (truffleConfig.networks.coverage) {
-
+    shell.cp(`${workingDir}/truffle.js`, `${coverageDir}/truffle.js`);
-    // Coverage network opts specified: copy truffle.js whole to coverage environment
+
-    if (truffleConfig.networks.coverage) {
+  // Coverage network opts NOT specified: default to the development network w/ modified
-      shell.cp(`${workingDir}/truffle.js`, `${coverageDir}/truffle.js`);
+  // port, gasLimit, gasPrice. Export the config object only.
-
+  } else {
-    // Coverage network opts NOT specified: default to the development network w/ modified
+    const trufflejs = `
-    // port, gasLimit, gasPrice. Export the config object only.
+      module.exports = {
-    } else {
+        networks: {
-      const trufflejs = `
+          development: {
-        module.exports = {
+            host: "localhost", 
-          networks: {
+            network_id: "*",
-            development: {
+            port: ${port},
-              host: "localhost", 
+            gas: ${gasLimitHex},
-              network_id: "*",
+            gasPrice: ${gasPriceHex}
-              port: ${port},
-              gas: ${gasLimitHex},
-              gasPrice: ${gasPriceHex}
-            }
           }
-        };`;
+        }
+      };`;
 
-      coverageOption = '';
+    coverageOption = '';
-      fs.writeFileSync(`${coverageDir}/truffle.js`, trufflejs);
+    fs.writeFileSync(`${coverageDir}/truffle.js`, trufflejs);
-    }
   }
 } catch (err) {
   const msg = ('There was a problem generating the coverage environment: ');