adhara-solidity-coverage

v0.7.18

This project is a fork of [sc-forks/solidity-coverage](https://github.com/sc-forks/solidity-coverage) For more information about how to use this package see README

Latest version published 3 years ago

License: MIT

NPM

GitHub

Package Health Score

39 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Limited

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.7.18	\|	12/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (1)

GitHub Stars: 0
Forks: 0
Contributors: 40

Direct Usage Popularity

The npm package adhara-solidity-coverage receives a total of 1 downloads a week. As such, we scored adhara-solidity-coverage popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package adhara-solidity-coverage, we found that it has been starred ? times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 40
Funding: No

With more than 10 contributors for the adhara-solidity-coverage repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like adhara-solidity-coverage is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 0
Open PR: 0
Last Release: 3 years ago
Last Commit: 2 years ago

Further analysis of the maintenance status of adhara-solidity-coverage based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for adhara-solidity-coverage is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 19 Direct
Versions: 3
Install Size: 38.2 MB
Dist-tags: 1
# of Files: 38
Maintainers: 1
TS Typings: No

adhara-solidity-coverage has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

adhara-solidity-coverage

This project is a fork of sc-forks/solidity-coverage

Code coverage for Solidity testing

coverage example

For more details about what this is, how it works and potential limitations, see the accompanying article.
solidity-coverage is Solcover

Install

$ npm install --save-dev solidity-coverage

Resources:

0.7.0 release notes
A guide to upgrading from 0.6.x to 0.7.x
0.6.3 docs

Truffle V5

Add this package to your plugins array in truffle-config.js (Truffle docs)

module.exports = {
  networks: {...},
  plugins: ["solidity-coverage"]
}

Run

truffle run coverage [command-options]

Hardhat

Beginning with v0.7.12, this tool supports Hardhat and runs directly on HardhatEVM.

Require the plugin in hardhat.config.js (Hardhat docs)

require('solidity-coverage')

Run

npx hardhat coverage [command-options]

(Additional Hardhat-specific info can be found here)

Buidler [Deprecated]

Add the plugin in buidler.config.js (Buidler docs)

usePlugin('solidity-coverage')

module.exports = {
  networks: {
    coverage: {
      url: 'https://localhost:8555'
    }
  },
}

Run

npx buidler coverage --network coverage [command-options]

Buidler Project Examples:

Simple: buidler-metacoin
More complex: MolochDao/moloch

@openzeppelin/test-environment

OpenZeppelin have written their own coverage generation scripts for test-environment using the solidity-coverage API. A working example can be found at openzeppelin-contracts, here.

Usage notes:

Coverage runs tests a little more slowly.
Coverage launches its own in-process ganache server.
You can set ganache options using the providerOptions key in your .solcover.js config.
Coverage distorts gas consumption. Tests that check exact gas consumption should be skipped.
⚠️ Contracts are compiled without optimization. Please report unexpected compilation faults to issue 417

Command Options

Option	Example	Description
file	`--file="test/registry/*.js"`	(Truffle) Filename or glob describing a subset of tests to run. (Globs must be enclosed by quotes and use globby matching patterns)
testfiles	`--testfiles "test/registry/*.ts"`	(Buidler) Test file(s) to run. (Globs must be enclosed by quotes and use globby matching patterns)
solcoverjs	`--solcoverjs ./../.solcover.js`	Relative path from working directory to config. Useful for monorepo packages that share settings. (Path must be "./" prefixed)
network	`--network development`	Use network settings defined in the Truffle or Buidler config
temp^*	`--temp build`	⚠️ Caution ⚠️ 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...

^* Advanced use

Config Options

Additional options can be specified in a .solcover.js config file located in the root directory of your project.

Example:

module.exports = {
  skipFiles: ['Routers/EtherRouter.sol']
};

Option	Type	Default	Description
silent	Boolean	false	Suppress logging output
client	Object	`require("ganache-core")`	Useful if you need a specific ganache version.
providerOptions	Object	`{ }`	ganache-core options
skipFiles	Array	`['Migrations.sol']`	Array of contracts or folders (with paths expressed relative to the `contracts` directory) that should be skipped when doing instrumentation.
measureStatementCoverage	boolean	`true`	Computes statement (in addition to line) coverage. More...
measureFunctionCoverage	boolean	`true`	Computes function coverage. More...
istanbulFolder	String	`./coverage`	Folder location for Istanbul coverage reports.
istanbulReporter	Array	`['html', 'lcov', 'text', 'json']`	Istanbul coverage reporters
mocha	Object	`{ }`	Mocha options to merge into existing mocha config. `grep` and `invert` are useful for skipping certain tests under coverage using tags in the test descriptions.
coverageContractsTemp	String	`.coverage_contracts`	Temporary folder location for instrumented contracts - Note that this directory will automatically be deleted when coverage completes.
onServerReady^*	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...
onPreCompile^*	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...
onCompileComplete^*	Function		Hook run after compilation completes, before tests are run. Useful if you have secondary compilation steps or need to modify built artifacts. More...
onTestsComplete^*	Function		Hook run after the tests complete, before Istanbul reports are generated. More...
onIstanbulComplete^*	Function		Hook run after the Istanbul reports are generated, before the ganache server is shut down. Useful if you need to clean resources up. More...
configureYulOptimizer	Boolean	false	(Experimental) Setting to `true` should resolve "stack too deep" compiler errors in large projects using ABIEncoderV2

^* Advanced use

API

Solidity-coverage's core methods and many utilities are available as an API.

const CoverageAPI = require('solidity-coverage/api');

Documentation available here.

FAQ

Common problems & questions:

Example reports

metacoin (Istanbul HTML)
openzeppelin-solidity(Coveralls)

Contribution Guidelines

Contributions are welcome! If you're opening a PR that adds features or options please consider writing full unit tests for them. (We've built simple fixtures for almost everything and are happy to add some for your case if necessary).

