Update paima-engine to use a single workspace (#225)

.github/workflows/nodejs.yml

@@ -2,23 +2,23 @@ name: NodeJS Continuous Health Check
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
     paths-ignore:
-      - "documentation/**"
-      - "README.md"
-      - "errors.log"
+      - 'documentation/**'
+      - 'README.md'
+      - 'errors.log'
   pull_request:
-    branches: [ master ]
+    branches: [master]
     paths-ignore:
-      - "documentation/**"
-      - "README.md"
-      - "errors.log"
+      - 'documentation/**'
+      - 'README.md'
+      - 'errors.log'
 
 jobs:
   node_ci:
     runs-on: ${{ matrix.os }}
     env:
-      NODE_CACHE: "npm"
+      NODE_CACHE: 'npm'
 
     strategy:
       fail-fast: false
@@ -27,30 +27,26 @@ jobs:
         node: [18]
 
     steps:
-      -
-        name: Check out repository
+      - name: Check out repository
         if: ${{ github.event_name == 'push' || github.event_name == 'pull_request' }}
         uses: actions/checkout@v3
-      -
-        name: Setup node env
+        with:
+          # We need to fetch all branches and commits so that Nx affected has a base to compare against.
+          fetch-depth: 0
+      - name: Setup node env
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
           check-latest: false
           registry-url: https://registry.npmjs.org
           # cache: ${{ env.NODE_CACHE }}
           # cache-dependency-path: ${{ matrix.dir }}/package-lock.json
-      -
-        name: Cleanup for node > 16
-        if: ${{ matrix.node!='16' }}
-        shell: bash -e -l {0}
-        run: |
-          sh wipe.sh keep-package-lock
-          npm i --no-audit
-      -
-        name: Build workspace
-        shell: bash -e -l {0}
-        run: |
-          npm ci --prefer-offline --no-audit
-          npm run --if-present build
-          npm run --if-present cilint
+      - uses: nrwl/nx-set-shas@v3
+      - name: Install deps
+        run: npm ci --prefer-offline --no-audit
+      - name: Lint affected
+        run: npm run lint
+      - name: Test affected
+        run: npx nx affected -t test
+      - name: Build affected
+        run: npm run build

.prettierrc

@@ -4,5 +4,14 @@
   "semi": true,
   "singleQuote": true,
   "printWidth": 100,
-  "arrowParens": "avoid"
+  "arrowParens": "avoid",
+  "plugins": ["prettier-plugin-solidity", "prettier-plugin-organize-imports"],
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "parser": "solidity-parse"
+      }
+    }
+  ]
 }

.vscode/settings.json

@@ -12,5 +12,6 @@
   },
   "[json][jsonc][json5]": {
     "editor.formatOnSave": true
-  }
+  },
+  "eslint.experimental.useFlatConfig": true,
 }

README.md

@@ -45,6 +45,8 @@ The `Paima Contract` is deployed on-chain which allows users to submit game inpu
 
 Paima Engine is a TypeScript monorepo implemented with npm (not Yarn nor Lerna) workspaces. The `package.json` file at the root indicates all the common dependencies (mostly devDependencies like TypeScript, ESLint etc.), and the root `tsconfig.json` indicates the common TypeScript configuration. Every package has also its own `package.json` and `tsconfig.json` files indicating their particular configuration.
 
+1. Setup an ssh agent so you don't have to enter your Git ssh key every time (`eval "$(ssh-agent -s)"` followed by `ssh-add ~/.ssh/your_github_key`)
 1. `npm install` (generate the common `node_modules` folder with all the combined dependencies of all packages)
 1. `npm run build` (to see if the build succeeds)
-1. `npm run release` (for production builds. see `bin` folder for build result)
+1. (executable) `npm run release:bin` (for production builds. see `bin` folder for build result)
+1. (libraries) `npm run release:lib`