WIP

LironEr · May 17, 2024 · 99924f9 · 99924f9
1 parent fd3e19b
commit 99924f9
Show file tree

Hide file tree

Showing 16 changed files with 153 additions and 593 deletions.
diff --git a/.github/workflows/build-web.yml b/.github/workflows/build-web.yml
@@ -10,38 +10,33 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '18'
           cache: 'yarn'
 
       - name: Install dependencies
         run: yarn
 
-      - name: Build packages
-        run: yarn build-packages
-
       - name: Build
-        working-directory: ./website
+        working-directory: ./apps/website
         run: yarn build
 
-      # need to build packages in order to run the bundlemon action on the current CLI
-      - name: Build packages
-        run: yarn build-packages
-
       - name: BundleMon
-        uses: lironer/bundlemon-action@v1
-        with:
-          working-directory: ./website
+        working-directory: ./apps/website
+        run: yarn bundlemon
+        env:
+          CI_COMMIT_SHA: ${{github.event.pull_request.head.sha || github.sha}} # important!
+          CI_COMMIT_MESSAGE: ${{ github.event.head_commit.message }}
 
       - name: Deploy
         if: ${{ github.ref_name == 'master' }}
-        working-directory: ./website
+        working-directory: ./apps/website
         env:
           NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
           NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
           # https://securitylab.github.com/research/github-actions-untrusted-input/
           COMMIT_MSG: ${{ github.event.head_commit.message }}
-        run: yarn deploy:prod --message "$COMMIT_MSG"
+        run: yarn deploy --prod --message "$COMMIT_MSG"
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -16,9 +16,9 @@ jobs:
         node-version: [18.x, 20.x]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'yarn'
@@ -31,7 +31,7 @@ jobs:
 
       - name: Test
         env:
-          NODE_OPTIONS: "--max_old_space_size=4096"
+          NODE_OPTIONS: '--max_old_space_size=4096'
         run: yarn test-packages
 
       - uses: codecov/codecov-action@v1
@@ -43,73 +43,61 @@ jobs:
         if: ${{ matrix.node-version == '18.x' }} # run this step only one time
         run: yarn lint-packages
 
-      - name: Type check
-        if: ${{ matrix.node-version == '18.x' }} # run this step only one time
-        run: yarn type-check-packages
-
   website:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '18'
           cache: 'yarn'
 
       - name: Install dependencies
         run: yarn
 
-      - name: Build packages
-        run: yarn build-packages
-
-      - name: type check
-        working-directory: ./website
-        run: yarn type-check
-
       - name: Lint
-        working-directory: ./website
+        working-directory: ./apps/website
         run: yarn lint
 
   service:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Run docker compose
-        run: docker-compose -f service/docker-compose.test.yml up -d
+      - name: Start mock services
+        working-directory: ./apps/service
+        run: yarn start:mock-services
 
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '18'
           cache: 'yarn'
 
       - name: Install dependencies
         run: yarn
 
-      - name: Build packages
-        run: yarn build-packages
-
       - name: Test
-        working-directory: ./service
+        working-directory: ./apps/service
         run: yarn test
 
       - uses: codecov/codecov-action@v1
         with:
           file: ./service/coverage/coverage-final.json
 
-      - name: type check
-        working-directory: ./service
-        run: yarn type-check
-
       - name: Lint
-        working-directory: ./service
+        working-directory: ./apps/service
         run: yarn lint
 
       - name: Build
-        working-directory: ./service
+        working-directory: ./apps/service
         run: yarn build
+
+      - name: Stop mock services
+        if: always()
+        working-directory: ./apps/service
+        run: yarn stop:mock-services
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -24,7 +24,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v2

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,7 +6,7 @@ Thanks for taking the time to contribute! ❤️
 
 ### Prerequisites
 
