🛠️ 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

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/

🐈‍⬛ 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.