hardhat-spdx-license-identifier

v2.3.1

Prepend local Solidity source files with an SPDX License Identifier For more information about how to use this package see README

Latest version published 5 months ago

License: MIT

NPM

GitHub

Package Health Score

63 / 100

security
No known security issues
popularity
Limited
maintenance
Sustainable
community
Limited

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

All Versions

Version				Vulnerabilities	License Risk
2.3.1	\|	06/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.2.0	\|	10/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.1.0	\|	11/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.3	\|	01/2021		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 (535)

GitHub Stars: 18
Forks: 5
Contributors: 6

Direct Usage Popularity

The npm package hardhat-spdx-license-identifier receives a total of 535 downloads a week. As such, we scored hardhat-spdx-license-identifier popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package hardhat-spdx-license-identifier, we found that it has been starred 18 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: 6
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like hardhat-spdx-license-identifier is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 0
Open PR: 1
Last Release: 5 months ago
Last Commit: 22 days ago

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

We found that hardhat-spdx-license-identifier demonstrates a positive version release cadence with at least one new version released in the past 12 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: 4 years
Dependencies: 0 Direct
Versions: 9
Install Size: 14.9 kB
Dist-tags: 1
# of Files: 25
Maintainers: 1
TS Typings: Yes

hardhat-spdx-license-identifier 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

Hardhat SPDX License Identifier

Prepend Solidity source files in Hardhat projects with the SPDX License Identifier specified in package.json.

Versions of this plugin prior to 2.0.0 were released as buidler-spdx-license-identifier.

Installation

npm install --save-dev hardhat-spdx-license-identifier
# or
yarn add --dev hardhat-spdx-license-identifier

Usage

Load plugin in Hardhat config:

require('hardhat-spdx-license-identifier');

Add configuration under the spdxLicenseIdentifier key:

option	description	default
`overwrite`	whether to overwrite existing SPDX license identifiers	`false`
`runOnCompile`	whether to automatically prepend identifiers during compilation	`false`
`only`	`Array` of `String` matchers used to select included paths, defaults to all contracts if `length` is 0	`[]`
`except`	`Array` of `String` matchers used to exclude paths	`[]`

spdxLicenseIdentifier: {
  overwrite: true,
  runOnCompile: true,
  except: ['vendor/']
}

The included Hardhat task may be run manually:

npx hardhat prepend-spdx-license
# or
yarn run hardhat prepend-spdx-license

Files which do not contain a license identifier will be prepended with one. Files with a license identifier which does not match that which is specified in package.json may be updated, depending on configuration.

Development

Install dependencies via Yarn:

yarn install

Setup Husky to format code on commit:

yarn prepare

hardhat-spdx-license-identifier development dependencies

@trivago/prettier-plugin-sort-imports @types/chai @types/mocha @types/node chai hardhat husky lint-staged prettier prettier-plugin-solidity ts-node typescript

FAQs

What is hardhat-spdx-license-identifier?

Prepend local Solidity source files with an SPDX License Identifier. Visit Snyk Advisor to see a full health score report for hardhat-spdx-license-identifier, including popularity, security, maintenance & community analysis.

Is hardhat-spdx-license-identifier popular?

The npm package hardhat-spdx-license-identifier receives a total of 535 weekly downloads. As such, hardhat-spdx-license-identifier popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is hardhat-spdx-license-identifier well maintained?

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

Is hardhat-spdx-license-identifier safe to use?

The npm package hardhat-spdx-license-identifier 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 9 November-2024, at 09: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