This is a malicious package

soliddoc is a malicious package. This package contains a malicious code and uses "typosquatting" to bait unaware users to install it. Avoid using all malicious instances of the package.

Security

Security issues found

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.6.0-beta.36	\|	10/2024	Popular	1 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 (3)

GitHub Stars: 451
Forks: 118
Contributors: 20

Direct Usage Popularity

The npm package soliddoc receives a total of 3 downloads a week. As such, we scored soliddoc popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package soliddoc, 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 soliddoc 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 soliddoc is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

No Recent Commits

Open Issues: 33
Open PR: 8
Last Release: 19 days ago
Last Commit: 1 year ago

Further analysis of the maintenance status of soliddoc based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that soliddoc demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

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: 19 days
Dependencies: 4 Direct
Versions: 2
Install Size: 154 kB
Dist-tags: 1
# of Files: 165
Maintainers: 1
TS Typings: No

soliddoc 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.

This is a newer version of the tool that has been rewritten and redesigned. Some more work is pending to ease the transition from the previous version and to help with usage and configuration.

Usage

Install solidity-docgen 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.

soliddoc dependencies

handlebars solidity-ast axios ethers

soliddoc development dependencies

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

FAQs

What is soliddoc?

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

Is soliddoc popular?

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

Is soliddoc well maintained?

We found indications that soliddoc maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is soliddoc safe to use?

Security issues were found while scanning the latest version of soliddoc, and a total of 1 vulnerabilities were detected. It is highly advised to conduct a security review before using this package. View the full security scan results.

Last updated on 19 November-2024, at 01:55 (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

soliddoc

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

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?