Merge pull request #262 from crytic/add-ci-formatter-lint

Add CI formatter lint

Author: montyly

.github/workflows/lint_format.yml

@@ -0,0 +1,28 @@
+name: Lint Check Format
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - name: Install npm and dependencies
+        run: |
+          npm ci
+
+      - name: Run lint
+        run: |
+          npm run lint:format

.github/workflows/check_links.yml renamed to .github/workflows/lint_links.yml

@@ -1,10 +1,9 @@
-name: Check Markdown links
+name: Lint Check Markdown Links
 
 on:
   push:
     branches:
       - master
-      - dev
   pull_request:
   schedule:
     # run CI at 09:00, on day 1 of the month even if no PRs/merges occur

CONTRIBUTING.md

@@ -45,18 +45,23 @@ To install the formatters and linters, run:
 npm install
 ```
 
-The formatter is run with:
+To run the formatter, use:
 
 ```bash
 npm run format
 ```
 
-The linter is run with:
+To run the linters, use:
 
 ```bash
 npm run lint
 ```
 
+To run the individual linters, use:
+
+- `npm run lint:format` to check the formatting
+- `npm run lint:links` to check for invalid links in markdown files
+
 ## Create the book
 
 We use `mdbook` to generate [secure-contracts.com](https://secure-contracts.com/).

package.json

@@ -9,10 +9,10 @@
     "prettier-plugin-solidity": "^1.1.3"
   },
   "scripts": {
-    "format": "prettier --write . && npm run format-embedded-solidity",
-    "format-embedded-solidity": "prettier --write \"**/*.md\" --embedded-language-formatting=auto --plugin prettier-plugin-solidity --tab-width 4 --print-width 120 && prettier --write \"**/*.md\"",
-    "lint": "npm run lint-check-format && npm run lint-check-links",
-    "lint-check-format": "prettier --check .",
-    "lint-check-links": "find . -name '*.md' -print0 | xargs -0 -n1 markdown-link-check"
+    "format": "prettier --write . && npm run format:embedded",
+    "format:embedded": "prettier --write \"**/*.md\" --embedded-language-formatting=auto --plugin prettier-plugin-solidity --tab-width 4 --print-width 120 && prettier --write \"**/*.md\"",
+    "lint": "npm run lint:format && npm run lint:links",
+    "lint:format": "prettier --check .",
+    "lint:links": "find . -name '*.md' -print0 | xargs -0 -n1 markdown-link-check"
   }
 }

program-analysis/echidna/example/TestDepositWithPermit.sol

@@ -23,10 +23,11 @@ contract TestDepositWithPermit {
     }
 
     //helper method to get signature, signs with private key 2
-    function getSignature(address owner, address spender, uint256 assetAmount)
-        internal
-        returns (uint8 v, bytes32 r, bytes32 s)
-    {
+    function getSignature(
+        address owner,
+        address spender,
+        uint256 assetAmount
+    ) internal returns (uint8 v, bytes32 r, bytes32 s) {
         bytes32 digest = keccak256(
             abi.encodePacked(
                 "\x19\x01",
@@ -55,12 +56,10 @@ contract TestDepositWithPermit {
 
         emit LogBalance(previousOwnerBalance, previousCallerBalance);
         (uint8 v, bytes32 r, bytes32 s) = getSignature(OWNER, address(this), amount);
-        try asset.permit(OWNER, address(this), amount, block.timestamp, v, r, s) {}
-        catch {
+        try asset.permit(OWNER, address(this), amount, block.timestamp, v, r, s) {} catch {
             emit AssertionFailed("signature is invalid");
         }
-        try asset.transferFrom(OWNER, address(this), amount) {}
-        catch {
+        try asset.transferFrom(OWNER, address(this), amount) {} catch {
             emit AssertionFailed("transferFrom reverted");
         }
         uint256 currentOwnerBalance = asset.balanceOf(OWNER);

static/script.js

@@ -1 +1,7 @@
-<script type="text/javascript" id="hs-script-loader" async defer src="//js.hs-scripts.com/22554992.js"></script>
+<script
+  type="text/javascript"
+  id="hs-script-loader"
+  async
+  defer
+  src="//js.hs-scripts.com/22554992.js"
+></script>;