@sablier/devkit 1.5.1 → 1.6.1

package/README.md

@@ -1,33 +1,152 @@
 # 🛠️ Sablier Devkit
 
-This repository contains configuration files and reusable scripts for various Sablier repositories.
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![npm](https://img.shields.io/npm/v/@sablier/devkit)](https://www.npmjs.com/package/@sablier/devkit)
 
-The files are meant to be extended and customized as needed.
+Configuration files and reusable scripts for Sablier repositories. Designed to be extended and customized as needed.
 
-## ⚙️ Config Files
+## 📦 Installation
 
-| Tool            | Config File/Directory                 |
-| --------------- | :------------------------------------ |
-| 🔍 Biome        | [`biome.jsonc`](./biome.jsonc)        |
-| 📝 EditorConfig | [`.editorconfig`](./.editorconfig)    |
-| 🛠 Just         | [`just/`](./just/)                    |
-| ✨ Prettier     | [`prettier.json`](./.prettierrc.json) |
-| 📦 TSConfig     | [`tsconfig/`](./tsconfig/)            |
+```bash
+npm install @sablier/devkit
+```
+
+Or with other package managers:
+
+```bash
+pnpm add @sablier/devkit
+bun add @sablier/devkit
+```
+
+## 🚀 Usage
+
+### Biome
+
+Extend the base Biome configuration in your `biome.jsonc`:
+
+```jsonc
+{
+  "$schema": "https://biomejs.dev/schemas/2.0.6/schema.json",
+  "extends": ["@sablier/devkit/biome"],
+}
+```
+
+For UI projects, use the UI variant:
+
+```jsonc
+{
+  "extends": ["@sablier/devkit/biome/ui"],
+}
+```
+
+### Prettier
+
+Reference the Prettier config in your `package.json`:
+
+```json
+{
+  "prettier": "@sablier/devkit/prettier"
+}
+```
+
+### TypeScript
+
+Extend TSConfig presets in your `tsconfig.json`:
+
+```json
+{
+  "extends": "@sablier/devkit/tsconfig/base"
+}
+```
+
+Available presets:
+
+- `@sablier/devkit/tsconfig/base` — Base TypeScript configuration
+- `@sablier/devkit/tsconfig/build` — Build-optimized configuration
+- `@sablier/devkit/tsconfig/next` — Next.js configuration
+
+### Vitest
+
+Use the devkit vitest config factory in your `vitest.config.ts`:
+
+```typescript
+import { defineDevkitConfig } from "@sablier/devkit/vitest";
+
+export default defineDevkitConfig({
+  environment: "jsdom", // or "node" (default), "happy-dom"
+  setupFiles: ["./tests/setup.ts"],
+  coverage: true,
+});
+```
+
+The config provides CI-aware defaults:
+
+- `globals: true`
+- `retry: 2` in CI, `0` locally
+- `testTimeout: 30s` in CI, `10s` locally
+- `reporters: ["basic"]` in CI, `["verbose"]` locally
+
+For merging with existing Vite configs:
+
+```typescript
+import { defineDevkitConfig, mergeConfig } from "@sablier/devkit/vitest";
+import { defineConfig } from "vitest/config";
+
+export default mergeConfig(
+  defineDevkitConfig({ environment: "jsdom" }),
+  defineConfig({
+    test: {
+      alias: { "@": "./src" },
+    },
+  }),
+);
+```
+
+### Just
+
+Import Just recipes in your `justfile`:
+
+```just
+import "@sablier/devkit/just/base.just"
+import "@sablier/devkit/just/npm.just"
+```
+
+Available modules:
+
+| Module          | Description                     |
+| --------------- | ------------------------------- |
+| `base.just`     | Common development recipes      |
+| `npm.just`      | NPM package management          |
+| `evm.just`      | EVM/Foundry tooling             |
+| `tsv.just`      | TypeScript validation           |
+| `settings.just` | Just settings and configuration |
+
+## ⚙️ Available Configs
+
+| Tool            | Config File/Directory                    |
+| --------------- | ---------------------------------------- |
+| 🔍 Biome        | [`biome/`](./biome/)                     |
+| 📝 EditorConfig | [`.editorconfig`](./.editorconfig)       |
+| 🛠 Just         | [`just/`](./just/)                       |
+| ✨ Prettier     | [`.prettierrc.json`](./.prettierrc.json) |
+| 📦 TSConfig     | [`tsconfig/`](./tsconfig/)               |
+| 🧪 Vitest       | [`vitest/`](./vitest/)                   |
 
 ## 🐈‍⬛ GitHub Actions
 
-The [setup](./actions/setup/) GitHub Actions workflow is used to setup the requisite dependencies in a GitHub CI
-workflow.
+The [setup](./actions/setup/) action installs requisite dependencies in GitHub CI workflows.
 
-## 🚀 Setup Script
+```yaml
+- uses: sablier-labs/devkit/actions/setup@main
+```
 
-This is meant to be run by Sablier Labs employees and staff.
+## 🖥️ Setup Script
 
-See [`setup.sh`](./shell/setup.sh) for details.
+For Sablier Labs employees and staff, see [`shell/setup.sh`](./shell/setup.sh).
 
-## 📦 VSCode Settings
+## 🤝 Contributing
 
-See [`vscode/settings.json`](./vscode/settings.json).
+Contributions are welcome! Please feel free to submit a Pull Request.
 
 ## 📄 License
 

package/package.json

@@ -3,7 +3,7 @@
   "description": "Configuration files and reusable scripts for Sablier repositories",
   "license": "MIT",
   "type": "module",
-  "version": "1.5.1",
+  "version": "1.6.1",
   "author": {
     "name": "Sablier Labs Ltd",
     "url": "https://sablier.com"
@@ -13,7 +13,16 @@
   },
   "devDependencies": {
     "@biomejs/biome": "^2.3.7",
-    "prettier": "^3.6.2"
+    "prettier": "^3.6.2",
+    "vitest": "^3.2.0"
+  },
+  "peerDependencies": {
+    "vitest": ">=2.0.0"
+  },
+  "peerDependenciesMeta": {
+    "vitest": {
+      "optional": true
+    }
   },
   "exports": {
     "./biome": "./biome/base.jsonc",
@@ -21,16 +30,18 @@
     "./prettier": "./.prettierrc.json",
     "./tsconfig/base": "./tsconfig/base.json",
     "./tsconfig/build": "./tsconfig/build.json",
-    "./tsconfig/next": "./tsconfig/next.json"
+    "./tsconfig/next": "./tsconfig/next.json",
+    "./vitest": "./vitest/base.js"
   },
   "engines": {
     "node": ">=20"
   },
   "files": [
     "biome/",
-    ".prettierrc.json",
     "just/",
-    "tsconfig/"
+    "tsconfig/",
+    "vitest/",
+    ".prettierrc.json"
   ],
   "keywords": [
     "biome",
@@ -39,7 +50,8 @@
     "prettier",
     "sablier",
     "tsconfig",
-    "typescript"
+    "typescript",
+    "vitest"
   ],
   "publishConfig": {
     "access": "public"

package/tsconfig/base.json

@@ -6,6 +6,7 @@
     "lib": ["ESNext"],
     "module": "NodeNext",
     "moduleResolution": "NodeNext",
+    "noEmit": true,
     "noFallthroughCasesInSwitch": true,
     "noImplicitReturns": true,
     "resolveJsonModule": true,

package/tsconfig/build.json

@@ -7,6 +7,7 @@
     "emitDecoratorMetadata": true,
     "experimentalDecorators": true,
     "forceConsistentCasingInFileNames": true,
+    "noEmit": false,
     "removeComments": true,
     "skipLibCheck": true,
     "stripInternal": true

package/tsconfig/next.json

@@ -4,7 +4,6 @@
   "compilerOptions": {
     "allowJs": true,
     "isolatedModules": true,
-    "noEmit": true,
     "incremental": true,
     "jsx": "preserve",
     "lib": ["dom", "dom.iterable", "ESNext"],

package/vitest/base.js

@@ -0,0 +1,32 @@
+import { defineConfig, mergeConfig } from "vitest/config";
+
+/**
+ * @typedef {Object} DevkitVitestOptions
+ * @property {"node" | "jsdom" | "happy-dom"} [environment]
+ * @property {string[]} [setupFiles]
+ * @property {boolean} [coverage]
+ */
+
+/**
+ * @param {DevkitVitestOptions} [options]
+ */
+export function defineDevkitConfig(options = {}) {
+  const isCI = !!process.env.CI;
+
+  const baseConfig = {
+    test: {
+      coverage: options.coverage ? { provider: "v8" } : undefined,
+      environment: options.environment ?? "node",
+      globals: true,
+      reporters: isCI ? ["basic"] : ["verbose"],
+      retry: isCI ? 2 : 0,
+      setupFiles: options.setupFiles,
+      testTimeout: isCI ? 30_000 : 10_000,
+    },
+  };
+
+  return defineConfig(baseConfig);
+}
+
+// Re-export for merging with existing vite configs
+export { mergeConfig };