Package Health Score

48 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

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

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
0.6.0-beta.1	\|	01/2022	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: 451
Forks: 118
Contributors: 20

Direct Usage Popularity

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

Based on project statistics from the GitHub repository for the npm package algebra-solidity-docgen, we found that it has been starred 451 times.

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

Community

Sustainable

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

With more than 10 contributors for the algebra-solidity-docgen 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 algebra-solidity-docgen is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 33
Open PR: 7
Last Release: 3 years ago
Last Commit: 1 year ago

Further analysis of the maintenance status of algebra-solidity-docgen 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 algebra-solidity-docgen 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: 2 Direct
Versions: 2
Install Size: 108 kB
Dist-tags: 1
# of Files: 126
Maintainers: 1
TS Typings: No

algebra-solidity-docgen 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

`solidity-docgen`

solidity-docgen is a program that extracts documentation for a Solidity project.

The output is fully configurable through Handlebars templates, but the default templates should do a good job of displaying all of the information in the source code in Markdown format. The generated Markdown files can be used with a static site generator such as Vuepress, MkDocs, Jekyll (GitHub Pages), etc., in order to publish a documentation website.

Usage

Install solidity-docgen@next from npm.

Hardhat

Include the plugin in your Hardhat configuration.

 // hardhat.config.ts
+import 'solidity-docgen';

 export default {
+  docgen: { ... }, // if necessary to customize config
 };

Then run with hardhat docgen.

As a library

import { docgen } from 'solidity-docgen';

await docgen([{ output: solcOutput }], config);

solcOutput must be the standard JSON output of the compiler, with at least the ast output. There can be more than one.

config is an optional object with the values as specified below.

Config

See config.ts for the list of options and their documentation.

algebra-solidity-docgen dependencies

handlebars solidity-ast

algebra-solidity-docgen development dependencies

@types/mocha @types/node ava c8 code-style copyfiles hardhat openzeppelin-docs-utils ts-node typescript

FAQs

What is algebra-solidity-docgen?

Documentation generator for Solidity smart contracts. Visit Snyk Advisor to see a full health score report for algebra-solidity-docgen, including popularity, security, maintenance & community analysis.

Is algebra-solidity-docgen popular?

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

Is algebra-solidity-docgen well maintained?

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

Is algebra-solidity-docgen safe to use?

The npm package algebra-solidity-docgen was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 8 November-2024, at 07:43 (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

algebra-solidity-docgen

Documentation generator for Solidity smart contracts. For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Explore Similar Packages

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (1)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

`solidity-docgen`

Usage

Hardhat

As a library

Config

algebra-solidity-docgen dependencies

algebra-solidity-docgen development dependencies

FAQs

What is algebra-solidity-docgen?

Is algebra-solidity-docgen popular?

Is algebra-solidity-docgen well maintained?

Is algebra-solidity-docgen safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

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

solidity-docgen

Usage

Hardhat

As a library

Config

algebra-solidity-docgen dependencies

algebra-solidity-docgen development dependencies

FAQs

What is algebra-solidity-docgen?

Is algebra-solidity-docgen popular?

Is algebra-solidity-docgen well maintained?

Is algebra-solidity-docgen 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

`solidity-docgen`