v4

.github/workflows/main.yml

@@ -1,4 +1,7 @@
-name: ci
+name: CI
+
+env:
+  ANALYZE: true
 
 on:
   push:
@@ -11,47 +14,47 @@ on:
 
 jobs:
   build:
-    name: Build, lint, and test on Node ${{ matrix.node }} and ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        node: ['20.x']
-        os: [ubuntu-latest]
+    name: Build, lint and test
+    runs-on: ubuntu-latest
     steps:
-      - name: Checkout repo
-        uses: actions/checkout@v2
+      - name: 🛒 Checkout Repo
+        uses: actions/checkout@v4
 
-      - name: Cache pnpm modules
-        uses: actions/cache@v2
-        with:
-          path: ~/.pnpm-store
-          key: ${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-
+      - uses: pnpm/action-setup@v4
 
-      - name: Use Node ${{ matrix.node }}
-        uses: actions/setup-node@v2
+      - name: ⚒️ Use Node.js
+        uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node }}
+          node-version-file: '.nvmrc'
+          cache: 'pnpm'
 
-      - name: Install dependencies
+      - name: Install Dependencies
         run: npm run bootstrap
 
+      - name: Build Library
+        run: pnpm --filter ./lib build
+
       - name: Lint
-        run: pnpm lint
+        run: pnpm lint --reporter=github
 
-      - name: Test:Execute
-        run: pnpm run test
+      - name: Run Tests
+        run: |
+          pnpm run test
+          cat ${{github.workspace}}/example/tests/coverage-reports/coverage-summary.md >> $GITHUB_STEP_SUMMARY
 
-      - name: Test:Upload
-        uses: paambaati/[email protected]
+      - name: Check Package
+        run: pnpm --filter ./lib run check
+
+      - name: Upload Coverage
+        uses: paambaati/[email protected]
         env:
           CC_TEST_REPORTER_ID: '${{ secrets.CC_TEST_REPORTER_ID }}'
         with:
-          coverageLocations: ${{github.workspace}}/coverage/*.info:lcov
+          debug: true
+          workingDirectory: ${{github.workspace}}/lib
+          coverageLocations: ${{github.workspace}}/example/tests/coverage-reports/*.info:lcov
 
-      # Disabled until https://github.com/pnpm/pnpm/issues/6424 is resolved.
-      # - uses: preactjs/compressed-size-action@v2
-      #   with:
-      #     repo-token: '${{ secrets.GITHUB_TOKEN }}'
-      #     build-script: 'build'
+      - name: Analyze esbuild bundle size
+        uses: exoego/esbuild-bundle-analyzer@v1
+        with:
+          metafiles: "lib/dist/metafile-esm.json"

.github/workflows/publish-preview.yml

@@ -0,0 +1,29 @@
+name: Publish Preview Release
+on:
+  pull_request:
+    types: [synchronize]
+jobs:
+  approved:
+    if: contains(join(github.event.pull_request.labels.*.name, ','), 'publish-preview')
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 🛒 Checkout repo
+        uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+
+      - name: ⚒️ Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'pnpm'
+
+      - name: 📦 Install Dependencies
+        run: npm run bootstrap
+
+      - name: 🔨 Build
+        run: pnpm run --filter react-image-turntable build
+
+      - name: 🚀 Publish Preview Release
+        run: pnpx pkg-pr-new publish './lib' --template='./example'

.gitignore

@@ -12,3 +12,5 @@ storybook-static
 .nyc_output
 test-results/
 playwright-report/
+lib/README.md
+lib/LICENSE

.husky/post-merge

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 pnpm i --frozen-lockfile

.husky/pre-commit

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-pnpm lint-staged && pnpm run test:no-coverage
+pnpm biome check --staged --files-ignore-unknown=true --write --no-errors-on-unmatched

.vscode/extensions.json

@@ -1,3 +1,3 @@
 {
-  "recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
+  "recommendations": ["biomejs.biome"]
 }

.vscode/settings.json

@@ -1,25 +1,8 @@
 {
-  "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
-  },
-  "editor.rulers": [100],
+  "editor.defaultFormatter": "biomejs.biome",
   "editor.formatOnSave": true,
-  "eslint.packageManager": "pnpm",
-  "[javascript]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[javascriptreact]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[jsonc]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[typescript]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[typescriptreact]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  "editor.codeActionsOnSave": {
+    "source.fixAll.biome": "always"
   },
-  "javascript.suggest.autoImports": false,
-  "typescript.suggest.autoImports": false
+  "editor.rulers": [100]
 }

CONTRIBUTING.md

@@ -2,37 +2,44 @@
 
 Thanks for contributing!
 
+## About
+
+The repo is split up into [`lib`](./lib) for the main library code and [`example`](./example) for
+demos and testing.
+
+If you're on Windows, it's recommended that you use WSL.
+
+## Standards
+
+- Commits use the [Conventional Commits](https://conventionalcommits.org/) standard
+- pnpm to manage dependencies
+- [fnm](https://github.com/Schniz/fnm) or [nvm](https://github.com/nvm-sh/nvm) to manage Node.js versions
+- EditorConfig and Biome for formatting
+- Biome for linting
+- Husky for Git hooks
+
 ## Getting Started
 
 Ensure you're using the Node version specified in [.nvmrc](./.nvmrc) and run the following to
-bootstrap the project:
+set up the project:
 
 ```sh
-npm run dx
+npm run bootstrap
 ```
 
-Then run the following commands in separate terminals:
+Then run the following:
 
 ```sh
 # Run both the library dev build and the `example` repo dev server
-pnpm run dev
+pnpm -r run start
 
 # Or run them separately
 ## Start the library dev build
-pnpm run start
+pnpm run --filter ./lib start
 ## Start the `example` codebase dev build
-pnpm run --prefix example start
+pnpm run --filter ./example start
 ```
 
-## Standards
-
-- Commits use the [Conventional Commits](https://conventionalcommits.org/) standard
-- pnpm to manage dependencies
-- nvm to manage Node.js versions
-- Prettier & EditorConfig for code style
-- ESLint for quality
-- Husky for Git hooks
-
 ## VS Code
 
 If you're using VS Code please make sure you install the [recommended extensions](./.vscode/extensions.json).