v1

.github/workflows/ci.yaml

@@ -0,0 +1,126 @@
+name: Continuous Integration
+
+on: pull_request
+
+jobs:
+    unit-test:
+        name: Unit tests
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v4
+
+            - name: Install Node
+              uses: actions/setup-node@v4
+              with:
+                  node-version-file: 'package.json'
+
+            - name: Cache build
+              id: cache-build
+              uses: actions/cache@v4
+              with:
+                  path: packages/nipplejs/**/dist
+                  key: node22-cache-build-${{ hashFiles('packages/tests/**', 'packages/nipplejs/**', 'yarn.lock') }}
+
+            - run: yarn install
+
+            - name: Build package
+              if: steps.cache-build.outputs.cache-hit != 'true'
+              run: yarn build
+
+            - run: yarn test:unit
+
+    e2e:
+        timeout-minutes: 20
+
+        name: End to End
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v4
+
+            - name: Install Node
+              uses: actions/setup-node@v4
+              with:
+                  node-version-file: 'package.json'
+
+            - name: Cache build
+              id: cache-build
+              uses: actions/cache@v4
+              with:
+                  path: packages/nipplejs/**/dist
+                  key: node22-cache-build-${{ hashFiles('packages/tests/**', 'packages/nipplejs/**', 'yarn.lock') }}
+
+            - name: Cache playwright binaries
+              id: cache-playwright-binaries
+              uses: actions/cache@v4
+              with:
+                  path: |
+                      ~/.cache/ms-playwright
+                      ~/Library/Caches/ms-playwright
+                      %USERPROFILE%\AppData\Local\ms-playwright
+                  key: cache-playwright-binaries-${{ hashFiles('yarn.lock') }}
+
+            - run: yarn install
+
+            - name: Install playwright
+              run: yarn workspace @nipple/tests playwright install --with-deps
+
+            - name: Build package
+              if: steps.cache-build.outputs.cache-hit != 'true'
+              run: yarn build
+
+            - run: yarn test:e2e
+
+            - name: Save playwright cache
+              if: always() && steps.cache-playwright-binaries.outputs.cache-hit != 'true'
+              id: save-playwright-cache
+              uses: actions/cache/save@v4
+              with:
+                  path: |
+                      ~/.cache/ms-playwright
+                      ~/Library/Caches/ms-playwright
+                      %USERPROFILE%\AppData\Local\ms-playwright
+                  key: cache-playwright-binaries-${{ hashFiles('yarn.lock') }}
+
+            - uses: actions/upload-artifact@v4
+              if: ${{ failure() }}
+              with:
+                  name: playwright
+                  path: |
+                      packages/tests/playwright-report
+                      packages/tests/test-results
+                  retention-days: 3
+
+    lint:
+        name: Linting
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v4
+
+            - name: Install Node
+              uses: actions/setup-node@v4
+              with:
+                  node-version-file: 'package.json'
+
+            - name: Cache build
+              id: cache-build
+              uses: actions/cache@v4
+              with:
+                  path: packages/nipplejs/**/dist
+                  key: node22-cache-build-${{ hashFiles('packages/nipplejs/**', 'eslint.config.mjs', '.prettierrc', 'yarn.lock') }}
+
+            - run: yarn install
+
+            - name: Build package
+              if: steps.cache-build.outputs.cache-hit != 'true'
+              run: yarn build
+
+            - run: yarn typecheck
+
+            - run: yarn workspace @nipple/docs astro-check
+
+            - run: yarn cli integrity
+
+            - run: git diff --exit-code && git diff --cached --exit-code || (echo "Please run 'yarn cli integrity' and commit the result." && exit 1)

.github/workflows/docs.yaml

@@ -0,0 +1,55 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [master]
+    paths:
+      - 'packages/docs/**'
+      - 'packages/nipplejs/src/**'
+  workflow_dispatch:
+
+permissions:
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: 'package.json'
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - run: yarn install
+
+      - name: Build nipplejs
+        run: yarn build
+
+      - name: Build docs
+        run: yarn workspace @nipple/docs build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: packages/docs/dist
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/release.yaml

@@ -0,0 +1,64 @@
+name: Release
+
+on:
+    release:
+        types: [published]
+    workflow_dispatch:
+        inputs:
+            version:
+                description: 'Version to publish (e.g. 1.0.0). Leave empty to use the version from package.json.'
+                required: false
+                type: string
+
+jobs:
+    release:
+        name: Publish to NPM
+        runs-on: ubuntu-latest
+
+        # Only run on master
+        if: github.ref == 'refs/heads/master'
+
+        permissions:
+            contents: write
+            id-token: write
+
+        steps:
+            - uses: actions/checkout@v4
+
+            - name: Install Node
+              uses: actions/setup-node@v4
+              with:
+                  node-version-file: 'package.json'
+                  registry-url: 'https://registry.npmjs.org'
+
+            - run: yarn install
+
+            - name: Update version
+              if: inputs.version != ''
+              working-directory: packages/nipplejs
+              env:
+                  RELEASE_VERSION: ${{ inputs.version }}
+              run: npm version "$RELEASE_VERSION" --no-git-tag-version
+
+            - name: Commit version bump
+              if: inputs.version != ''
+              env:
+                  RELEASE_VERSION: ${{ inputs.version }}
+              run: |
+                  git config user.name "github-actions[bot]"
+                  git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+                  git add packages/nipplejs/package.json
+                  git commit -m "chore: bump version to $RELEASE_VERSION"
+                  git push
+
+            - run: yarn build
+
+            - run: yarn test:unit
+
+            - run: yarn test:e2e
+
+            - name: Publish
+              working-directory: packages/nipplejs
+              run: npm publish --provenance --access public
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,4 +1,15 @@
+yarn-error.log
+.yarn/*
+!.yarn/cache
+!.yarn/patches
+!.yarn/releases
+!.yarn/plugins
+!.vscode
+
+.DS_Store
 node_modules/
 dist/
-.vscode
-.DS_Store
+packages/nipplejs/e2e/public/
+.claude/
+.superpowers/
+.astro/

.vscode/settings.json

@@ -0,0 +1,31 @@
+{
+    "eslint.enable": true,
+    "eslint.validate": ["javascript", "typescript"],
+    "[yaml]": {
+        "editor.formatOnSave": false
+    },
+    "[javascript]": {
+        "editor.formatOnSave": false
+    },
+    "[typescript]": {
+        "editor.formatOnSave": false
+    },
+    "[markdown]": {
+        "editor.formatOnSave": false
+    },
+    "editor.formatOnSave": true,
+    "editor.rulers": [100],
+    "typescript.preferences.importModuleSpecifier": "relative",
+    "editor.codeActionsOnSave": {
+        "source.fixAll.eslint": "explicit"
+    },
+    "prettier.configPath": "prettier.config.js",
+    "search.exclude": {
+        "**/.pnp.js": true,
+        "**/.yarn/": true,
+        "**/.yarnrc.yml": true,
+        "**/yarn.lock": true
+    },
+    "typescript.tsdk": "node_modules/typescript/lib",
+    "git-blame.gitWebUrl": "https://github.com/yoannmoinet/nipplejs/commit/$ID"
+}