Use forge fmt over prettier (#212)

* forge fmt

* Remove prettier

* fix formatting related solhint issues

* rm eslint-config-prettier

Since eslint-config-prettier only turns off rules and removing it doesn't trigger issues, it was not doing anything for us

* cleanup CI

* cleanup npm packages

* rm unused packages

* replace ts-node with tsx, fix automation interface gen

* rm typechain

* rm old overrides & deep-equal-in-any-order

* fix fmt

* number_underscore = "thousands"

* wrap_comments = true

* make payable in automation test & automation snapshot

Author: RensR

.github/workflows/solidity-foundry.yml

@@ -28,16 +28,16 @@ jobs:
         run: |
           cat <<EOF > matrix.json
           [
-            { "name": "automation", "setup": { "run-coverage": false, "min-coverage": 98.5, "run-gas-snapshot": false, "run-forge-fmt": false }},
-            { "name": "functions", "setup": { "run-coverage": false, "min-coverage": 98.5, "run-gas-snapshot": true, "run-forge-fmt": false }},
-            { "name": "keystone", "setup": { "run-coverage": true, "min-coverage": 72.8, "run-gas-snapshot": false, "run-forge-fmt": false }},
-            { "name": "l2ep", "setup": { "run-coverage": true, "min-coverage": 65.0, "run-gas-snapshot": true, "run-forge-fmt": false }},
-            { "name": "llo-feeds", "setup": { "run-coverage": true, "min-coverage": 49.3, "run-gas-snapshot": true, "run-forge-fmt": false }},
-            { "name": "operatorforwarder", "setup": { "run-coverage": true, "min-coverage": 55.7, "run-gas-snapshot": true, "run-forge-fmt": false }},
-            { "name": "shared", "setup": { "run-coverage": true, "extra-coverage-params": "--no-match-path='*CallWithExactGas*' --ir-minimum", "min-coverage": 29, "run-gas-snapshot": true, "run-forge-fmt": false }},
-            { "name": "vrf", "setup": { "run-coverage": false, "min-coverage": 98.5, "run-gas-snapshot": false, "run-forge-fmt": false }},
-            { "name": "workflow", "setup": { "run-coverage": true, "extra-coverage-params": "--ir-minimum --no-match-coverage='(.*v1/test.*)|(.*v2/test.*)'", "min-coverage": 93.0, "run-gas-snapshot": true, "run-forge-fmt": true }},
-            { "name": "data-feeds", "setup": { "run-coverage": true, "min-coverage": 98.5, "run-gas-snapshot": true, "extra-coverage-params": "--no-match-coverage='WIP*'", "run-forge-fmt": false }}
+            { "name": "automation", "setup": { "run-coverage": false, "min-coverage": 98.5, "run-gas-snapshot": false }},
+            { "name": "functions", "setup": { "run-coverage": false, "min-coverage": 98.5, "run-gas-snapshot": true }},
+            { "name": "keystone", "setup": { "run-coverage": true, "min-coverage": 72.8, "run-gas-snapshot": false }},
+            { "name": "l2ep", "setup": { "run-coverage": true, "min-coverage": 65.0, "run-gas-snapshot": true }},
+            { "name": "llo-feeds", "setup": { "run-coverage": true, "min-coverage": 49.3, "run-gas-snapshot": true }},
+            { "name": "operatorforwarder", "setup": { "run-coverage": true, "min-coverage": 55.7, "run-gas-snapshot": true }},
+            { "name": "shared", "setup": { "run-coverage": true, "extra-coverage-params": "--no-match-path='*CallWithExactGas*' --ir-minimum", "min-coverage": 29, "run-gas-snapshot": true }},
+            { "name": "vrf", "setup": { "run-coverage": false, "min-coverage": 98.5, "run-gas-snapshot": false }},
+            { "name": "workflow", "setup": { "run-coverage": true, "extra-coverage-params": "--ir-minimum --no-match-coverage='(.*v1/test.*)|(.*v2/test.*)'", "min-coverage": 93.0, "run-gas-snapshot": true }},
+            { "name": "data-feeds", "setup": { "run-coverage": true, "min-coverage": 98.5, "run-gas-snapshot": true, "extra-coverage-params": "--no-match-coverage='WIP*'" }}
 
           ]
           EOF
@@ -75,7 +75,6 @@ jobs:
             non_src:
               - '.github/workflows/solidity-foundry.yml'
               - 'contracts/foundry.toml'
-              - 'contracts/gas-snapshots/*.gas-snapshot'
               - 'contracts/package.json'
               - 'contracts/GNUmakefile'
             sol:
@@ -100,9 +99,6 @@ jobs:
               - 'contracts/src/v0.8/vrf/**/*.sol'
             shared:
               - 'contracts/src/v0.8/shared/**/*.sol'
-              - 'contracts/src/v0.8/*.sol'
-              - 'contracts/src/v0.8/mocks/**/*.sol'
-              - 'contracts/src/v0.8/tests/**/*.sol'
               - 'contracts/src/v0.8/vendor/**/*.sol'
             workflow:
               - 'contracts/src/v0.8/workflow/**/*.sol'
@@ -596,22 +592,22 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout the repo
-        if: ${{ (contains(fromJson(needs.changes.outputs.all_changes), matrix.product.name) || needs.changes.outputs.non_src_changes == 'true') && matrix.product.setup.run-forge-fmt }}
+        if: ${{ contains(fromJson(needs.changes.outputs.all_changes), matrix.product.name) || needs.changes.outputs.non_src_changes == 'true' }}
         uses: actions/checkout@v4
         with:
           persist-credentials: false
           submodules: recursive
 
       - name: Setup NodeJS
-        if: ${{ (contains(fromJson(needs.changes.outputs.all_changes), matrix.product.name) || needs.changes.outputs.non_src_changes == 'true') && matrix.product.setup.run-forge-fmt }}
+        if: ${{ contains(fromJson(needs.changes.outputs.all_changes), matrix.product.name) || needs.changes.outputs.non_src_changes == 'true' }}
         uses: ./.github/actions/setup-nodejs
 
       - name: Install Foundry
-        if: ${{ (contains(fromJson(needs.changes.outputs.all_changes), matrix.product.name) || needs.changes.outputs.non_src_changes == 'true') && matrix.product.setup.run-forge-fmt }}
+        if: ${{ contains(fromJson(needs.changes.outputs.all_changes), matrix.product.name) || needs.changes.outputs.non_src_changes == 'true' }}
         uses: ./.github/actions/install-solidity-foundry
 
       - name: Run Forge fmt
-        if: ${{ (contains(fromJson(needs.changes.outputs.all_changes), matrix.product.name) || needs.changes.outputs.non_src_changes == 'true') && matrix.product.setup.run-forge-fmt }}
+        if: ${{ contains(fromJson(needs.changes.outputs.all_changes), matrix.product.name) || needs.changes.outputs.non_src_changes == 'true' }}
         run: forge fmt --check
         id: fmt
         working-directory: contracts

.github/workflows/solidity-wrappers.yml

@@ -148,28 +148,11 @@ jobs:
       - name: Run solhint on tests
         run: pnpm solhint-test
 
-  prettier:
-    defaults:
-      run:
-        working-directory: contracts
-    needs: [changes]
-    if: needs.changes.outputs.changes == 'true'
-    name: Prettier Formatting
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout the repo
-        uses: actions/checkout@v4
-        with:
-          persist-credentials: false
-      - name: Setup NodeJS
-        uses: ./.github/actions/setup-nodejs
-      - name: Run prettier check
-        run: pnpm prettier:check
 
   publish-beta:
     name: Publish Beta NPM
     environment: publish-contracts
-    needs: [tag-check, changes, lint, prettier, native-compile]
+    needs: [tag-check, changes, lint, native-compile]
     if: needs.tag-check.outputs.is-pre-release-core == 'true'
     runs-on: ubuntu-latest
     steps:
@@ -216,7 +199,7 @@ jobs:
   publish-prod:
     name: Publish Prod NPM
     environment: publish-contracts
-    needs: [tag-check, changes, lint, prettier, native-compile]
+    needs: [tag-check, changes, lint, native-compile]
     if: needs.tag-check.outputs.is-release-core == 'true'
     runs-on: ubuntu-latest
     permissions:

.github/workflows/solidity.yml

@@ -1,13 +1,9 @@
 **/node_modules/**
 **/generated/**
-core/
 **/dist/**
 **/artifacts/**
 **/public/**
 **/build/**
-truffle-config.js
-truffle.js
-gethload.js
 
 pnpm-lock.yaml
 coverage
@@ -20,9 +16,7 @@ node_modules
 solc
 LinkToken.json
 typechain
-**/vendor
-src/v0.8/workflow/**
-src/v0.8/data-feeds/**
+src
 
 # Ignore TS definition and map files
 **/**.d.ts

contracts/.prettierignore

@@ -4,19 +4,5 @@
   "printWidth": 80,
   "endOfLine": "auto",
   "tabWidth": 2,
-  "trailingComma": "all",
-  "plugins": ["prettier-plugin-solidity"],
-  "overrides": [
-    {
-      "files": "*.sol",
-      "options": {
-        "parser": "solidity-parse",
-        "printWidth": 120,
-        "tabWidth": 2,
-        "useTabs": false,
-        "singleQuote": false,
-        "bracketSpacing": false
-      }
-    }
-  ]
+  "trailingComma": "all"
 }

