ci: setup style convention infrastructure (#144)

* Modify build workflow
* Configure  verify workflow
* Add husky to prevent unlinted/unformatted commits or code

Author: dstallenberg

.github/workflows/build.yml

@@ -33,13 +33,6 @@ jobs:
     steps:
       # Cloning
       - uses: actions/checkout@v2
-        with:
-          repository: "syntest-framework/syntest-framework"
-          token: ${{ secrets.SYNTEST_CI }}
-          path: syntest-framework
-      - uses: actions/checkout@v2
-        with:
-          path: syntest-solidity
 
       # Setup
       - name: Use Node.js ${{ matrix.node-version }}
@@ -61,31 +54,14 @@ jobs:
             ${{ runner.os }}-node-
             ${{ runner.os }}-
 
-      # SynTest Framework
-      - name: Framework - Install Dependencies
-        run: npm install
-        working-directory: syntest-framework
-      - name: Framework - Build framework
-        run: npm run build
-        working-directory: syntest-framework
-      - name: Framework - Link
-        run: npm link
-        working-directory: syntest-framework
-
       # Dependencies
       - name: Solidity - Install Dependencies
         run: npm install
-        working-directory: syntest-solidity
-      - name: Solidity - Link Local Framework
-        run: npm link @syntest/core
-        working-directory: syntest-solidity
 
       # Building
-      - name: Solidity - Build Solidity
+      - name: Solidity - Build
         run: npm run build
-        working-directory: syntest-solidity
 
       # Testing
       - name: Solidity - Run Tests
         run: npm test
-        working-directory: syntest-solidity

.github/workflows/verify.yml

@@ -0,0 +1,67 @@
+name: verify
+
+on:
+  push:
+    branches: [main, develop]
+    paths-ignore:
+      - "docs/"
+      - "**.md"
+  pull_request:
+    branches: [main, develop]
+    paths-ignore:
+      - "docs/"
+      - "**.md"
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      # Keep running other versions when a job fails
+      fail-fast: false
+
+      matrix:
+        # Run the pipeline on all the currently supported OS versions
+        os: [ubuntu-latest]
+
+        # Run the pipeline on all the currently supported LTS versions and the upcoming version
+        node-version: [19]
+
+        # Run the pipeline on all the currently supported architectures
+        architecture: [x64]
+
+    steps:
+      # Cloning
+      - uses: actions/checkout@v2
+
+      # Setup
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          architecture: ${{ matrix.architecture }}
+
+      # Caching
+      - name: Get NPM cache directory
+        id: npm-cache-dir
+        run: echo "::set-output name=dir::$(npm config get cache)"
+      - name: Cache Node.js modules
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.npm-cache-dir.outputs.dir }}
+          key: ${{ runner.os }}-node-${{ hashFiles('package.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+            ${{ runner.os }}-
+
+      # Dependencies
+      - name: Solidity - Install Dependencies
+        run: npm install
+
+      # Format
+      - name: Solidity - Run Formatter
+        run: npm run format:check
+
+      # Linting
+      - name: Solidity - Run Linter
+        run: npm run lint

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit 

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

commitlint.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["@commitlint/config-conventional"],
+};

package.json

@@ -41,7 +41,7 @@
     "format:check": "prettier  --config .prettierrc.json --ignore-path .prettierignore --check .",
     "lint": "eslint --config .eslintrc.json --ignore-path .eslintignore .",
     "lint:fix": "eslint --config .eslintrc.json --ignore-path .eslintignore . --fix",
-    "prepare": "npm run build",
+    "prepare": "husky install",
     "run": "truffle run syntest-solidity",
     "test": "mocha --config .mocharc.json",
     "test:coverage": "nyc mocha --config .mocharc.json",
@@ -70,6 +70,8 @@
     "web3-utils": "1.8.1"
   },
   "devDependencies": {
+    "@commitlint/cli": "^17.4.2",
+    "@commitlint/config-conventional": "^17.4.2",
     "@types/chai": "4.3.4",
     "@types/chai-as-promised": "7.1.1",
     "@types/mocha": "10.0.1",
@@ -78,8 +80,11 @@
     "@typescript-eslint/eslint-plugin": "5.45.1",
     "@typescript-eslint/parser": "5.45.1",
     "chai": "4.3.7",
+    "commitlint": "^17.4.2",
     "eslint": "8.29.0",
     "eslint-config-prettier": "8.5.0",
+    "husky": "^8.0.3",
+    "lint-staged": "^13.1.0",
     "mocha": "10.2.0",
     "nyc": "15.1.0",
     "prettier": "2.8.1",
@@ -89,5 +94,11 @@
   },
   "engines": {
     "node": ">=10.24.0"
+  },
+  "lint-staged": {
+    "**/*": [
+      "npx prettier --config .prettierrc.json --ignore-path .prettierignore --write .",
+      "npx eslint --config .eslintrc.json --ignore-path .eslintignore --fix ."
+    ]
   }
 }

src/util/network.ts

@@ -79,7 +79,9 @@ export function setNetwork(config: TruffleConfig, api: any): void {
 // eslint-disable-next-line
 export function setOuterConfigKeys(
   config: TruffleConfig,
+  // eslint-disable-next-line
   api: any,
+  // eslint-disable-next-line
   id: any
 ): void {
   try {