ci: move from prettier to forge fmt (#160)

* add fmt configurations

* apply forge fmt

* change husky pre-commit

* change git ci yarn lint to forge fmt

* yarn remove prettier, solhint, prettier-plugin-solidity, solhint-plugin-prettier

* enable forge fmt only on staged changes

Author: gaavar

.github/workflows/ci.yml

@@ -38,9 +38,6 @@ jobs:
       - name: Install dependencies
         run: yarn install
 
-      - name: Run linter
-        run: yarn lint
-
       - name: Run audit
         run: yarn audit
 
@@ -54,6 +51,9 @@ jobs:
           forge --version
           forge build --sizes
 
+      - name: Run forge formatter
+        run: forge fmt
+
       - name: Run forge tests
         run: forge test -vvv
 

.husky/pre-commit

@@ -1,5 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
-
-yarn lint-staged
-forge snapshot --check --match-contract Gas
+forge snapshot --check --match-contract Gas
+npx lint-staged

.lintstagedrc

@@ -1,5 +1,5 @@
 {
-  "*.{json,md,sol,yml}": [
-    "prettier --config ./.prettierrc.yml --write"
+  "*.sol": [
+    "forge fmt --check"
   ]
 }

foundry.toml

@@ -7,3 +7,11 @@ verbosity = 3
 
 [fuzz]
 runs = 512
+
+[fmt]
+line_length = 120
+tab_width = 4
+quote_style = "double"
+bracket_spacing = false
+int_types = "long"
+multiline_func_header = "params_first"

package.json

@@ -9,11 +9,7 @@
   "license": "None",
   "devDependencies": {
     "husky": "^8.0.1",
-    "lint-staged": "^13.0.2",
-    "prettier": "^2.7.1",
-    "prettier-plugin-solidity": "^1.0.0-beta.19",
-    "solhint": "^3.3.7",
-    "solhint-plugin-prettier": "^0.0.5"
+    "lint-staged": "^13.0.2"
   },
   "scripts": {
     "lint": "yarn solhint && yarn prettier:check",

src/BundleRegistry.sol

@@ -67,11 +67,7 @@ contract BundleRegistry is Ownable {
      * @param _nameRegistry The address of the NameRegistry UUPS Proxy contract
      * @param _trustedCaller The address that can call trustedRegister and partialTrustedRegister
      */
-    constructor(
-        address _idRegistry,
-        address _nameRegistry,
-        address _trustedCaller
-    ) Ownable() {
+    constructor(address _idRegistry, address _nameRegistry, address _trustedCaller) Ownable() {
         idRegistry = IdRegistry(_idRegistry);
         nameRegistry = NameRegistry(_nameRegistry);
         trustedCaller = _trustedCaller;
@@ -96,7 +92,7 @@ contract BundleRegistry is Ownable {
         // Return any funds returned by the NameRegistry back to the caller
         if (address(this).balance > 0) {
             // solhint-disable-next-line avoid-low-level-calls
-            (bool success, ) = msg.sender.call{value: address(this).balance}("");
+            (bool success,) = msg.sender.call{value: address(this).balance}("");
             if (!success) revert CallFailed();
         }
     }

src/IdRegistry.sol

@@ -190,11 +190,7 @@ contract IdRegistry is ERC2771Context, Ownable {
      * @param recovery The address which can recover the fid
      * @param url      The home url for the fid's off-chain data
      */
-    function register(
-        address to,
-        address recovery,
-        string calldata url
-    ) external {
+    function register(address to, address recovery, string calldata url) external {
         // Perf: Don't check to == address(0) to save 29 gas since 0x0 can only register 1 fid
 
         if (trustedOnly == 1) revert Invitable();
@@ -213,11 +209,7 @@ contract IdRegistry is ERC2771Context, Ownable {
      * @param recovery The address which can recover the fid
      * @param url      The home url for the fid's off-chain data
      */
-    function trustedRegister(
-        address to,
-        address recovery,
-        string calldata url
-    ) external {
+    function trustedRegister(address to, address recovery, string calldata url) external {
         // Perf: Don't check to == address(0) to save 29 gas since 0x0 can only register 1 fid
 
         if (trustedOnly == 0) revert Registrable();
@@ -287,11 +279,7 @@ contract IdRegistry is ERC2771Context, Ownable {
      * @dev Transfer the fid to another address, clear the recovery address and reset active
      *      recovery requests, without checking any invariants.
      */
-    function _unsafeTransfer(
-        uint256 id,
-        address from,
-        address to
-    ) internal {
+    function _unsafeTransfer(uint256 id, address from, address to) internal {
         idOf[to] = id;
         delete idOf[from];
 
@@ -321,7 +309,8 @@ contract IdRegistry is ERC2771Context, Ownable {
      *    changeRecoveryAddress(), which requires idOf[addr] != 0
      * 4. idOf[addr] becomes 0 only in transfer() and completeRecovery(), which requires
      *    recoveryOf[addr] == address(0)
-     **/
+     *
+     */
 
     /**
      * INVARIANT 2: If an address has a non-zero recoveryClock, it must also have an fid
@@ -459,9 +448,7 @@ contract IdRegistry is ERC2771Context, Ownable {
     /**
      * @notice Override to prevent a single-step transfer of ownership
      */
-    function transferOwnership(
-        address /*newOwner*/
-    ) public view override onlyOwner {
+    function transferOwnership(address /*newOwner*/ ) public view override onlyOwner {
         revert Unauthorized();
     }
 
@@ -491,11 +478,11 @@ contract IdRegistry is ERC2771Context, Ownable {
                          OPEN ZEPPELIN OVERRIDES
     //////////////////////////////////////////////////////////////*/
 
-    function _msgSender() internal view override(Context, ERC2771Context) returns (address) {
+    function _msgSender() internal view override (Context, ERC2771Context) returns (address) {
         return ERC2771Context._msgSender();
     }
 
-    function _msgData() internal view override(Context, ERC2771Context) returns (bytes calldata) {
+    function _msgData() internal view override (Context, ERC2771Context) returns (bytes calldata) {
         return ERC2771Context._msgData();
     }
 }

src/NameRegistry.sol

@@ -414,12 +414,7 @@ contract NameRegistry is
      * @param secret   The secret value in the commitment
      * @param recovery The address which can recovery the fname if the custody address is lost
      */
-    function register(
-        bytes16 fname,
-        address to,
-        bytes32 secret,
-        address recovery
-    ) external payable {
+    function register(bytes16 fname, address to, bytes32 secret, address recovery) external payable {
         bytes32 commit = generateCommit(fname, to, secret, recovery);
 
         uint256 _fee = fee;
@@ -463,7 +458,7 @@ contract NameRegistry is
         if (overpayment > 0) {
             // Perf: Call msg.sender instead of _msgSender() to save ~100 gas b/c we don't need meta-tx
             // solhint-disable-next-line avoid-low-level-calls
-            (bool success, ) = msg.sender.call{value: overpayment}("");
+            (bool success,) = msg.sender.call{value: overpayment}("");
             if (!success) revert CallFailed();
         }
     }
@@ -548,7 +543,7 @@ contract NameRegistry is
         if (overpayment > 0) {
             // Perf: Call msg.sender instead of _msgSender() to save ~100 gas b/c we don't need meta-tx
             // solhint-disable-next-line avoid-low-level-calls
-            (bool success, ) = msg.sender.call{value: overpayment}("");
+            (bool success,) = msg.sender.call{value: overpayment}("");
             if (!success) revert CallFailed();
         }
     }
@@ -562,11 +557,7 @@ contract NameRegistry is
      * @param tokenId  The uint256 representation of the fname to bid on
      * @param recovery The address which can recovery the fname if the custody address is lost
      */
-    function bid(
-        address to,
-        uint256 tokenId,
-        address recovery
-    ) external payable {
+    function bid(address to, uint256 tokenId, address recovery) external payable {
         // Check that the tokenID was previously registered
         uint256 expiryTs = expiryOf[tokenId];
         if (expiryTs == 0) revert Registrable();
@@ -627,11 +618,9 @@ contract NameRegistry is
 
             // Safety/Audit: the below cannot intuitively underflow or overflow given the ranges,
             // but needs proof
-            price =
-                BID_START_PRICE.mulWadDown(
-                    uint256(FixedPointMathLib.powWad(int256(BID_PERIOD_DECREASE_UD60X18), periodsSD59x18))
-                ) +
-                fee;
+            price = BID_START_PRICE.mulWadDown(
+                uint256(FixedPointMathLib.powWad(int256(BID_PERIOD_DECREASE_UD60X18), periodsSD59x18))
+            ) + fee;
         }
 
         if (msg.value < price) revert InsufficientFunds();
@@ -656,7 +645,7 @@ contract NameRegistry is
         if (overpayment > 0) {
             // Perf: Call msg.sender instead of _msgSender() to save ~100 gas b/c we don't need meta-tx
             // solhint-disable-next-line avoid-low-level-calls
-            (bool success, ) = msg.sender.call{value: overpayment}("");
+            (bool success,) = msg.sender.call{value: overpayment}("");
             if (!success) revert CallFailed();
         }
     }
@@ -690,11 +679,7 @@ contract NameRegistry is
      * @param to      The address to transfer the fname to
      * @param tokenId The uint256 representation of the fname to transfer
      */
-    function transferFrom(
-        address from,
-        address to,
-        uint256 tokenId
-    ) public override {
+    function transferFrom(address from, address to, uint256 tokenId) public override {
         uint256 expiryTs = expiryOf[tokenId];
 
         // Expired names should not be transferrable by the previous owner
@@ -711,12 +696,7 @@ contract NameRegistry is
      * @param tokenId  The uint256 representation of the fname to transfer
      * @param data     Additional data with no specified format, sent in call to `to`
      */
-    function safeTransferFrom(
-        address from,
-        address to,
-        uint256 tokenId,
-        bytes memory data
-    ) public override {
+    function safeTransferFrom(address from, address to, uint256 tokenId, bytes memory data) public override {
         uint256 expiryTs = expiryOf[tokenId];
 
         // Expired names should not be transferrable by the previous owner
@@ -740,7 +720,7 @@ contract NameRegistry is
         _validateName(fname);
 
         // Step back from the last byte to find the first non-zero byte
-        for (uint256 i = 15; ; ) {
+        for (uint256 i = 15;;) {
             if (uint8(fname[i]) != 0) {
                 lastCharIdx = i;
                 break;
@@ -758,7 +738,7 @@ contract NameRegistry is
         // Construct a new bytes[] with the valid fname characters.
         bytes memory fnameBytes = new bytes(lastCharIdx + 1);
 
-        for (uint256 j = 0; j <= lastCharIdx; ) {
+        for (uint256 j = 0; j <= lastCharIdx;) {
             fnameBytes[j] = fname[j];
 
             unchecked {
@@ -773,22 +753,14 @@ contract NameRegistry is
     /**
      * @dev Hook that ensures that token transfers cannot occur when the contract is paused.
      */
-    function _beforeTokenTransfer(
-        address from,
-        address to,
-        uint256 tokenId
-    ) internal override whenNotPaused {
+    function _beforeTokenTransfer(address from, address to, uint256 tokenId) internal override whenNotPaused {
         super._beforeTokenTransfer(from, to, tokenId);
     }
 
     /**
      * @dev Hook that ensures that recovery address is reset whenever a transfer occurs.
      */
-    function _afterTokenTransfer(
-        address from,
-        address to,
-        uint256 tokenId
-    ) internal override {
+    function _afterTokenTransfer(address from, address to, uint256 tokenId) internal override {
         super._afterTokenTransfer(from, to, tokenId);
 
         // Checking state before clearing is more gas-efficient than always clearing
@@ -1018,7 +990,7 @@ contract NameRegistry is
         if (address(this).balance < amount) revert InsufficientFunds();
 
         // solhint-disable-next-line avoid-low-level-calls
-        (bool success, ) = vault.call{value: amount}("");
+        (bool success,) = vault.call{value: amount}("");
         if (!success) revert CallFailed();
     }
 
@@ -1051,20 +1023,25 @@ contract NameRegistry is
     function _msgSender()
         internal
         view
-        override(ContextUpgradeable, ERC2771ContextUpgradeable)
+        override (ContextUpgradeable, ERC2771ContextUpgradeable)
         returns (address sender)
     {
         sender = ERC2771ContextUpgradeable._msgSender();
     }
 
-    function _msgData() internal view override(ContextUpgradeable, ERC2771ContextUpgradeable) returns (bytes calldata) {
+    function _msgData()
+        internal
+        view
+        override (ContextUpgradeable, ERC2771ContextUpgradeable)
+        returns (bytes calldata)
+    {
         return ERC2771ContextUpgradeable._msgData();
     }
 
     function supportsInterface(bytes4 interfaceId)
         public
         view
-        override(AccessControlUpgradeable, ERC721Upgradeable)
+        override (AccessControlUpgradeable, ERC721Upgradeable)
         returns (bool)
     {
         return ERC721Upgradeable.supportsInterface(interfaceId);
@@ -1097,7 +1074,7 @@ contract NameRegistry is
         // If the name begins with a hyphen, reject it
         if (uint8(fname[0]) == 45) revert InvalidName();
 
-        for (uint256 i = 0; i < length; ) {
+        for (uint256 i = 0; i < length;) {
             uint8 charInt = uint8(fname[i]);
 
             unchecked {

test/BundleRegistry.t.sol

@@ -234,12 +234,7 @@ contract BundleRegistryTest is Test {
                      PARTIAL TRUSTED REGISTER TESTS
     //////////////////////////////////////////////////////////////*/
 
-    function testPartialTrustedRegister(
-        address alice,
-        address recovery,
-        string calldata url,
-        uint256 inviter
-    ) public {
+    function testPartialTrustedRegister(address alice, address recovery, string calldata url, uint256 inviter) public {
         vm.assume(alice != address(0)); // OZ's ERC-721 throws when a zero-address mints an NFT
 
         // State: Trusted registration is disabled in IdRegistry, but enabled in NameRegistry and
@@ -342,12 +337,7 @@ contract BundleRegistryTest is Test {
                          TRUSTED REGISTER TESTS
     //////////////////////////////////////////////////////////////*/
 
-    function testTrustedRegister(
-        address alice,
-        address recovery,
-        string calldata url,
-        uint256 inviter
-    ) public {
+    function testTrustedRegister(address alice, address recovery, string calldata url, uint256 inviter) public {
         vm.assume(alice != address(0)); // OZ's ERC-721 throws when a zero-address mints an NFT
 
         // State: Trusted registration is enabled in both registries and trusted caller is set in both
@@ -449,11 +439,7 @@ contract BundleRegistryTest is Test {
                       TRUSTED BATCH REGISTER TESTS
     //////////////////////////////////////////////////////////////*/
 
-    function testTrustedBatchRegister(
-        address alice,
-        address bob,
-        address charlie
-    ) public {
+    function testTrustedBatchRegister(address alice, address bob, address charlie) public {
         vm.assume(alice != address(0)); // OZ's ERC-721 throws when a zero-address mints an NFT
         vm.assume(bob != address(0)); // OZ's ERC-721 throws when a zero-address mints an NFT
         vm.assume(charlie != address(0)); // OZ's ERC-721 throws when a zero-address mints an NFT