Merge pull request #423 from protofire/release/3-4-1

New release: 3.4.1

CHANGELOG.md

@@ -1,3 +1,22 @@
+## [3.4.1] - 2023-03-06
+### Updated
+- Updated solidity parser to 0.16.0 [#420](https://github.com/protofire/solhint/pull/420)
+
+### Added
+- Added github workflow to execute unit tests on each PR [#412](https://github.com/protofire/solhint/pull/412)
+- Added macOS and windows into E2E github workflow [#422](https://github.com/protofire/solhint/pull/422)
+
+### Fixed
+- False positive on for-loop Yul [#400](https://github.com/protofire/solhint/pull/400)
+- Ordering-rule support for Top Level statements [#393](https://github.com/protofire/solhint/pull/393)
+- Fix no-global-import to accept named global imports [#416](https://github.com/protofire/solhint/pull/416)
+- Fix named-parameters-mapping to not enforce on nested mappings [#421](https://github.com/protofire/solhint/pull/421)
+
+
+
+
+
+<br><br>
 ## [3.4.0] - 2023-02-17
 ### Updated
 - Solhint dependencies to support newer versions [#380](https://github.com/protofire/solhint/pull/380)
@@ -34,7 +53,7 @@
 
 
 ### Updated
-- Solidity Parser to 0.14.5 [#378](https://github.com/protofire/solhint/pull/378)
+- Solidity Parser to 0.14.5 [#330](https://github.com/protofire/solhint/pull/330) - [#378](https://github.com/protofire/solhint/pull/378)
 
 
 <br><br>

README.md

@@ -5,15 +5,11 @@
   By <a href="https://protofire.io/">Protofire</a>
 </p>
 
-[![Donate with Ethereum](https://en.cryptobadges.io/badge/micro/0xe8cdf02efd8ab0a490d7b2cb13553389c9bc932e)](https://en.cryptobadges.io/donate/0xe8cdf02efd8ab0a490d7b2cb13553389c9bc932e)
-
-[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/solhint/Lobby)
+[![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)
 [![Coverage Status](https://coveralls.io/repos/github/protofire/solhint/badge.svg?branch=master)](
 https://coveralls.io/github/protofire/solhint?branch=master)
 [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/protofire/solhint/master/LICENSE)
-[![dependencies Status](https://david-dm.org/protofire/solhint/status.svg)](https://david-dm.org/protofire/solhint)
-[![devDependencies Status](https://david-dm.org/protofire/solhint/dev-status.svg)](https://david-dm.org/protofire/solhint?type=dev)
 
 This is an open source project for linting [Solidity](http://solidity.readthedocs.io/en/develop/) code. This project
 provides both **Security** and **Style Guide** validations.
@@ -83,10 +79,15 @@ To generate a new  sample `.solhint.json` file in current folder you can do:
 solhint --init 
 ```
 
-This file has the following
-format:
-
+This file has the following format:
+### Default 
+```json
+{
+  "extends": "solhint:default"
+}
+```
 
+### Sample
 ```json
   {
     "extends": "solhint:recommended",
@@ -214,7 +215,8 @@ Related documentation you may find [here](https://protofire.github.io/solhint/).
 - POA Network - Public EVM Sidechain:
   - [Proof of Physical Address (PoPA)](https://github.com/poanetwork/poa-popa)
   - [Proof of Bank Account (PoBA)](https://github.com/poanetwork/poa-poba)
-- [0x](https://github.com/0xProject/0x-monorepo/tree/development/contracts)
+- 0x-Project
+  - [0x-Monorepo](https://github.com/0xProject/0x-monorepo/tree/development/contracts)
 - Gnosis:
   - [Gnosis Prediction Market Contracts](https://github.com/gnosis/pm-contracts)
   - [The DutchX decentralized trading protocol](https://github.com/gnosis/dex-contracts)
@@ -230,7 +232,7 @@ MIT
 ## Back us
 Solhint is free to use and open-sourced. If you value our effort and feel like helping us to keep pushing this tool forward, you can send us a small donation. We'll highly appreciate it :)
 
-[![Donate with Ethereum](https://en.cryptobadges.io/badge/micro/0xe8cdf02efd8ab0a490d7b2cb13553389c9bc932e)](https://en.cryptobadges.io/donate/0xe8cdf02efd8ab0a490d7b2cb13553389c9bc932e)
+[![Donate with Ethereum](https://img.shields.io/badge/Donate-ETH-blue)](https://etherscan.io/address/0xA81705c8C247C413a19A244938ae7f4A0393944e)
 
 ## Related projects
 

docs/rules/best-practises/no-console.md

@@ -51,7 +51,7 @@ import "forge-std/consoleN.sol"
 ```
 
 ## Version
-This rule is introduced in the latest version.
+This rule was introduced in [Solhint 3.4.0](https://github.com/protofire/solhint/tree/v3.4.0)
 
 ## Resources
 - [Rule source](https://github.com/protofire/solhint/tree/master/lib/rules/best-practises/no-console.js)

docs/rules/best-practises/no-global-import.md

@@ -36,6 +36,18 @@ This rule accepts a string option of rule severity. Must be one of "error", "war
 import {A} from "./A.sol"
 ```
 
+#### import entire file into a name
+
+```solidity
+import "./A.sol" as A
+```
+
+#### import entire file into a name
+
+```solidity
+import * as A from "./A.sol"
+```
+
 ### 👎 Examples of **incorrect** code for this rule
 
 #### import all members from a file
@@ -51,7 +63,7 @@ import "foo.sol"
 ```
 
 ## Version
-This rule is introduced in the latest version.
+This rule was introduced in [Solhint 3.4.0](https://github.com/protofire/solhint/tree/v3.4.0)
 
 ## Resources
 - [Rule source](https://github.com/protofire/solhint/tree/master/lib/rules/best-practises/no-global-import.js)