Skip to content

Latest commit

 

History

History
617 lines (425 loc) · 27.9 KB

File metadata and controls

617 lines (425 loc) · 27.9 KB

[6.2.2] - 2026-06-14

🧹 Chore: Dowser poster added. Solhint needs funds to keep growing

🧹 Chore: bump fast-uri from 3.0.6 to 3.1.2

🧹 Chore: bump lodash from 4.17.23 to 4.18.1

🛠️ Fix: Removed ajv-errors due to (#750)

🆕 Rule: added no-unchecked-calls Check return value of low-level calls (call, staticcall, delegatecall)

[6.2.1] - 2026-04-01

🧹 Chore: added poster

[6.2.0] - 2026-03-30

🛠️ Fix: code-complexity rule no longer crashes when configured with a numeric option (e.g. ["error", 8]) (#758)

🧹 Chore: bump glob to 13.0.6 — removes deprecated inflight transitive dependency

🧹 Chore: bump rimraf to 6.1.3 (devDep)

🧹 Chore: bump brace-expansion, picomatch and flatted to patched versions via overrides

🧰 Infra: drop Node.js 16 and 18 support (both EOL). Minimum supported version is now Node.js 20. CI matrix updated to [20, 22]

[6.1.0] - 2026-03-17

🛠️ Fix: natspec rule no longer flags unnamed parameters, which Solidity prohibits documenting with @param (#749)

🛠️ Fix: natspec rule and import-path-check rules related issues (#750)

🛠️ Fix: scoped package names now supported for shareable configs (#741)

🛠️ Fix: misc minor issues and general polish (#739)

🧱 Enhancement: added pluginPaths config option for resolving plugins from custom locations. Supports editor integrations and external project setups. Failed plugins emit warnings instead of crashing (#751)

🧹 Chore: bump ajv to 8.18.0

🧹 Chore: bump minimatch to 10.2.4

🧹 Chore: bump loadash to 4.17.23

🧹 Chore: update LICENSE copyright year to 2026 (thanks xiaobei0715!!) (#745)

✨🛡️ Kudos to our contributors! 🛡️✨

[6.0.3] - 2026-01-20

🛠️ Fix: removed unused files, normalized schema for validation, load-rules, base-checker and validator improvements

🛠️ Fix: removing console log from use-natspec rule (thanks brossetti1!!)

🛠️ Fix: misc minor issues and typos. General polish and stability

✨🛡️ Kudos to our contributors! 🛡️✨

[6.0.2] - 2025-12-17

🛠️ Fix: corrected use-natspec enforcement behavior on internal functions

🛠️ Fix: misc minor issues and typos. General polish and stability

🆕 Rule: added foundry-no-block to detect usage of block.timestamp and block.number in Solidity tests

🆕 Rule: added no-unused-private-functions to prevent unused private function declarations

🆕 Rule: added no-immutable-before-declaration to enforce correct immutable declaration order

🧱 Enhancement: improvements to foundry-test-function rule, including naming and configuration updates

🧰 Infra: update GitHub Actions in CI workflows to v5 and v6. Keeps CI aligned with latest ecosystem changes

🧰 Infra: bump js-yaml dependency following security recommendations

🧹 Chore: stop publishing the test directory to npm packages. Reduces package size and noise

🧹 Chore: foundry-test-functions is deprecated and will be removed in v7.0.0. Please rename to foundry-test-function-naming. WILL BE REPLACED IN v7

✨🛡️ Kudos to our contributors! 🛡️✨

[6.0.1] - 2025-08-22

🛠️ Fix: no-unused-vars for modifiers

🛠️ Fix: no-unused-imports handled for multiline @inheritdoc. Eliminates missed detections with multiline inheritance docs

🛠️ Fix: func-name-mixedcase improvement, added snake case exception in interface (naming). Aligns interface naming edge cases

🛠️ Fix: misc minor issues; docs link and typos. General polish and stability

🧰 Infra: Update GitHub Actions in CI workflows. Keeps CI up to date and consistent across jobs

🧰 Infra: Ignore enhancement to mimic as regular linters

🧹 Chore: Remove fs-extra dependency. Simplifies deps

🧹 Chore: Remove strip-ansi. Cleans unused/legacy deps

🧹 Chore: Changed changelog format

🧱 Enhancement: added config for no-unused-vars to validate parameters or not

🧱 Validation: Improve AJV schema validation and related caching approach. More robust/faster config validation

✨🛡️ Kudos to our contributors! 🛡️✨

[6.0.0] - 2025-07-04

BREAKING CHANGE

Some rules were removed from the recommended ruleset and other were promoted. See below: Rules revision - #692

🟥 DEMOTED

  • payable-fallback: Outdated due to the introduction of receive(); rarely needed in modern Solidity.

✅ PROMOTED

  • interface-starts-with-i: Promotes clarity by clearly distinguishing interfaces from contracts.
  • gas-calldata-parameters: Encourages optimal memory usage for external functions.
  • gas-increment-by-one: Suggests using ++i style for gas-efficient increments.
  • gas-indexed-events: Improves event indexing for off-chain systems and reduces gas usage.
  • gas-small-strings: Recommends cheaper encoding using bytes32 for short strings.
  • gas-strict-inequalities: Helps avoid subtle off-by-one bugs in range conditions.
  • gas-struct-packing: Maximizes storage efficiency by suggesting tight struct packing.
  • duplicated-imports: Prevents redundant imports that bloat the AST and confuse code structure.
  • import-path-check: Ensures all imported files exist and resolve correctly, avoiding runtime errors.
  • function-max-lines: Encourages smaller, more readable and maintainable functions.
  • constructor-syntax: Enforces modern constructor syntax for consistency and clarity.
  • use-natspec: Promotes proper documentation with NatSpec for better audits and readability.

Fixed

  • gas-struct-packing false positives - #690
  • gas-increment-by-one backward expression - #691
  • Typo (thanks to @MarkFizz77)

Added

  • use-natspec: Promote the use of natspec and make several checks to enforce it - #689



[5.2.0] - 2025-06-27

Fixed

  • imports-order interference with no-unused-imports - #684

Added

  • Added cache flag allowing to skip already evaluated files if no error was thrown and file did not change - #685
  • Added multi-directory config support by hierarchy - #678
  • Added better error handling on invalid configs - #683

Thanks to @smol-ninja - @PaulRBerg @lechpzn, @otc-png, @MamunC0der, @kks-code, @RidaMichofi

For making the time of proposing rules, pointing out typos, broken links, unused code, copyright, small reviews, etc. We really appreciate your contributions!



[5.1.0] - 2025-05-05

Added

  • Argument to avoid discord poster - #646
  • Auto-fix for no-unused-import - #648 (Thanks to @DenisGorbachev)
  • New Rule: import-path-check - #657

Updated

  • yml and parser update - #668 (Thanks to @zeevick10)
  • cleanup deprecated code - #655
  • Improved ordering rule - #656

BREAKING CHANGE

  • Removed code for solhint:default ruleset - #654

Thanks to @fanqiaojun, @maximevtush, @MaxweLL22-22, @PixelPil0t1, @wgyt, @operagxsasha, @Hopium21, @leopardracer, @omahs, @zeevick10, @gap-editor, @Olexandr88, @jirutka

For making the time of pointing out typos, license update, broken links, unused code, copyright, small reviews, etc. We really appreciate your contributions!



[5.0.5] - 2025-01-16

Fixed

  • gas-custom-errors #620 - Support for Custom Errors inside require statements
  • compiler-version #621 - Upgraded minimum requirement for the rule
  • reentrancy #622 - Fixed path and typos
  • Typos #623 - Fixed typos
  • Typo #625 - Fixed typo

Added

  • New Rule: Duplicated Imports #626
  • Cute Message on console report to gather community into discord channel



[5.0.4] - 2024-12-31

Fixed

  • imports-order #595 - Replaced single quotes with double quotes
  • gas-custom-errors #613 - Allows the use of Requirement with Custom Errors
  • Typos and broken links #611 - #617
  • Upgraded solidity-parser dependency #612

Added

  • .pre-commit-hooks.yaml to allow projects to run Solhint via pre-commit #596 (Thanks to @dbast)
  • Removed husky since it is not needed #612



[5.0.3] - 2024-08-03

Fixed

  • imports-order #593



[5.0.2] - 2024-07-25

Fixed

Added

  • New Rule: Imports order #587



[5.0.1] - 2024-05-13

BREAKING CHANGES (refer to v5.0.0)

Fixed an issue on the returning values where only was evaluating the first report instead of all of them.



[5.0.0] - 2024-05-11

BREAKING CHANGES

Solhint EXIT codes

Solhint changed how the exit codes are implemented:

Exit with 0 code When execution was ok and there were no errors when evaluating the code according to the rules
Exit with 1 code When execution was ok and there are errors reported
Exit with 1 code When execution was ok and max warnings is lower than the reported warnings
Exit with 255 code When there's an error in the execution (bad config, writing not allowed, wrong parameter, file not found, etc)

Solhint QUIET mode

QUIET mode (-c quiet) option now works with the warnings and may exit with 1 if there are more than defined by user

Thanks to @juanpcapurro for providing the code



[4.5.4] - 2024-04-10

Fixed

  • gas-custom-errors improved logic to ranged pragma versions #573
  • gas-indexed-events #573

[4.5.2] - 2024-03-15

Updated

  • Update Readme file to include all autofix rules
  • Update docker file
  • Update package json file

[4.5.0] - 2024-03-15

Updated

  • Update dependencies in package json #548
  • Custom errors rules checks from 0.8.4 forward before warning #555
  • Parser support up to Solidity 0.8.22 (*)

(*) Note: Solhint can work with latest Solidity versions. If new grammar/syntax is added or changed, it could give some false positives or miss a rule. But overall functionality will work as expected.

Added

  • New Rule: Interface starts with i #557

Gas Consumption Rules

  • New Rule: [GC] Multitoken1155 rule #541
  • New Rule: [GC] Small strings check #542
  • New Rule: [GC] Indexed events #543
  • New Rule: [GC] Calldata parameters #544
  • New Rule: [GC] Increment by one #545
  • New Rule: [GC] Struct packing #546
  • New Rule: [GC] Name Return Values #552
  • New Rule: [GC] Custom Errors #553 #555
  • New Rule: [GC] Dot Length in Loops #559
  • New Rule: [GC] Gas Strict Inequalities #560

Fixed

  • explicit-types logic improved and bug free #551
  • payable fallback Improved behavior #561

BREAKING CHANGES

  • named-return-values rule was renamed to gas-named-return-values and now it is part of Gas Consumption ruleset #552
  • custom-errors rule was renamed to gas-custom-errors and now it is part of Gas Consumption ruleset #553
  • Return error 0 when executed correctly #554
  • Default severity modified to WARN instead of OFF for foundry-test-functions and named-parameters-mapping rules #556

[4.1.1] - 2024-01-08

Fixed

  • Fix changelog typos

[4.1.0] - 2024-01-08

Updated

  • Included Sarif formatter #530 (Thanks to @eshaan7)
  • Cache npm on workflows #534

Added

  • Official Docker Image #524 (Thanks to @kaypee90)
  • Autofix for payable-fallback rule #528
  • Autofix for quotes rule #529
  • Autofix for avoid-suicide rule #531
  • Autofix for contract-name-camelcase rule #532
  • Autofix for event-name-camelcase rule #533

Fixed

  • Fix private vars leading underscore on libraries #525

[4.0.0] - 2023-10-01

Updated

  • Enhance explicit types sensitivity #493 (Thanks to @vladyan18)
  • Docs on private-vars-leading-underscore rule to clarify its functionality
  • Changelog and docs for no-empty-blocks rule to clarify its functionality
  • Require package with full path #515 (Thanks to @zouguangxian)

Added

  • Check for updates on Solhint version to keep users up to date. There's an option to disable this check (--disc) #506
  • fix option now shows the report on screen #509
  • save option to store report on disk with the standard or the specified format #509
  • Autofix for explicit-types rule #504
  • Autofix for no-console rule #513
  • Autofix for private-vars-leading-underscore rule #511

Fixed

[3.6.2] - 2023-08-17

Added

  • New Rule: one-contract-per-file - Enforces the use of ONE contract per file #487

Fixed

  • foundry-test-functions - Modified regex to include invariant and statefulFuzz tests #484
  • quotes - To allow quotes inside double quotes and vice versa #485
  • JSON - Formatter returning JS object instead of standard json #490

[3.6.1] - 2023-08-11

BREAKING CHANGE

  • RULE: not-rely-on-time was REMOVED from RECOMMENDED ruleset
    This was long overdue.
    Beware!! If you are relying on this rule and it is not explicitly configured (meaning there's only solhint:recommended option).
    You should add this rule manually:
  {
    "extends": "solhint:recommended",
    "rules": { 
        "not-rely-on-time": "warn", 
        "compiler-version": "off" 
    },
  }

If not explicitly added, this rule will not be executed.

SPECIAL ATTENTION

  • RULE: compiler-version default was updated from ^0.5.2 to ^0.8.0

Updated

  • Rule: check-send-result added config clarification in the new Notes section #482
  • Rule: compiler-version default was updated from ^0.5.2 to ^0.8.0 #483

Added

  • New Rule: Enforces the use of Custom Errors over Require and Revert statements #475
  • New Rule: Enforces the test_ prefix on a file for Foundry users #476
  • New Rule: Enforces the naming of function return values #478
  • Notes option on docs to add more information of each rule. See foundry-test-functions. #476

Fixed

  • func-named-parameters - false positives on builtin functions #472
  • ordering - treat initializer weight same as constructor #474
  • check-send-result - false positive on `erc777.send()`` function #477
  • explicit-types - default value is now taking into account when no value is specified in config #481
  • compiler-version - default value is now taking into account when no value is specified in config #483

[3.5.1] - 2023-08-04

Updated

  • Ignores empty constructors when inheriting a base contract #418
  • Bump json5 from 2.1.3 to 2.2.3 #376
  • Bump json-schema and jsprim #370
  • Bump semver from 6.3.0 to 7.5.2 #438
  • Corrected "Category" of quotes rule, added default rules list on readme #443
  • 'Deprecated' column on `rules.md`` #444
  • Information about maxCharacters allowed on reason-string rule #446
  • E2E tests for max-warnings #455
  • Replaced blacklist and whitelist words #459
  • Removed runtime dependencies on load-rules #462
  • Allowed $ symbol as part of naming #465
  • Disabled no-empty-blocks rule for receive() function #466

Added

  • New Rule: No unused imports #417
  • New Rule: To treat immutable as constants #458
  • New Rule: Explicit-types. To forbid/enforce full type or alias for variables declaration #467
  • New Rule: Naming of Function parameters. Enforce arguments naming #468
  • JSON formatter support #440
  • Rules List with list-rules command #449
  • E2E tests for formatters and new Compact formatter #457

Fixed

  • maxWarnings parameter waiting review #439
  • –fix option not working in avoid-throw rule #442
  • Formatter option fixed for stdin command #450

[3.4.1] - 2023-03-06

Updated

  • Updated solidity parser to 0.16.0 #420

Added

  • Added github workflow to execute unit tests on each PR #412
  • Added macOS and windows into E2E github workflow #422

Fixed

  • False positive on for-loop Yul #400
  • Ordering-rule support for Top Level statements #393
  • Fix no-global-import to accept named global imports #416
  • Fix named-parameters-mapping to not enforce on nested mappings #421

[3.4.0] - 2023-02-17

Updated

  • Solhint dependencies to support newer versions #380
  • Linter fixed to get clearer source code #381
  • E2E, added formatters into repo, updated CI #385
  • Solhint dependencies to support newer versions #403

Added

  • New Rule: For banning "console.sol" and "import hardhat or foundry console.sol" #372
  • New Rule: No global imports #390
  • New Rule: Named parameters in v0.8.18 solidity version #403

Fixed

  • TypeError: cannot read property 'errorCount' of undefined #351
  • Directories with .sol in the name path treated as files #352
  • Doc generator and added a CI step to avoid crashing #389
  • Rule for banning "console.sol" and "import hardhat or foundry console.sol #391
  • Option –quiet works now with all files #392
  • Transfers with .call excluded from warning as low level code #394
  • Made func-visibility skip free functions #396
  • False positive on no-unused-vars for payable arguments without name #399

[3.3.8] - 2023-01-17

Fixed Docs and Typos

Updated



TIME GAP

[2.1.0] - 2019-05-30

Added

  • New compiler-version rule (see PR #112)

Fixed

  • Several fixes for the mark-callable-contracts rule (PRs #115, #117 and #119)

[2.0.0] - 2019-02-15

Stable release

[2.0.0-beta.1] - 2019-01-31

Fixed

  • Fix linter errors

[2.0.0-alpha.3] - 2019-01-23

Changed

  • Update config initializer #103

[2.0.0-alpha.2] - 2019-01-08

Changed

  • Remove prettier from rule

[2.0.0-alpha.1] - 2019-01-08

Fixed

  • Package version

[2.0.0-alpha.0] - 2019-01-08

Added

  • Add rulesets #73
  • Add plugins support #99
  • Update docs

[1.5.0] - 2018-12-26

Added

  • Add not-rely-on-time to rules documentation #88
  • Have --max-warnings better reflect its name #89
  • Added disable-previous-line #91
  • Snake case now allows for a (single) leading underscore #93

Fixed

  • Fixed some comment directive tests #92

[1.4.1] - 2018-12-10

Added

  • Allow to specify the path to the config file #78
  • Roadmap and changelog #81

Changed

  • Upgrade grammar #79

[1.4.0] - 2018-10-10

Added

  • Support prettier-solidity #72

[1.3.0] - 2018-09-25

Added

  • Add "Projects that use solhint" to README.md file #64
  • Add prettier and airbnb #59
  • Add new feature --ignore-path option #58
  • Add contribution formatter parameter validation #54
  • Add --max-warnings [int] option #56
  • Add --quiet option #55

Changed

  • Move rules sections out from README.md #65
  • Complete docs and readme #61

Fixed

  • Unable to satisfy indentation rules for functions with multiple return values #49