🛠️ Sablier Devkit

Configuration files and reusable scripts for Sablier repositories. Designed to be extended and customized as needed.

📦 Installation

npm install @sablier/devkit

Or with other package managers:

pnpm add @sablier/devkit
bun add @sablier/devkit

🚀 Usage

Biome

Extend the base Biome configuration in your biome.jsonc:

{
  "$schema": "https://biomejs.dev/schemas/2.0.6/schema.json",
  "extends": ["@sablier/devkit/biome"],
}

For UI projects, use the UI variant:

{
  "extends": ["@sablier/devkit/biome/ui"],
}

Prettier

Reference the Prettier config in your package.json:

{
  "prettier": "@sablier/devkit/prettier"
}

TypeScript

Extend TSConfig presets in your tsconfig.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:

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:

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:

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/ | | 📝 EditorConfig | .editorconfig | | 🛠 Just | just/ | | ✨ Prettier | .prettierrc.json | | 📦 TSConfig | tsconfig/ | | 🧪 Vitest | vitest/ |

🐈‍⬛ GitHub Actions

The setup action installs requisite dependencies in GitHub CI workflows.

- uses: sablier-labs/devkit/actions/setup@main

🖥️ Setup Script

For Sablier Labs employees and staff, see shell/setup.sh.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is licensed under MIT.