Feat/responsiveness

.fliegdocrc.js

@@ -5,12 +5,12 @@ module.exports = {
 	modules: [
 		{
 			package: './packages/vertx-event-bus/package.json',
-			tsconfig: './packages/vertx-event-bus/tsconfig.build.json',
+			tsconfig: './packages/vertx-event-bus/tsconfig.json',
 			mainFile: 'index.ts'
 		},
 		{
 			package: './packages/vertx-mock-server/package.json',
-			tsconfig: './packages/vertx-mock-server/tsconfig.build.json',
+			tsconfig: './packages/vertx-mock-server/tsconfig.json',
 			mainFile: 'index.ts'
 		},
 		{
@@ -20,19 +20,25 @@ module.exports = {
 		},
 		{
 			package: './packages/telestion-client-prop-types/package.json',
-			tsconfig: './packages/telestion-client-prop-types/tsconfig.build.json',
+			tsconfig: './packages/telestion-client-prop-types/tsconfig.json',
 			mainFile: 'index.ts'
 		},
 		{
 			package: './packages/telestion-client-core/package.json',
-			tsconfig: './packages/telestion-client-core/tsconfig.build.json',
+			tsconfig: './packages/telestion-client-core/tsconfig.json',
 			mainFile: 'index.ts'
 		},
 		{
 			package: './packages/telestion-client-common/package.json',
-			tsconfig: './packages/telestion-client-common/tsconfig.build.json',
+			tsconfig: './packages/telestion-client-common/tsconfig.json',
 			mainFile: 'index.ts'
 		}
+		// TODO: Comment in once ts-morph in fliegdoc supports TS 4.7
+		// {
+		// 	package: './packages/telestion-client-cli/package.json',
+		// 	tsconfig: './packages/telestion-client-cli/tsconfig.json',
+		// 	mainFile: 'api.mts'
+		// }
 	],
 	title: 'Telestion Client Monorepo',
 	externalLinks: {

.github/workflows/chromatic.yml

@@ -10,6 +10,11 @@ on:
       - main
   workflow_dispatch:
 
+# Defines which tool versions should be used in all workflow jobs
+env:
+  node: '16'
+  pnpm: '7.0.0-rc.3'
+
 jobs:
   chromatic-deployment:
     name: Deployment
@@ -19,32 +24,22 @@ jobs:
       - name: Checkout 📥
         uses: actions/[email protected]
         with:
-          fetch-depth: 0 # Required to retrieve git history
+          fetch-depth: 0
+      - name: Setup PNPM 💿
+        uses: pnpm/[email protected]
+        with:
+          version: ${{ env.pnpm }}
       - name: Setup Node 💿
         uses: actions/[email protected]
         with:
-          node-version: 14
-
-      - name: Restore npm cache ♻️
-        uses: actions/[email protected]
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-
-      # Remove, when setup-node action supports specifying the node version
-      - name: Install npm v7 ⬆
-        run: npm install --prefer-offline --no-audit --global npm@v7
+          node-version: ${{ env.node }}
+          cache: 'pnpm'
 
-      - name: Install development dependencies 📚
-        run: npm ci --prefer-offline --no-audit --ignore-scripts
+      - name: Install dependencies 📚
+        run: pnpm install
       - name: Build packages 📦
-        run: npm run build:all
-      - name: Publish to Chromatic 📡
-        uses: chromaui/action@v1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          # 👇 Chromatic projectToken, refer to the manage page to obtain it.
-          projectToken: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}
-          exitZeroOnChanges: true
+        run: pnpm build
+      - name: Publish to Chromatic
+        run: pnpm chromatic
+        env:
+          CHROMATIC_PROJECT_TOKEN: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}

.github/workflows/ci.yml

@@ -1,126 +1,135 @@
 name: CI
+
+# Events that trigger this workflow
 on: [push, pull_request]
 
+# Defines which tool versions should be used in all workflow jobs
+env:
+  node: '16'
+  pnpm: '7.0.0-rc.3'
+
 jobs:
   style:
     name: Style
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 📥
         uses: actions/[email protected]
+      - name: Setup PNPM 💿
+        uses: pnpm/[email protected]
+        with:
+          version: ${{ env.pnpm }}
       - name: Setup Node 💿
         uses: actions/[email protected]
         with:
-          node-version: 14
+          node-version: ${{ env.node }}
+          cache: 'pnpm'
 
-      - name: Restore npm cache ♻️
-        uses: actions/[email protected]
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-
-      # Remove, when setup-node action supports specifying the node version
-      - name: Install npm v7 ⬆
-        run: npm install --prefer-offline --no-audit --global npm@v7
-
-      - name: Install development dependencies 📚
-        run: npm ci --prefer-offline --no-audit --ignore-scripts
+      - name: Install dependencies 📚
+        run: pnpm install
       - name: Check code style 🧽
-        run: npm run style:ci
+        run: pnpm style:ci
 
   lint:
     name: Lint
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 📥
         uses: actions/[email protected]
+      - name: Setup PNPM 💿
+        uses: pnpm/[email protected]
+        with:
+          version: ${{ env.pnpm }}
       - name: Setup Node 💿
         uses: actions/[email protected]
         with:
-          node-version: 14
+          node-version: ${{ env.node }}
+          cache: 'pnpm'
 
-      - name: Restore npm cache ♻️
-        uses: actions/[email protected]
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
+      - name: Install dependencies 📚
+        run: pnpm install
+      - name: Run Linter 📑
+        run: pnpm lint
 
-      # Remove, when setup-node action supports specifying the node version
-      - name: Install npm v7 ⬆
-        run: npm install --prefer-offline --no-audit --global npm@v7
+  check:
+    name: Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 📥
+        uses: actions/[email protected]
+      - name: Setup PNPM 💿
+        uses: pnpm/[email protected]
+        with:
+          version: ${{ env.pnpm }}
+      - name: Setup Node 💿
+        uses: actions/[email protected]
+        with:
+          node-version: ${{ env.node }}
+          cache: 'pnpm'
 
-      - name: Install development dependencies 📚
-        run: npm ci --prefer-offline --no-audit --ignore-scripts
-      - name: Run Linter 📑
-        run: npm run lint
+      - name: Install dependencies 📚
+        run: pnpm install
+      - name: Check types 📑
+        run: |
+          pnpm build
+          pnpm check
 
   build:
     name: Build
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 📥
         uses: actions/[email protected]
+      - name: Setup PNPM 💿
+        uses: pnpm/[email protected]
+        with:
+          version: ${{ env.pnpm }}
       - name: Setup Node 💿
         uses: actions/[email protected]
         with:
-          node-version: 14
-
-      - name: Restore npm cache ♻️
-        uses: actions/[email protected]
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
+          node-version: ${{ env.node }}
+          cache: 'pnpm'
 
-      # Remove, when setup-node action supports specifying the node version
-      - name: Install npm v7 ⬆
-        run: npm install --prefer-offline --no-audit --global npm@v7
-
-      - name: Install development dependencies 📚
-        run: npm ci --prefer-offline --no-audit --ignore-scripts
+      - name: Install dependencies 📚
+        run: pnpm install
       - name: Build packages 📦
-        run: npm run build:all
+        run: pnpm build
 
       - name: Upload vertx-event-bus build artifact 📤
         uses: actions/[email protected]
         with:
-          name: vertx-event-bus_build-${{ github.run_number }}
-          path: packages/vertx-event-bus/build/
+          name: packages_vertx-event-bus_dist-${{ github.run_number }}
+          path: packages/vertx-event-bus/dist/
           retention-days: 7
       - name: Upload vertx-mock-server build artifact 📤
         uses: actions/[email protected]
         with:
-          name: vertx-mock-server_build-${{ github.run_number }}
-          path: packages/vertx-mock-server/build/
+          name: packages_vertx-mock-server_dist-${{ github.run_number }}
+          path: packages/vertx-mock-server/dist/
           retention-days: 7
       - name: Upload telestion-client-types build artifact 📤
         uses: actions/[email protected]
         with:
-          name: telestion-client-types_build-${{ github.run_number }}
+          name: packages_telestion-client-types_types-${{ github.run_number }}
           path: packages/telestion-client-types/types/
           retention-days: 7
       - name: Upload telestion-client-prop-types build artifact 📤
         uses: actions/[email protected]
         with:
-          name: telestion-client-prop-types_build-${{ github.run_number }}
-          path: packages/telestion-client-prop-types/build/
+          name: packages_telestion-client-prop-types_dist-${{ github.run_number }}
+          path: packages/telestion-client-prop-types/dist/
           retention-days: 7
       - name: Upload telestion-client-core build artifact 📤
         uses: actions/[email protected]
         with:
-          name: telestion-client-core_build-${{ github.run_number }}
-          path: packages/telestion-client-core/build/
+          name: packages_telestion-client-core_dist-${{ github.run_number }}
+          path: packages/telestion-client-core/dist/
           retention-days: 7
       - name: Upload telestion-client-common build artifact 📤
         uses: actions/[email protected]
         with:
-          name: telestion-client-common_build-${{ github.run_number }}
-          path: packages/telestion-client-common/build/
+          name: packages_telestion-client-common_dist-${{ github.run_number }}
+          path: packages/telestion-client-common/dist/
           retention-days: 7
 
   test:
@@ -129,26 +138,19 @@ jobs:
     steps:
       - name: Checkout 📥
         uses: actions/[email protected]
+      - name: Setup PNPM 💿
+        uses: pnpm/[email protected]
+        with:
+          version: ${{ env.pnpm }}
       - name: Setup Node 💿
         uses: actions/[email protected]
         with:
-          node-version: 14
-
-      - name: Restore npm cache ♻️
-        uses: actions/[email protected]
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-
-      # Remove, when setup-node action supports specifying the node version
-      - name: Install npm v7 ⬆
-        run: npm install --prefer-offline --no-audit --global npm@v7
+          node-version: ${{ env.node }}
+          cache: 'pnpm'
 
-      - name: Install development dependencies 📚
-        run: npm ci --prefer-offline --no-audit --ignore-scripts
-      - name: Build packages 📦
-        run: npm run build:all
+      - name: Install dependencies 📚
+        run: pnpm install
       - name: Run unit tests and generate coverage 🛃
-        run: npm run test
+        run: |
+          pnpm build
+          pnpm test