Skip to content

Latest commit

 

History

History
194 lines (140 loc) · 5.79 KB

installation.mdx

File metadata and controls

194 lines (140 loc) · 5.79 KB
title Installation
description Install SayKit and its supporting packages

SayKit is split into a small core runtime and a set of optional packages for configuration, formatters, transformers, and framework integrations. Pick the pieces you need.

What to install

Every SayKit project needs the same set of pieces:

Package Why
saykit The core runtime: catalogues, views, stores and formatting
@saykit/config The config schema (defineConfig) and the saykit CLI
One formatter Reads and writes your translation files (e.g. @saykit/format-po)
One or more transformers Extracts and rewrites macros from your source files
One build-tool plugin Wires the transformer into your bundler
The build-tool plugin and the transformers do different jobs: the **transformer** knows how to parse and rewrite `.ts`/`.tsx` source, the **plugin** knows how to hook your bundler. You usually install both.

Quick install

import { Tab, Tabs } from 'fumadocs-ui/components/tabs';

For a React + Vite project, including TanStack Start (or any other unplugin-compatible bundler):

<Tabs items={['pnpm', 'npm', 'yarn', 'bun']}>

pnpm add saykit @saykit/react
pnpm add -D @saykit/config @saykit/format-po @saykit/transform-js @saykit/transform-jsx unplugin-saykit
npm install saykit @saykit/react
npm install -D @saykit/config @saykit/format-po @saykit/transform-js @saykit/transform-jsx unplugin-saykit
yarn add saykit @saykit/react
yarn add -D @saykit/config @saykit/format-po @saykit/transform-js @saykit/transform-jsx unplugin-saykit
bun add saykit @saykit/react
bun add -D @saykit/config @saykit/format-po @saykit/transform-js @saykit/transform-jsx unplugin-saykit

For a Next.js, React Native, Expo, or other Babel-driven project:

<Tabs items={['pnpm', 'npm', 'yarn', 'bun']}>

pnpm add saykit @saykit/react
pnpm add -D @saykit/config @saykit/format-po @saykit/transform-js @saykit/transform-jsx babel-plugin-saykit
npm install saykit @saykit/react
npm install -D @saykit/config @saykit/format-po @saykit/transform-js @saykit/transform-jsx babel-plugin-saykit
yarn add saykit @saykit/react
yarn add -D @saykit/config @saykit/format-po @saykit/transform-js @saykit/transform-jsx babel-plugin-saykit
bun add saykit @saykit/react
bun add -D @saykit/config @saykit/format-po @saykit/transform-js @saykit/transform-jsx babel-plugin-saykit

For a Carbon Discord bot (with tsdown + Cloudflare Workers):

<Tabs items={['pnpm', 'npm', 'yarn', 'bun']}>

pnpm add saykit @saykit/carbon
pnpm add -D @saykit/config @saykit/format-po @saykit/transform-js unplugin-saykit
npm install saykit @saykit/carbon
npm install -D @saykit/config @saykit/format-po @saykit/transform-js unplugin-saykit
yarn add saykit @saykit/carbon
yarn add -D @saykit/config @saykit/format-po @saykit/transform-js unplugin-saykit
bun add saykit @saykit/carbon
bun add -D @saykit/config @saykit/format-po @saykit/transform-js unplugin-saykit

Package directory

import { Boxes, Cog, Atom, Bot, Hammer, FileType2 } from 'lucide-react';

<Card icon={} title="saykit" href="/reference/api/saykit"> The core runtime: createCatalogue, createStore, the say macros and formatting. Every SayKit app depends on it.

<Card icon={} title="@saykit/config" href="/reference/api/config"> The config schema, the saykit CLI, and shared building blocks used by plugins and custom transformers.

<Card icon={} title="@saykit/react" href="/integrations/react"> React integration. <Say>, SayProvider, useSay, withSay.

<Card icon={} title="@saykit/carbon" href="/integrations/carbon"> Carbon Discord-bot integration. SayPlugin, withSay, locale-aware interaction.say.

<Card icon={} title="unplugin-saykit" href="/integrations/vite"> Universal bundler plugin: Vite, Rollup, Rolldown, Webpack, Rspack, esbuild, Farm, Bun.

<Card icon={} title="babel-plugin-saykit" href="/integrations/babel"> Babel plugin. Use this for Next.js, React Native, Expo, or any Babel-driven pipeline.

<Card icon={} title="@saykit/format-po"> Gettext PO formatter, the default for SayKit examples.

<Card icon={} title="@saykit/transform-js / -jsx"> The macro transformers for .js/.ts and .jsx/.tsx. Used by the build-tool plugins.

Peer dependencies

A few packages have peer requirements worth knowing about:

  • @saykit/react peers react and saykit. The package uses the react-server export condition for server rendering, so React 18+ is required and React 19+ is recommended.
  • @saykit/carbon peers @buape/carbon and saykit.
  • babel-plugin-saykit expects @babel/core (you almost certainly already have it).

Next: quickstart

If this is your first SayKit project, the quickstart walks through the whole loop (config, source, extraction, and runtime) in a few minutes.