Skip to content

Consensys/solidity-metrics

Folders and files

NameName
Last commit message
Last commit date

Latest commit

d36289d · Jul 14, 2022

History

50 Commits
Jul 14, 2022
May 5, 2020
Jul 14, 2022
Nov 17, 2020
Jul 14, 2022
Jul 14, 2022

Repository files navigation

get in touch with Consensys Diligence
[ 🌐 📩 🔥 ]

Solidity Code Metrics

🌐 npm install solidity-code-metrics

The number-crunching enginge behind 📊tintinweb.solidity-metrics.

vscode-solidity-metrics3

Example

CLI

#> node ./src/cli.js <path to solidity file(s)>

Library

const {SolidityMetricsContainer} = require('solidity-metrics');

let options = {
    basePath:"",
    inputFileGlobExclusions:undefined,
    inputFileGlob: undefined,
    inputFileGlobLimit: undefined,
    debug:false,
    repoInfo: {
        branch: undefined,
        commit: undefined,
        remote: undefined
    }    
}

let metrics = new SolidityMetricsContainer("metricsContainerName", options);


// analyze files
metrics.analyze(path_to_solidity_file);
// ...
metrics.analyze(path_to_solidity_file_N);

// output
console.log(metrics.totals());
metrics.generateReportMarkdown().then(text => console.log(text));
// or let text = await metrics.generateReportMarkdown();