docs/readme index tweak

.devcontainer/devcontainer.json

@@ -1,15 +1,15 @@
 {
-	"name": "Hailstorm Development Environment",
-	"image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bookworm",
-	"customizations": {
-		"vscode": {
-			"extensions": [
-				"bradlc.vscode-tailwindcss",
-				"dbaeumer.vscode-eslint",
-				"esbenp.prettier-vscode",
-				"github.vscode-github-actions",
-				"vitest.explorer"
-			]
-		}
-	}
+  "name": "Hailstorm Development Environment",
+  "image": "mcr.microsoft.com/devcontainers/typescript-node:1-22-bookworm",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "bradlc.vscode-tailwindcss",
+        "dbaeumer.vscode-eslint",
+        "esbenp.prettier-vscode",
+        "github.vscode-github-actions",
+        "vitest.explorer"
+      ]
+    }
+  }
 }

.github/pull_request_template.md

@@ -9,4 +9,4 @@
 - [ ] Change is readable and easy to understand
 - [ ] Documentation is updated
 - [ ] Security impact has been considered
-- [ ] Changes validated in runtime
+- [ ] Changes validated in runtime

.github/workflows/auto-author-assign.yml

@@ -1,14 +1,14 @@
 name: Auto Author Assign
 
 on:
-    pull_request_target:
-        types: [opened, reopened]
+  pull_request_target:
+    types: [opened, reopened]
 
 permissions:
-    pull-requests: write
+  pull-requests: write
 
 jobs:
-    assign-author:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: toshimaru/auto-author-assign@v1.6.2
+  assign-author:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: toshimaru/auto-author-assign@v1.6.2

.github/workflows/build.yml

@@ -3,23 +3,23 @@ name: Build
 on: push
 
 env:
-    GH_TOKEN: ${{ secrets.GH_TOKEN }}
-    NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+  GH_TOKEN: ${{ secrets.GH_TOKEN }}
+  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
 jobs:
-    format-check:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v3
-              with:
-                  fetch-depth: 0
-                  persist-credentials: false
-            - uses: pnpm/action-setup@v4
-              with:
-                  version: 9.12.1
-            - uses: actions/setup-node@v4
-              with:
-                  node-version: 20.19.3
-                  cache: "pnpm"
-            - run: pnpm install --frozen-lockfile
-            - run: pnpm run build
+  format-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 10.27.0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: 'pnpm'
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm run build

.github/workflows/format-and-lint.yml

@@ -16,11 +16,11 @@ jobs:
           persist-credentials: false
       - uses: pnpm/action-setup@v4
         with:
-            version: 9.12.1
+          version: 10.27.0
       - uses: actions/setup-node@v4
         with:
-          node-version: 20.19.3
-          cache: "pnpm"
+          node-version: 22
+          cache: 'pnpm'
       - run: pnpm install --frozen-lockfile
       - run: pnpm run lint
-      - run: pnpm run format:check
+      - run: pnpm run format:check

.github/workflows/release.yml

@@ -1,40 +1,40 @@
 name: Semantic Release CI
 
 on:
-    push:
-        branches: [main, beta]
+  push:
+    branches: [main, beta]
 
 env:
-    GH_TOKEN: ${{ secrets.GH_TOKEN }}
-    NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+  GH_TOKEN: ${{ secrets.GH_TOKEN }}
+  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
 permissions:
-    packages: write
+  packages: write
 
 jobs:
-    build:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v3
-              with:
-                  fetch-depth: 0
-                  persist-credentials: false
-            - uses: pnpm/action-setup@v4
-              with:
-                  version: 9.12.1
-            - uses: actions/setup-node@v4
-              with:
-                  node-version: 20.19.3
-                  cache: "pnpm"
-            - run: pnpm install --frozen-lockfile
-            - run: pnpm run build
-            - run: pnpm dlx semantic-release@24
-            
-            # We also release to the github registry, this is because other internal @abusix packages are hosted
-            # there, and pnpm does not let you mix and match registries within a scope
-            - name: Release to Github registry
-              run: |
-                echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" > .npmrc
-                # We disable git checks because semantic release above has bumped the version in the package.json
-                # so we are expecting the git state to be dirty
-                pnpm publish --registry=https://npm.pkg.github.com --no-git-checks
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 10.27.0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: 'pnpm'
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm run build
+      - run: pnpm dlx semantic-release@24
+
+      # We also release to the github registry, this is because other internal @abusix packages are hosted
+      # there, and pnpm does not let you mix and match registries within a scope
+      - name: Release to Github registry
+        run: |
+          echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" > .npmrc
+          # We disable git checks because semantic release above has bumped the version in the package.json
+          # so we are expecting the git state to be dirty
+          pnpm publish --registry=https://npm.pkg.github.com --no-git-checks