contracts/.prettierrc

@@ -5,19 +5,4 @@ module.exports = {
   endOfLine: 'auto',
   tabWidth: 2,
   trailingComma: 'all',
-  plugins: ['prettier-plugin-solidity'],
-  overrides: [
-    {
-      files: '*.sol',
-      options: {
-        parser: 'solidity-parse',
-        printWidth: 120,
-        tabWidth: 2,
-        useTabs: false,
-        singleQuote: false,
-        bracketSpacing: false,
-        explicitTypes: 'always',
-      },
-    },
-  ],
 }

contracts/.prettierrc.js

@@ -1,6 +1,6 @@
 {
   "extends": "solhint:recommended",
-  "plugins": ["prettier", "chainlink-solidity"],
+  "plugins": ["chainlink-solidity"],
   "rules": {
     "compiler-version": ["off", "^0.8.0"],
     "const-name-snakecase": "off",
@@ -25,12 +25,6 @@
       }
     ],
     "not-rely-on-time": "off",
-    "prettier/prettier": [
-      "off",
-      {
-        "endOfLine": "auto"
-      }
-    ],
     "no-empty-blocks": "off",
     "quotes": ["error", "double"],
     "reason-string": [

contracts/.solhint-test.json

@@ -1,6 +1,6 @@
 {
 	"extends": "solhint:recommended",
-	"plugins": ["prettier", "chainlink-solidity"],
+	"plugins": [ "chainlink-solidity"],
 	"rules": {
 		"compiler-version": ["off", "^0.8.0"],
 		"const-name-snakecase": "off",
@@ -21,12 +21,6 @@
 			}
 		],
 		"not-rely-on-time": "off",
-		"prettier/prettier": [
-			"off",
-			{
-				"endOfLine": "auto"
-			}
-		],
 		"no-empty-blocks": "off",
 		"quotes": ["error", "double"],
 		"reason-string": [

contracts/.solhint.json

@@ -1,2 +1,2 @@
-nodejs 20.13.1
+nodejs 22.18.0
 pnpm 10.6.5

contracts/.tool-versions

@@ -17,7 +17,7 @@ When making (small) changes in existing files,
 it is not required to adhere to this guide if it conflicts with other practices in that existing file.
 Consistency is preferred.
 
-We use `forge fmt` for all new projects, but some older ones still rely on `prettier`.
+We use `forge fmt` for all projects.
 
 
 # <a name="guidelines"></a>Guidelines