Set up the development environment with:

$ git clone https://github.com/sc-forks/solidity-coverage.git
$ yarn

Contributors

adhara-solidity-coverage dependencies

@solidity-parser/parser @truffle/provider chalk death detect-port fs-extra ganache-cli ghost-testrpc global-modules globby jsonschema lodash node-emoji pify recursive-readdir sc-istanbul semver shelljs web3-utils

adhara-solidity-coverage development dependencies

@nomiclabs/buidler @nomiclabs/buidler-truffle5 @nomiclabs/buidler-web3 @nomiclabs/hardhat-truffle5 @nomiclabs/hardhat-web3 @truffle/contract buidler-gas-reporter decache hardhat hardhat-gas-reporter mocha nyc solc truffle truffle-config

FAQs

What is adhara-solidity-coverage?

This project is a fork of [sc-forks/solidity-coverage](https://github.com/sc-forks/solidity-coverage). Visit Snyk Advisor to see a full health score report for adhara-solidity-coverage, including popularity, security, maintenance & community analysis.

Is adhara-solidity-coverage popular?

The npm package adhara-solidity-coverage receives a total of 1 weekly downloads. As such, adhara-solidity-coverage popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is adhara-solidity-coverage well maintained?

We found indications that adhara-solidity-coverage is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is adhara-solidity-coverage safe to use?

While scanning the latest version of adhara-solidity-coverage, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 14 December-2024, at 08:44 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

adhara-solidity-coverage

Code coverage for Solidity testing

Install

Truffle V5

Hardhat

Buidler [Deprecated]

@openzeppelin/test-environment

Usage notes:

Command Options

Config Options

API

FAQ

Example reports

Contribution Guidelines

Contributors

adhara-solidity-coverage dependencies

adhara-solidity-coverage development dependencies

FAQs

What is adhara-solidity-coverage?

Is adhara-solidity-coverage popular?

Is adhara-solidity-coverage well maintained?

Is adhara-solidity-coverage safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues