brumate

中文文档
0.5.0发布于 2026/11/03MITTypeScriptES Module构建来源已验证

A component language and compiler for resumable web apps

原始使用文档
文档目录5 节
  1. Install
  2. A component
  3. What it includes
  4. Documentation
  5. License

brumate

A component language and compiler for resumable web apps.

brumate compiles single-file .brm components into server-rendered HTML and small client modules. The browser does not hydrate. It reads the state that the server wrote into the page, and loads the code of the components on the page when it starts.

Install

pnpm add brumate
pnpm add -D vite @brumate/tsc typescript

brumate needs Node 22.18 or newer, and Vite.

// vite.config.ts
import brumate from 'brumate/vite';
import { defineConfig } from 'vite';

export default defineConfig({
  plugins: [brumate()],
  build: {
    manifest: true,
    rolldownOptions: { input: 'src/client.ts' },
  },
});
// src/client.ts
import 'virtual:brumate/start';

A component

<script>
  import { $memo, $signal } from 'brumate/signals';

  let count = $signal(0);
  const double = $memo(count * 2);
</script>

<button onClick=(() => count++)>Clicked {count} times</button>
<p>Double: {double}</p>

The server renders the button and the text. The browser loads the code of the click handler, and of the updates it causes, when the page starts. It does not render the page again.

What it includes

  • brumate/signals: the compile-time functions, such as $signal, $memo, $effect, $props, $action and $optimistic.
  • brumate/vite: the Vite plugin. It compiles .brm files, splits client code per handler, serves server function calls in development, and can prerender pages.
  • brumate/server: rendering, streaming, routes, server functions, sessions, cookies, and validation with Standard Schema.
  • brumate/loader and brumate/client: the loader and the core that run in the browser.
  • brumate/testing: mounting components in a DOM test, with the real server functions.

Documentation

brumate is at 0.x. The page format can change between versions, so the server and the client must come from the same version.

License

MIT © lxsmnsyc

版本与发布记录

brumate 共发布 12 个版本,首次发布于 2026/10/21;过去 12 个月发布了 12 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.5.0latest2026/11/03今天
0.4.42026/11/03今天
0.4.32026/11/021 天前
0.4.22026/11/021 天前
0.4.12026/11/011 天前
0.4.02026/10/313 天前

关于 brumate 的常见问题

brumate 是什么?

用于可恢复web应用程序的组件语言和编译器

如何安装 brumate?

在项目目录运行 npm install brumate,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 brumate,可以用 npx brumate 直接运行。

brumate 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

brumate 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

brumate 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

brumate 可以商用吗?

brumate 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

brumate 还在维护吗?

最新版本 0.5.0 发布于 2026/11/03(今天);至今共发布 12 个版本,其中过去 12 个月发布了 12 个;首次发布于 2026/10/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。