solidity-coverage - npm Package Compare versions

Comparing version 0.8.7-viaIR.0 to 0.8.7

package.json

 {
   "name": "solidity-coverage",
-  "version": "0.8.7-viaIR.0",
+  "version": "0.8.7",
   "description": "Code coverage for Solidity testing",
@@ -5,0 +5,0 @@ "main": "plugins/nomiclabs.plugin.js",

README.md

@@ -35,2 +35,3 @@ # solidity-coverage
 ```
+
 **Resources**:
@@ -44,2 +45,22 @@ + [0.8.0 release notes][31]
 
+### Trouble shooting
+
+**Missing or unexpected coverage?** Make sure you're using the latest plugin version and run:
+```sh
+$ npx hardhat clean
+$ npx hardhat compile
+$ npx hardhat coverage
+```
+
+**Typescript compilation errors?**
+```sh
+$ npx hardhat compile
+$ TS_NODE_TRANSPILE_ONLY=true npx hardhat coverage
+```
+
+**Additional Help**
++ [FAQ][1007]
++ [Advanced Topics][1005]
+
+
 ## Command Options
@@ -51,3 +72,2 @@ | Option <img width=200/> | Example <img width=750/>| Description <img width=1000/> |
 | solcoverjs | `--solcoverjs ./../.solcover.js` | Relative path from working directory to config. Useful for monorepo packages that share settings. (Path must be "./" prefixed) |
-| temp[<sup>*</sup>][14]       | `--temp build`   | :warning: **Caution** :warning:  Path to a *disposable* folder to store compilation artifacts in. Useful when your test setup scripts include hard-coded paths to a build directory. [More...][14] |
 | matrix   | `--matrix` | Generate a JSON object that maps which mocha tests hit which lines of code. (Useful as an input for some fuzzing, mutation testing and fault-localization algorithms.) [More...][39]|
@@ -69,6 +89,6 @@
 
-| Option <img width=200/>| Type <img width=200/> | Default <img width=1300/> | Description <img width=800/> |
+| Option <img width=200/>| Type <img width=200/> | Default <img width=1000/> | Description <img width=1000/> |
 | ------ | ---- | ------- | ----------- |
 | silent | *Boolean* | false | Suppress logging output |
-| skipFiles | *Array* | `['Migrations.sol']` | Array of contracts or folders (with paths expressed relative to the `contracts` directory) that should be skipped when doing instrumentation. |
+| skipFiles | *Array* | `[]` | Array of contracts or folders (with paths expressed relative to the `contracts` directory) that should be skipped when doing instrumentation.(Example: `[ "Routers", "Networks/Polygon.sol"]` :bulb: **RUN THE HARDHAT CLEAN COMMAND AFTER UPDATING THIS** ) |
 | measureStatementCoverage | *boolean* | `true` | Computes statement (in addition to line) coverage. [More...][34] |
@@ -86,8 +106,8 @@ | measureFunctionCoverage | *boolean* | `true` | Computes function coverage. [More...][34] |
 | onServerReady[<sup>*</sup>][14] | *Function* |   | Hook run *after* server is launched, *before* the tests execute. Useful if you need to use the Oraclize bridge or have setup scripts which rely on the server's availability. [More...][23] |
-| onPreCompile[<sup>*</sup>][14] | *Function* |   | Hook run *after* filesystem and compiler configuration is applied, *before* the compiler is run. Can be used with the other hooks to be able to generate coverage reports on non-standard / customized directory structures, as well as contracts with absolute import paths. [More...][23] |
+| onPreCompile[<sup>*</sup>][14] | *Function* |   | Hook run *after* instrumentation is performed, *before* the compiler is run. Can be used with the other hooks to be able to generate coverage reports on non-standard / customized directory structures, as well as contracts with absolute import paths. [More...][23] |
 | onCompileComplete[<sup>*</sup>][14] | *Function* |  | Hook run *after* compilation completes, *before* tests are run. Useful if you have secondary compilation steps or need to modify built artifacts. [More...][23]|
 | onTestsComplete[<sup>*</sup>][14] | *Function* |  | Hook run *after* the tests complete, *before* Istanbul reports are generated. [More...][23]|
 | onIstanbulComplete[<sup>*</sup>][14] | *Function* |  | Hook run *after* the Istanbul reports are generated, *before* the coverage task completes. Useful if you need to clean resources up. [More...][23]|
-| configureYulOptimizer | *Boolean* | false | (Experimental) Setting to `true` should resolve "stack too deep" compiler errors in large projects using ABIEncoderV2 |
-| solcOptimizerDetails | *Object* | `undefined` |(Experimental) Must be used in combination with `configureYulOptimizer`. Allows you configure solc's [optimizer details][1001]. Useful if the default remedy for stack-too-deep errors doesn't work in your case (See FAQ below). |
+| configureYulOptimizer | *Boolean* | false | **(Deprecated since 0.8.7)** Setting to `true` should resolve "stack too deep" compiler errors in large projects using ABIEncoderV2 |
+| solcOptimizerDetails | *Object* | `undefined` |**(Deprecated since 0.8.7))** Must be used in combination with `configureYulOptimizer`. Allows you configure solc's [optimizer details][1001]. Useful if the default remedy for stack-too-deep errors doesn't work in your case (See FAQ below). |
 
@@ -119,18 +139,9 @@
 
-## FAQ
+## Example reports
++ [openzeppelin-solidity][10](Codecov)
 
-Common problems & questions:
+## Funding
 
-+ [Running in CI][7]
-+ [Running out of gas][13]
-+ [Running out of time][6]
-+ [Running out of stack][1002] (Stack too deep)
-+ [Running out of memory][5]
-+ [Running in parallel (in CI)][1003]
-+ [Running coverage threshold checks][1004]
+You can help fund solidity-coverage development through [DRIPS][1008]. It's a public goods protocol which helps distribute money to packages in your dependency tree. (It's great, check it out.)
 
-## Example reports
-+ [metacoin][9] (Istanbul HTML)
-+ [openzeppelin-solidity][10](Coveralls)
-
 ## Contribution Guidelines
@@ -190,2 +201,5 @@
 [1004]: https://github.com/sc-forks/solidity-coverage/blob/master/docs/advanced.md#coverage-threshold-checks
+[1005]: https://github.com/sc-forks/solidity-coverage/blob/master/docs/advanced.md
+[1007]: https://github.com/sc-forks/solidity-coverage/blob/master/docs/faq.md
+[1008]: https://www.drips.network/app/projects/github/sc-forks/solidity-coverage
 

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

708401

increased by379.28%

Number of package files

64

increased by93.94%

Lines of code

3409

increased by17.51%

Number of lines in readme file

199

increased by7.57%

No dependency changes