.github/workflows/storybook.yml

@@ -14,7 +14,11 @@ jobs:
           persist-credentials: false
       - uses: pnpm/action-setup@v4
         with:
-            version: 9.12.1
+          version: 10.27.0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: 'pnpm'
       - name: Install and Build 🔧
         run: | # Install npm packages and build the Storybook files
           pnpm install
@@ -26,5 +30,5 @@ jobs:
       - name: Deploy 🚀
         uses: JamesIves/github-pages-deploy-action@v4
         with:
-          BRANCH: gh-pages-storybook # The branch the action should deploy to.
-          FOLDER: storybook-static # The folder that the build-storybook script generates files.
+          branch: gh-pages-storybook
+          folder: storybook-static

.github/workflows/test.yaml

@@ -1,25 +1,25 @@
-name: Test Components
+name: Verify
 
 on:
-    push:
-    pull_request:
-        branches:
-            - main
+  push:
+  pull_request:
+    branches:
+      - main
 
 jobs:
-    run-tests:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v4
-              with:
-                  fetch-depth: 0
-                  persist-credentials: false
-            - uses: pnpm/action-setup@v4
-              with:
-                  version: 9.12.1
-            - uses: actions/setup-node@v4
-              with:
-                  node-version: 20.19.3
-                  cache: "pnpm"
-            - run: pnpm install --frozen-lockfile
-            - run: pnpm run test
+  verify:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 10.27.0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: 'pnpm'
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm run verify

.github/workflows/type-check.yaml

@@ -3,23 +3,23 @@ name: Type Check
 on: push
 
 env:
-    GH_TOKEN: ${{ secrets.GH_TOKEN }}
-    NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+  GH_TOKEN: ${{ secrets.GH_TOKEN }}
+  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
 jobs:
-    format-check:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v3
-              with:
-                  fetch-depth: 0
-                  persist-credentials: false
-            - uses: pnpm/action-setup@v4
-              with:
-                  version: 9.12.1
-            - uses: actions/setup-node@v4
-              with:
-                  node-version: 20.19.3
-                  cache: "pnpm"
-            - run: pnpm install --frozen-lockfile
-            - run: pnpm run type-check
+  format-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 10.27.0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: 'pnpm'
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm run type-check

.nvmrc

@@ -1 +1 @@
-v20.19.3
+lts/*

.storybook/main.ts

@@ -1,30 +1,33 @@
-import type { StorybookConfig } from "@storybook/react-vite";
+import type { StorybookConfig } from '@storybook/react-vite'
 
 const config: StorybookConfig = {
-    stories: ["../src/**/*.stories.@(ts|tsx)", "../src/**/*.@(mdx|stories.@(md))"],
-    staticDirs: ["../assets"],
+  stories: [
+    '../src/**/*.stories.@(ts|tsx)',
+    '../src/**/*.@(mdx|stories.@(md))',
+  ],
+  staticDirs: ['../assets'],
 
-    addons: [
-        "@storybook/addon-links",
-        "@storybook/addon-essentials",
-        "@storybook/addon-interactions",
-    ],
+  addons: [
+    '@storybook/addon-links',
+    '@storybook/addon-a11y',
+    '@storybook/addon-designs',
+    '@storybook/addon-docs',
+    '@storybook/addon-vitest',
+  ],
 
-    framework: {
-        name: "@storybook/react-vite",
-        options: {
-            strictMode: true,
-        },
+  framework: {
+    name: '@storybook/react-vite',
+    options: {
+      strictMode: true,
     },
+  },
 
-    docs: {},
+  core: {
+    disableTelemetry: true,
+  },
 
-    core: {
-        disableTelemetry: true,
-    },
-
-    typescript: {
-        reactDocgen: "react-docgen-typescript",
-    },
-};
-export default config;
+  typescript: {
+    reactDocgen: 'react-docgen-typescript',
+  },
+}
+export default config