@sablier/devkit 1.5.0 → 1.6.0

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/just/base.just

@@ -28,9 +28,8 @@ _clean +globs:
     nlx del-cli "{{ globs }}"
 
 # Clear node_modules recursively
-[confirm("Are you sure you want to delete all node_modules, including in subdirectories? Y/n")]
-[no-cd]
-clean-modules +globs="node_modules **/node_modules":
+[confirm("Are you sure you want to delete all node_modules, including in subdirectories? Y/n"), no-cd]
+clean-modules +globs="**/node_modules":
     nlx del-cli {{ globs }}
 
 # Install the Node.js dependencies; run with --frozen to install the dependencies with the frozen lockfile
@@ -49,31 +48,27 @@ alias tb := tsc-build
 # ---------------------------------------------------------------------------- #
 
 # Check code with Biome - runs both the checker and the linter
-[group("checks")]
-[no-cd]
+[group("checks"), no-cd]
 @biome-check +globs=".":
     na biome check {{ globs }}
 alias bc := biome-check
 
 # Lint code with Biome
-[group("checks")]
-[no-cd]
+[group("checks"), no-cd]
 @biome-lint +globs=".":
     na biome lint {{ globs }}
 alias bl := biome-lint
 
 # Fix code with Biome
 # The `noUnusedImports` rule is disabled by default to allow unused imports during development
-[group("checks")]
-[no-cd]
+[group("checks"), no-cd]
 @biome-write +globs=".":
     na biome check --write {{ globs }}
     na biome lint --unsafe --write --only correctness/noUnusedImports {{ globs }}
 alias bw := biome-write
 
 # Run all code checks
-[group("checks")]
-[no-cd]
+[group("checks"), no-cd]
 @full-check:
     just _run-with-status biome-check
     just _run-with-status prettier-check
@@ -83,8 +78,7 @@ alias bw := biome-write
 alias fc := full-check
 
 # Run all code fixes
-[group("checks")]
-[no-cd]
+[group("checks"), no-cd]
 @full-write:
     just _run-with-status biome-write
     just _run-with-status prettier-write
@@ -93,37 +87,41 @@ alias fc := full-check
 alias fw := full-write
 
 # Run knip checks
-[group("checks")]
-[no-cd]
+[group("checks"), no-cd]
 @knip-check:
     na knip
 alias kc := knip-check
 
 # Run knip fix
-[group("checks")]
-[no-cd]
+[group("checks"), no-cd]
 @knip-write:
     na knip --fix
 alias kw := knip-write
 
 # Check Prettier formatting
-[group("checks")]
-[no-cd]
+[group("checks"), no-cd]
 @prettier-check +globs=GLOBS_PRETTIER:
-    na prettier --check --cache --no-error-on-unmatched-pattern {{ globs }}
+    na prettier \
+        --check \
+        --cache \
+        --log-level warn \
+        --no-error-on-unmatched-pattern \
+        {{ globs }}
 alias pc := prettier-check
 
 # Format using Prettier
-[group("checks")]
-[no-cd]
+[group("checks"), no-cd]
 @prettier-write +globs=GLOBS_PRETTIER:
-    na prettier --write --cache --no-error-on-unmatched-pattern {{ globs }}
+    na prettier \
+        --write \
+        --cache \
+        --log-level warn \
+        --no-error-on-unmatched-pattern \
+        {{ globs }}
 alias pw := prettier-write
 
 # Type check with TypeScript (tsgo default, falls back to tsc if unavailable)
-[group("checks")]
-[no-cd]
-[script("bash")]
+[group("checks"), no-cd, script("bash")]
 type-check compiler="tsgo" project="tsconfig.json":
     cmd="{{ compiler }}"
     if [[ "$cmd" == "tsgo" ]] && [[ ! -x "node_modules/.bin/tsgo" ]]; then
@@ -133,6 +131,10 @@ type-check compiler="tsgo" project="tsconfig.json":
 alias tc := type-check
 alias tsc-check := type-check
 
+# ---------------------------------------------------------------------------- #
+#                                   UTILITIES                                  #
+# ---------------------------------------------------------------------------- #
+
 # Private recipe to run a check with formatted output
 [no-cd]
 @_run-with-status recipe *args:
@@ -141,3 +143,4 @@ alias tsc-check := type-check
     just {{ recipe }} {{ args }}
     echo '{{ GREEN }}✓ {{ recipe }} completed{{ NORMAL }}'
 alias rws := _run-with-status
+alias _rws := _run-with-status

package/just/evm.just

@@ -115,8 +115,7 @@ build-optimized *args:
         forge build --extra-output-files metadata {{ args }}
 
 # Dump code coverage to an html file
-[group("foundry")]
-[script]
+[group("foundry"), script("bash")]
 coverage:
     if ! command -v genhtml >/dev/null 2>&1; then
         echo "✗ genhtml CLI not found"

package/just/npm.just

@@ -38,8 +38,7 @@ tag *version:
 
 
 # Check that package.json version includes -beta.x suffix
-[private]
-[script]
+[private, script("bash")]
 @check-beta-version:
   # Extract version from package.json using jq for reliable JSON parsing
   version=$(jq -r '.version' package.json)

package/just/tsv.just

@@ -5,8 +5,7 @@ import "./settings.just"
 # ---------------------------------------------------------------------------- #
 
 # Check TSV files using qsv: https://github.com/dathere/qsv
-[group("checks")]
-[script]
+[group("checks"), script("bash")]
 _tsv-check globs="data/*/*.tsv" schema="" ignore="*.tsv.invalid|*.tsv.valid|*validation-errors.tsv":
     if ! command -v qsv >/dev/null 2>&1; then
         echo "✗ qsv CLI not found"
@@ -43,8 +42,7 @@ _tsv-check globs="data/*/*.tsv" schema="" ignore="*.tsv.invalid|*.tsv.valid|*val
     fi
 
 # Show validation errors for a TSV file
-[group("checks")]
-[script]
+[group("checks"), script("bash")]
 _tsv-show-errors file:
     error_file="{{ file }}.validation-errors.tsv"
 

package/package.json

@@ -3,7 +3,7 @@
   "description": "Configuration files and reusable scripts for Sablier repositories",
   "license": "MIT",
   "type": "module",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "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,21 @@
     "./prettier": "./.prettierrc.json",
     "./tsconfig/base": "./tsconfig/base.json",
     "./tsconfig/build": "./tsconfig/build.json",
-    "./tsconfig/next": "./tsconfig/next.json"
+    "./tsconfig/next": "./tsconfig/next.json",
+    "./vitest": {
+      "import": "./vitest/index.js",
+      "types": "./vitest/index.d.ts"
+    }
   },
   "engines": {
     "node": ">=20"
   },
   "files": [
     "biome/",
-    ".prettierrc.json",
     "just/",
-    "tsconfig/"
+    ".prettierrc.json",
+    "tsconfig/",
+    "vitest/"
   ],
   "keywords": [
     "biome",
@@ -39,7 +53,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/index.ts

@@ -0,0 +1,29 @@
+import type { UserConfig } from "vitest/config";
+import { defineConfig } from "vitest/config";
+
+export interface DevkitVitestOptions {
+  environment?: "node" | "jsdom" | "happy-dom";
+  setupFiles?: string[];
+  coverage?: boolean;
+}
+
+export function defineDevkitConfig(options: DevkitVitestOptions = {}) {
+  const isCI = !!process.env.CI;
+
+  const baseConfig: UserConfig = {
+    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 } from "vitest/config";