{"id":19107459,"url":"https://github.com/smartcontractkit/chainlink-solhint-rules","last_synced_at":"2025-04-30T18:47:20.181Z","repository":{"id":67375275,"uuid":"546620987","full_name":"smartcontractkit/chainlink-solhint-rules","owner":"smartcontractkit","description":"CLL custom Solhint rules","archived":false,"fork":false,"pushed_at":"2024-02-20T00:54:12.000Z","size":22,"stargazers_count":7,"open_issues_count":8,"forks_count":5,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-04-15T00:04:46.338Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@chainlink/solhint-plugin-chainlink-solidity","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smartcontractkit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2022-10-06T11:26:12.000Z","updated_at":"2024-04-15T00:04:46.338Z","dependencies_parsed_at":"2023-02-28T18:30:20.397Z","dependency_job_id":"621f69a7-812a-4de9-bb32-e3c5d804ca2b","html_url":"https://github.com/smartcontractkit/chainlink-solhint-rules","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartcontractkit%2Fchainlink-solhint-rules","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartcontractkit%2Fchainlink-solhint-rules/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartcontractkit%2Fchainlink-solhint-rules/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartcontractkit%2Fchainlink-solhint-rules/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smartcontractkit","download_url":"https://codeload.github.com/smartcontractkit/chainlink-solhint-rules/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223783126,"owners_count":17201915,"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":[],"created_at":"2024-11-09T04:12:42.238Z","updated_at":"2024-11-09T04:12:42.787Z","avatar_url":"https://github.com/smartcontractkit.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Chainlink Solhint Rules\n\nA set of Solhint rules for Chainlink's Solidity Style Guide.\n\n[You can find a working Foundry example here](https://github.com/smartcontractkit/chainlink-solhint-rules-example).\n\n## Install to a new project\n\n```\nnpm init \u0026\u0026 npm install solhint solhint-plugin-chainlink-solidity@npm:@chainlink/solhint-plugin-chainlink-solidity --save\n```\n\nCreate a `.solhint.json` in your root project directory:\n\n```\n{\n  \"extends\": \"solhint:recommended\",\n  \"plugins\": [\"chainlink-solidity\"],\n  \"rules\": {\n    \"compiler-version\": [\"off\", \"^0.8.0\"],\n    \"const-name-snakecase\": \"off\",\n    \"constructor-syntax\": \"error\",\n    \"var-name-mixedcase\": \"off\",\n    \"func-visibility\": [\n      \"error\",\n      {\n        \"ignoreConstructors\": true\n      }\n    ],\n    \"max-line-length\": [\"error\", 160],\n    \"not-rely-on-time\": \"off\",\n    \"no-empty-blocks\": \"off\",\n    \"quotes\": [\"error\", \"single\"],\n    \"reason-string\": [\n      \"warn\",\n      {\n        \"maxLength\": 64\n      }\n    ],\n    \"chainlink-solidity/prefix-internal-functions-with-underscore\": \"warn\",\n    \"chainlink-solidity/prefix-private-functions-with-underscore\": \"warn\",\n    \"chainlink-solidity/prefix-storage-variables-with-s-underscore\": \"warn\",\n    \"chainlink-solidity/prefix-immutable-variables-with-i\": \"warn\",\n    \"chainlink-solidity/prefix-interfaces-with-i\": \"warn\",\n    \"chainlink-solidity/all-caps-constant-storage-variables\": \"warn\",\n    \"chainlink-solidity/no-hardhat-imports\": \"warn\",\n    \"chainlink-solidity/inherited-constructor-args-not-in-contract-definition\": \"warn\",\n    \"chainlink-solidity/no-block-single-if-reverts\": \"warn\",\n    \"chainlink-solidity/explicit-returns\": \"warn\"\n  }\n}\n```\n\nAdd the following to your `package.json`:\n\n```\n  \"scripts\": {\n    \"solhint\": \"solhint --config .solhint.json \\\"src/*.sol\\\"\"\n  },\n```\n\nThen, run:\n\n```\nnpm solhint\n\nsrc/Counter.sol\n  4:1  warning  Internal function increment is not prefixed with underscore (_)  chainlink-solidity/prefix-internal-functions-with-underscore\n  4:1  warning  Private / internal variable number is not prefixed with s_       chainlink-solidity/prefix-storage-variables-with-s-underscore\n  8:9  warning  Provide an error message for require                             reason-string\n```\n\n## Rules\n\n| Rule Id                                                 | Description                                                                           |\n|---------------------------------------------------------|---------------------------------------------------------------------------------------|\n| `prefix-internal-functions-with-underscore`             | Naming convention                                                                     |\n| `prefix-private-functions-with-underscore`              | Naming convention                                                                     |\n| `prefix-storage-variables-with-s-underscore`            | Naming convention                                                                     |\n| `prefix-immutable-variables-with-i`                     | Naming convention                                                                     |\n| `prefix-interfaces-with-i`                              | Naming convention                                                                     |\n| `all-caps-constant-storage-variables`                   | Naming convention                                                                     |\n| `no-hardhat-imports`                                    | Leftover `hardhat/*.sol` imports not allowed                                          |\n| `inherited-constructor-args-not-in-contract-definition` | Inherited contract constructor arguments should be specified in the constructor block |\n| `no-block-single-if-reverts`                            | Omit curly braces for single-line guard clauses                                       |\n| `explicit-returns`                                      | Always specify an expression after a `return`                                         |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartcontractkit%2Fchainlink-solhint-rules","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmartcontractkit%2Fchainlink-solhint-rules","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartcontractkit%2Fchainlink-solhint-rules/lists"}