Merge pull request #670 from protofire/develop

 Merge Develop to Master v5.1.0

Author: dbale-altoros

.eslintignore

@@ -1,5 +1,4 @@
 coverage
 node_modules
-scripts
 e2e
 /_temp

.github/workflows/DOCKER.yml

@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Login to Docker Hub
       run: docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_ACCESS_TOKEN }}

.github/workflows/E2E.yml

@@ -17,7 +17,7 @@ jobs:
         node: [16, 18, 20]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
@@ -42,7 +42,7 @@ jobs:
         run: solhint --version
 
       - name: Run E2E Tests
-        run: cd e2e && npm install && npm test
+        run: npm run ci:e2e
 
   e2e_windows:
     runs-on: windows-latest
@@ -52,7 +52,7 @@ jobs:
       - name: Enable Debugging
         run: |
           echo "::debug::Debugging enabled"
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v3
         with:
           node-version: 18
@@ -83,14 +83,14 @@ jobs:
         run: npm run lint
 
       - name: Run E2E Tests
-        run: cd e2e && npm install && npm test
+        run: npm run ci:e2e
 
   e2e_macos:
     runs-on: macos-latest
     name: Test on MacOS
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: actions/setup-node@v3
       with:
         node-version: 18
@@ -109,4 +109,4 @@ jobs:
       run: npm run lint
 
     - name: Run Tests
-      run: cd e2e && npm install && npm test
+      run: npm run ci:e2e

.github/workflows/TESTS.yml

@@ -19,7 +19,7 @@ jobs:
         node-version: [16, 18, 20]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
@@ -38,7 +38,7 @@ jobs:
     runs-on: windows-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: actions/setup-node@v3
       with:
         node-version: 18
@@ -57,7 +57,7 @@ jobs:
     runs-on: macos-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: actions/setup-node@v3
       with:
         node-version: 18

.gitignore

@@ -12,4 +12,4 @@ _temp/
 *solhintReport*.*
 .env
 **/.DS_Store
-
+solhint*.tgz

CHANGELOG.md

