feat: replace solhint with solhint-community (#59)

defi-wonderland · Feb 2, 2024 · 85943db · 85943db
1 parent 6cb3eb0
commit 85943db
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 679 deletions.
diff --git a/.solhint.json b/.solhint.json
@@ -1,28 +1,16 @@
 {
   "extends": "solhint:recommended",
-  "plugins": ["defi-wonderland"],
   "rules": {
     "compiler-version": ["off"],
     "constructor-syntax": "warn",
     "quotes": ["error", "single"],
     "func-visibility": ["warn", { "ignoreConstructors": true }],
     "not-rely-on-time": "off",
-    "func-name-mixedcase": "off",
-    "var-name-mixedcase": "off",
-    "const-name-snakecase": "off",
     "no-inline-assembly": "off",
     "no-empty-blocks": "off",
     "private-vars-leading-underscore": ["warn", { "strict": false }],
-    "defi-wonderland/non-state-vars-leading-underscore": ["warn"],
-    "defi-wonderland/contract-data-order": ["warn"],
-    "defi-wonderland/enum-name-camelcase": ["warn"],
-    "defi-wonderland/immutable-name-snakecase": ["warn"],
-    "defi-wonderland/import-statement-format": ["warn"],
-    "defi-wonderland/interface-member-order": ["warn"],
-    "defi-wonderland/interface-starts-with-i": ["warn"],
-    "defi-wonderland/named-return-values": ["warn"],
-    "defi-wonderland/struct-name-camelcase": ["warn"],
-    "defi-wonderland/wonder-var-name-mixedcase": ["warn"],
+    "ordering": "warn",
+    "immutable-name-snakecase": "warn",
     "avoid-low-level-calls": "off",
     "no-console": "off"
   }

diff --git a/.solhint.tests.json b/.solhint.tests.json
@@ -0,0 +1,23 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": ["off"],
+    "constructor-syntax": "warn",
+    "quotes": ["error", "single"],
+    "func-visibility": ["warn", { "ignoreConstructors": true }],
+    "not-rely-on-time": "off",
+    "func-name-mixedcase": "off",
+    "var-name-mixedcase": "off",
+    "const-name-snakecase": "off",
+    "no-inline-assembly": "off",
+    "no-empty-blocks": "off",
+    "definition-name-capwords": "off",
+    "named-parameters-function": "off",
+    "no-global-import": "off",
+    "max-states-count": "off",
+    "private-vars-leading-underscore": ["warn", { "strict": false }],
+    "ordering": "warn",
+    "immutable-name-snakecase": "warn",
+    "avoid-low-level-calls": "off"
+  }
+}
diff --git a/package.json b/package.json
@@ -19,7 +19,7 @@
     "lint:check": "yarn lint:sol-tests && yarn lint:sol-logic && forge fmt --check",
     "lint:fix": "sort-package-json && forge fmt && yarn lint:sol-tests --fix && yarn lint:sol-logic --fix",
     "lint:sol-logic": "solhint -c .solhint.json 'solidity/contracts/**/*.sol' 'solidity/interfaces/**/*.sol'",
-    "lint:sol-tests": "solhint 'solidity/test/**/*.sol'",
+    "lint:sol-tests": "solhint -c .solhint.tests.json 'solidity/test/**/*.sol'",
     "prepare": "husky install",
     "test": "forge test -vvv",
     "test:integration": "forge test --match-contract Integration -vvv",
@@ -42,8 +42,7 @@
     "forge-std": "github:foundry-rs/forge-std#v1.7.3",
     "husky": ">=8",
     "lint-staged": ">=10",
-    "solhint": "3.6.2",
-    "solhint-plugin-defi-wonderland": "1.1.0",
+    "solhint": "github:solhint-community/solhint-community#v4.0.0-rc01",
     "sort-package-json": "1.53.1"
   }
 }
diff --git a/solidity/contracts/Greeter.sol b/solidity/contracts/Greeter.sol
@@ -20,6 +20,16 @@ contract Greeter is IGreeter {
   /// @inheritdoc IGreeter
   IERC20 public token;
 
+  /**
+   * @notice Reverts in case the function was not called by the owner of the contract
+   */
+  modifier onlyOwner() {
+    if (msg.sender != OWNER) {
+      revert Greeter_OnlyOwner();
+    }
+    _;
+  }
+
   /**
    * @notice Defines the owner to the msg.sender and sets the initial greeting
    * @param _greeting Initial greeting
@@ -31,6 +41,12 @@ contract Greeter is IGreeter {
     setGreeting(_greeting);
   }
 
+  /// @inheritdoc IGreeter
+  function greet() external view returns (string memory _greeting, uint256 _balance) {
+    _greeting = greeting;
+    _balance = token.balanceOf(msg.sender);
+  }
+
   /// @inheritdoc IGreeter
   function setGreeting(string memory _greeting) public onlyOwner {
     if (keccak256(bytes(_greeting)) == _EMPTY_STRING) {
@@ -40,20 +56,4 @@ contract Greeter is IGreeter {
     greeting = _greeting;
     emit GreetingSet(_greeting);
   }
-
-  /// @inheritdoc IGreeter
-  function greet() external view returns (string memory _greeting, uint256 _balance) {
-    _greeting = greeting;
-    _balance = token.balanceOf(msg.sender);
-  }
-
-  /**
-   * @notice Reverts in case the function was not called by the owner of the contract
-   */
-  modifier onlyOwner() {
-    if (msg.sender != OWNER) {
-      revert Greeter_OnlyOwner();
-    }
-    _;
-  }
 }
diff --git a/solidity/interfaces/IGreeter.sol b/solidity/interfaces/IGreeter.sol
@@ -33,6 +33,16 @@ interface IGreeter {
    */
   error Greeter_InvalidGreeting();
 
+  /*///////////////////////////////////////////////////////////////
+                            LOGIC
+  //////////////////////////////////////////////////////////////*/
+  /**
+   * @notice Sets a new greeting
+   * @dev Only callable by the owner
+   * @param _newGreeting The new greeting to be set
+   */
+  function setGreeting(string memory _newGreeting) external;
+
   /*///////////////////////////////////////////////////////////////
                             VARIABLES
   //////////////////////////////////////////////////////////////*/
@@ -62,14 +72,4 @@ interface IGreeter {
    * @return _balance  Current token balance of the caller
    */
   function greet() external view returns (string memory _greeting, uint256 _balance);
-
-  /*///////////////////////////////////////////////////////////////
-                            LOGIC
-  //////////////////////////////////////////////////////////////*/
-  /**
-   * @notice Sets a new greeting
-   * @dev Only callable by the owner
-   * @param _newGreeting The new greeting to be set
-   */
-  function setGreeting(string memory _newGreeting) external;
 }