{"id":27945740,"url":"https://github.com/solidstate-network/hardhat-spdx-license-identifier","last_synced_at":"2025-05-07T13:03:36.178Z","repository":{"id":40391735,"uuid":"264793817","full_name":"solidstate-network/hardhat-spdx-license-identifier","owner":"solidstate-network","description":"©️ Prepend local Solidity source files with an SPDX License Identifier 🔨","archived":false,"fork":false,"pushed_at":"2025-05-07T03:21:45.000Z","size":608,"stargazers_count":18,"open_issues_count":2,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-07T13:03:25.479Z","etag":null,"topics":["blockchain","buidler","ethereum","hardhat","solc","solidity","spdx-license","spdx-licenses","wow"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/solidstate-network.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-05-18T01:30:46.000Z","updated_at":"2025-04-30T18:01:11.000Z","dependencies_parsed_at":"2023-10-14T20:21:12.851Z","dependency_job_id":"e76d663d-bf53-45fa-8bab-dce24a4cd3ee","html_url":"https://github.com/solidstate-network/hardhat-spdx-license-identifier","commit_stats":{"total_commits":71,"total_committers":7,"mean_commits":"10.142857142857142","dds":0.3802816901408451,"last_synced_commit":"071c02895de77a363885c474fa5d2f7abd43df3a"},"previous_names":["itsnickbarry/buidler-spdx-license-identifier","solidstate-network/hardhat-spdx-license-identifier"],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidstate-network%2Fhardhat-spdx-license-identifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidstate-network%2Fhardhat-spdx-license-identifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidstate-network%2Fhardhat-spdx-license-identifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidstate-network%2Fhardhat-spdx-license-identifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/solidstate-network","download_url":"https://codeload.github.com/solidstate-network/hardhat-spdx-license-identifier/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252883227,"owners_count":21819158,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockchain","buidler","ethereum","hardhat","solc","solidity","spdx-license","spdx-licenses","wow"],"created_at":"2025-05-07T13:03:35.514Z","updated_at":"2025-05-07T13:03:36.164Z","avatar_url":"https://github.com/solidstate-network.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hardhat SPDX License Identifier\n\nPrepend Solidity source files in Hardhat projects with the SPDX License Identifier specified in `package.json`.\n\n\u003e Versions of this plugin prior to `2.0.0` were released as `buidler-spdx-license-identifier`.\n\n## Installation\n\n```bash\nnpm install --save-dev hardhat-spdx-license-identifier\n# or\nyarn add --dev hardhat-spdx-license-identifier\n```\n\n## Usage\n\nLoad plugin in Hardhat config:\n\n```javascript\nrequire('hardhat-spdx-license-identifier');\n```\n\nAdd configuration under the `spdxLicenseIdentifier` key:\n\n| option         | description                                                                                            | default |\n| -------------- | ------------------------------------------------------------------------------------------------------ | ------- |\n| `overwrite`    | whether to overwrite existing SPDX license identifiers                                                 | `false` |\n| `runOnCompile` | whether to automatically prepend identifiers during compilation                                        | `false` |\n| `only`         | `Array` of `String` matchers used to select included paths, defaults to all contracts if `length` is 0 | `[]`    |\n| `except`       | `Array` of `String` matchers used to exclude paths                                                     | `[]`    |\n\n```javascript\nspdxLicenseIdentifier: {\n  overwrite: true,\n  runOnCompile: true,\n  except: ['vendor/']\n}\n```\n\nThe included Hardhat task may be run manually:\n\n```bash\nnpx hardhat prepend-spdx-license\n# or\nyarn run hardhat prepend-spdx-license\n```\n\nFiles 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.\n\n## Development\n\nInstall dependencies via Yarn:\n\n```bash\nyarn install\n```\n\nSetup Husky to format code on commit:\n\n```bash\nyarn prepare\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidstate-network%2Fhardhat-spdx-license-identifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsolidstate-network%2Fhardhat-spdx-license-identifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidstate-network%2Fhardhat-spdx-license-identifier/lists"}