@@ -1,3 +1,28 @@
+## [5.1.0] - 2025-05-05
+### Added
+- Argument to avoid discord poster - [#646](https://github.com/protofire/solhint/pull/646)
+- Auto-fix for `no-unused-import` -  [#648](https://github.com/protofire/solhint/pull/648) (Thanks to [@DenisGorbachev](https://github.com/DenisGorbachev))
+- New Rule: import-path-check - [#657](https://github.com/protofire/solhint/pull/657)
+
+
+### Updated
+- yml and parser update - [#668](https://github.com/protofire/solhint/pull/668) (Thanks to [@zeevick10](https://github.com/zeevick10))
+- cleanup deprecated code - [#655](https://github.com/protofire/solhint/pull/655)
+- Improved `ordering` rule - [#656](https://github.com/protofire/solhint/pull/656)
+
+
+### BREAKING CHANGE
+
+ - Removed code for `solhint:default` ruleset - [#654](https://github.com/protofire/solhint/pull/654)
+
+
+Thanks to [@fanqiaojun](https://github.com/fanqiaojun), [@maximevtush](https://github.com/maximevtush), [@MaxweLL22-22](https://github.com/MaxweLL22-22), [@PixelPil0t1](https://github.com/PixelPil0t1), [@wgyt](https://github.com/wgyt), [@operagxsasha](https://github.com/operagxsasha), [@Hopium21](https://github.com/Hopium21), [@leopardracer](https://github.com/leopardracer), [@omahs](https://github.com/omahs), [@zeevick10](https://github.com/zeevick10), [@gap-editor](https://github.com/gap-editor), [@Olexandr88](https://github.com/Olexandr88), [@jirutka](https://github.com/jirutka)
+
+For making the time of pointing out typos, license update, broken links, unused code, copyright, small reviews, etc. We really appreciate your contributions!
+
+<br><br>
+
+
 ## [5.0.5] - 2025-01-16
 ### Fixed
 - `gas-custom-errors` [#620](https://github.com/protofire/solhint/pull/620) - Support for Custom Errors inside `require` statements
@@ -143,7 +168,7 @@ Thanks to [@juanpcapurro](https://github.com/juanpcapurro) for providing the cod
 
 
 ### Added
-- Official Docker Image [#524](https://github.com/protofire/solhint/pull/524) (Thanks to [@keypee](https://github.com/keypee90))
+- Official Docker Image [#524](https://github.com/protofire/solhint/pull/524) (Thanks to [@kaypee90](https://github.com/kaypee90))
 - Autofix for `payable-fallback` rule [#528](https://github.com/protofire/solhint/pull/528)
 - Autofix for `quotes` rule [#529](https://github.com/protofire/solhint/pull/529)
 - Autofix for `avoid-suicide` rule [#531](https://github.com/protofire/solhint/pull/531)

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Protofire
+Copyright (c) 2017-2025 Protofire
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -5,7 +5,7 @@
   By <a href="https://protofire.io/" target="_blank">Protofire</a>
 </p>
 
-[![](https://img.shields.io/badge/Solhint%20Website-cyan)](https://protofire.io/projects/solhint)
+[![](https://img.shields.io/badge/Solhint%20Website-cyan)](https://protofire.io/solhint)
 [![](https://img.shields.io/badge/Join%20Our%20Discord-magenta)](https://discord.gg/4TYGq3zpjs)
 [![Donate with Ethereum](https://img.shields.io/badge/Donate-ETH-blue)](https://etherscan.io/address/0xA81705c8C247C413a19A244938ae7f4A0393944e)
 [![NPM version](https://badge.fury.io/js/solhint.svg)](https://npmjs.org/package/solhint)
@@ -38,7 +38,7 @@ First initialize a configuration file, if you don't have one:
 solhint --init
 ```
 
-This will create a `.solhint.json` file with the default rules enabled. Then run Solhint with one or more [Globs](https://en.wikipedia.org/wiki/Glob_(programming)) as arguments. For example, to lint all files inside `contracts` directory, you can do:
+This will create a `.solhint.json` file with the recommended rules enabled. Then run Solhint with one or more [Globs](https://en.wikipedia.org/wiki/Glob_(programming)) as arguments. For example, to lint all files inside `contracts` directory, you can do:
 
 ```sh
 solhint 'contracts/**/*.sol'
@@ -90,7 +90,7 @@ This option currently works on:
 - private-vars-underscore
 - payable-fallback
 - quotes
-- contract-name-camelcase
+- contract-name-capwords
 - avoid-suicide
 
 <br><br>
@@ -108,11 +108,12 @@ This file has the following format:
 ### Default 
 ```json
 {
-  "extends": "solhint:default"
+  "extends": "solhint:recommended"
 }
 ```
 ### Note
 The `solhint:default` configuration contains only two rules: max-line-length & no-console
+It is now deprecated since version 5.1.0
 <br><br>
 
 
@@ -139,9 +140,9 @@ additional-tests.sol
 
 ### Extendable rulesets
 
-The default rulesets provided by solhint are the following:
+The rulesets provided by solhint are the following:
 
-+ solhint:default
++ solhint:default (deprecated since version v5.1.0)
 + solhint:recommended
 
 Use one of these as the value for the "extends" property in your configuration file.
@@ -238,7 +239,6 @@ Related documentation you may find [here](https://protofire.github.io/solhint/).
 
 ## Table of Contents
 
-* [Roadmap](ROADMAP.md): The core project's roadmap - what the core team is looking to work on in the near future.
 * [Contributing](docs/contributing.md): The core Solhint team :heart: contributions. This describes how you can contribute to the Solhint Project.
 * [Shareable configs](docs/shareable-configs.md): How to create and share your own configurations.
 * [Writing plugins](docs/writing-plugins.md): How to extend Solhint with your own rules.

conf/rulesets/solhint-all.js

@@ -37,6 +37,7 @@ module.exports = Object.freeze({
     'gas-struct-packing': 'warn',
     'comprehensive-interface': 'warn',
     'duplicated-imports': 'warn',
+    'import-path-check': ['warn', ['[~dependenciesPath]']],
     quotes: ['error', 'double'],
     'const-name-snakecase': 'warn',
     'contract-name-capwords': 'warn',