-- [Node.js](https://nodejs.org/) >= v14
+- [Node.js](https://nodejs.org/) >= v18
 - [Yarn](https://yarnpkg.com/en/docs/install)
 
 #### Install dependencies
@@ -35,12 +35,12 @@ Requires `docker` & `docker-compose`
 
 #### Start service
 
-When changing code in `service/` directory the service will reload itself
+When changing code in `apps/service/` directory the service will reload itself
 
-Run from root directory
+Run from `apps/service/` directory
 
 ```
-yarn start:service
+yarn serve
 ```
 
 By default the service will start on port `3333`
@@ -55,7 +55,7 @@ yarn gen-local-data
 
 #### Run tests
 
-Run from `service/` directory
+Run from `apps/service/` directory
 
 ```bash
 yarn start:mock-services
@@ -68,7 +68,7 @@ yarn test
 ### BundleMon website
 
 ```bash
-yarn start
+yarn serve
 ```
 
 After running the command the website will be available at https://localhost:4000/

diff --git a/apps/service/package.json b/apps/service/package.json
@@ -4,12 +4,13 @@
   "private": true,
   "license": "MIT",
   "scripts": {
-    "serve": "yarn nx serve service",
-    "build": "yarn nx build service",
+    "serve": "yarn --cwd ../../ nx serve service",
+    "build": "yarn --cwd ../../ nx build service",
     "generate-schemas": "node ./scripts/generateSchemas.js",
-    "prevercel-deploy": "yarn nx build service -c vercel",
+    "prevercel-deploy": "yarn --cwd ../../ nx build service -c vercel",
     "vercel-deploy": "vercel deploy",
     "start:mock-services": "docker-compose -f docker-compose.test.yml up --remove-orphans",
+    "stop:mock-services": "docker-compose -f docker-compose.test.yml down",
     "gen-local-data": "node -r @swc-node/register -r dotenv/config ./scripts/generateLocalData.ts dotenv_config_path=.development.env"
   },
   "dependencies": {
@@ -18,8 +19,8 @@
     "@fastify/secure-session": "^7.4.0",
     "@octokit/auth-app": "^6.0.0",
     "@octokit/rest": "^20.0.1",
-    "bundlemon-markdown-output": "^1.0.0",
-    "bundlemon-utils": "^1.2.1",
+    "bundlemon-markdown-output": "^2.0.0-rc.0",
+    "bundlemon-utils": "^2.0.0-rc.0",
     "env-var": "^7.3.1",
     "fastify": "^4.26.2",
     "mongodb": "^6.3.0"

diff --git a/apps/service/tsconfig.json b/apps/service/tsconfig.json
@@ -17,5 +17,5 @@
     }
   ],
   "files": [],
-  "include": [],
+  "include": []
 }
diff --git a/apps/website/package.json b/apps/website/package.json
@@ -7,15 +7,16 @@
     "build": "yarn --cwd ../../ nx build website --verbose",
     "serve": "yarn --cwd ../../ nx serve website --verbose",
     "serve:preview": "yarn --cwd ../../ nx preview website --verbose",
-    "bundlemon": "node -r @swc-node/register ../../packages/bundlemon/bin/bundlemon.ts"
+    "bundlemon": "node -r @swc-node/register ../../packages/bundlemon/bin/bundlemon.ts",
+    "deploy": "netlify deploy --dir ../../dist/apps/website"
   },
   "dependencies": {
     "@emotion/react": "^11.11.1",
     "@emotion/styled": "^11.11.0",
     "@mui/icons-material": "^5.14.13",
     "@mui/lab": "^5.0.0-alpha.148",
     "@mui/material": "^5.14.13",
-    "bundlemon-utils": "^1.2.1",
+    "bundlemon-utils": "^2.0.0-rc.0",
     "material-react-table": "^1.15.0",
     "mobx": "^6.10.2",
     "mobx-react-lite": "^4.0.5",
@@ -33,7 +34,7 @@
     "@types/react-router-dom": "^5.3.3",
     "@types/recharts": "^1.8.25",
     "@vitejs/plugin-basic-ssl": "^1.1.0",
-    "esbuild-loader": "^4.0.2",
+    "eslint-plugin-jsx-a11y": "^6.8.0",
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "netlify-cli": "^16.7.0",

diff --git a/package.json b/package.json
@@ -3,11 +3,9 @@
   "license": "MIT",
   "scripts": {
     "test-packages": "yarn nx run-many --target=test --projects tag:type:lib --verbose",
-    "build-packages": "nx run-many --target=build --projects tag:type:lib",
+    "build-packages": "nx run-many --target=build --projects tag:type:lib --verbose",
     "build-packages:watch": "nx watch --projects tag:type:lib -- nx run \\$NX_PROJECT_NAME:build",
-    "lint-packages": "yarn nx run-many --target=lint --projects tag:type:lib",
-    "type-check-packages": "lerna run type-check --stream",
-    "start:service": "docker-compose -f docker-compose.dev.yml up --build",
+    "lint-packages": "yarn nx run-many --target=lint --projects tag:type:lib  --verbose",
     "prepare": "husky install"
   },
   "devDependencies": {
@@ -23,8 +21,6 @@
     "@types/jest": "^29.5.1",
     "@types/jest-when": "^3.5.2",
     "@types/node": "18.16.9",
-    "@types/react": "18.2.33",
-    "@types/react-dom": "18.2.14",
     "@typescript-eslint/eslint-plugin": "^6.4.0",
     "@typescript-eslint/parser": "^6.4.0",
     "@vitejs/plugin-react": "^4.2.0",
@@ -37,14 +33,11 @@
     "husky": "^8.0.3",
     "jest": "^29.7.0",
     "jest-when": "^3.5.2",
-    "jsdom": "~22.1.0",
     "lint-staged": "^15.2.2",
     "nx": "18.3.2",
     "prettier": "^3.0.2",
     "ts-jest": "^29.1.0",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.0.4",
-    "vite": "~5.0.0"
+    "typescript": "^5.0.4"
   },
   "engines": {
     "yarn": "^1.10.0"

diff --git a/packages/bundlemon-markdown-output/package.json b/packages/bundlemon-markdown-output/package.json
@@ -1,6 +1,6 @@
 {
   "name": "bundlemon-markdown-output",
-  "version": "1.0.0",
+  "version": "2.0.0-rc.0",
   "description": "",
   "keywords": [],
   "author": "Liron Er",
@@ -12,13 +12,13 @@
     "directory": "packages/bundlemon-markdown-output"
   },
   "engines": {
-    "node": ">=14.16"
+    "node": ">=18"
   },
   "main": "lib/index",
   "types": "lib/index.d.ts",
   "scripts": {},
   "dependencies": {
-    "bundlemon-utils": "^1.2.1",
+    "bundlemon-utils": "^2.0.0-rc.0",
     "bytes": "^3.1.0"
   },
   "devDependencies": {

diff --git a/packages/bundlemon-markdown-output/project.json b/packages/bundlemon-markdown-output/project.json
@@ -15,7 +15,11 @@
         "main": "{projectRoot}/lib/index.ts",
         "updateBuildableProjectDepsInPackageJson": false,
         "assets": [
-          "README.md",
+          {
+            "input": "{projectRoot}",
+            "glob": "README.md",
+            "output": "/"
+          },
           "LICENSE",
           {
             "input": "{projectRoot}",

diff --git a/packages/bundlemon-markdown-output/tsconfig.json b/packages/bundlemon-markdown-output/tsconfig.json
@@ -10,4 +10,4 @@
       "path": "./tsconfig.spec.json"
     }
   ]
-}
+}
diff --git a/packages/bundlemon-utils/package.json b/packages/bundlemon-utils/package.json
@@ -1,6 +1,6 @@
 {
   "name": "bundlemon-utils",
-  "version": "1.2.1",
+  "version": "2.0.0-rc.0",
   "description": "",
   "keywords": [],
   "author": "Liron Er",
@@ -12,7 +12,7 @@
     "directory": "packages/bundlemon-utils"
   },
   "engines": {
-    "node": ">=14.16"
+    "node": ">=18"
   },
   "main": "lib/index",
   "types": "lib/index.d.ts",

diff --git a/packages/bundlemon-utils/project.json b/packages/bundlemon-utils/project.json
@@ -15,7 +15,11 @@
         "main": "{projectRoot}/lib/index.ts",
         "updateBuildableProjectDepsInPackageJson": false,
         "assets": [
-          "README.md",
+          {
+            "input": "{projectRoot}",
+            "glob": "README.md",
+            "output": "/"
+          },
           "LICENSE",
           {
             "input": "{projectRoot}",

diff --git a/packages/bundlemon-utils/tsconfig.json b/packages/bundlemon-utils/tsconfig.json
@@ -10,4 +10,4 @@
       "path": "./tsconfig.spec.json"
     }
   ]
-}
+}