# brumate 中文文档

规范地址：https://npmcn.com/package/brumate/

版本：0\.5\.0
npm 元数据更新时间：2026-11-03T04:02:57.618Z
中文译文更新时间：2026-11-03T06:25:37.957Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/brumate
原文对照：https://npmcn.com/package/brumate/?lang=original
项目主页：https://github.com/lxsmnsyc/brumate
源码仓库：https://github.com/lxsmnsyc/brumate

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：4.5 MB，129 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：9 个
- peer 依赖：less \>=4，sass \>=1\.70，vite ^8\.0\.0
- 首次发布：2026-10-21T05:11:39.844Z
- 最新版本发布：2026-11-03T04:02:57.322Z
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

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

## 安装

```sh
npm install brumate
```

也可以使用：`pnpm add brumate`、`yarn add brumate`、`bun add brumate`

## README

# brumate

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

`brumate` 编译排成一列纵队 `.brm` 组件分为服务器端呈现的HTML和小型客户端模块。浏览器不补水。它读取服务器写入页面的状态，并在启动时加载页面上组件的代码。

## 安装

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

brumate需要Node 22.18或更新版本，以及Vite。

```ts
// 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' },
  },
});
```

```ts
// src/client.ts
import 'virtual:brumate/start';
```

## 一个组件

```html
<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>
```

服务器呈现按钮和文本。当页面启动时，浏览器加载单击处理程序的代码，以及它引起的更新的代码。它不会再次呈现该页。

## 它包括什么

-   `brumate/signals`：编译时函数，如 `$signal`， `$memo`， `$effect`， `$props`， `$action` 和 `$optimistic`.
-   `brumate/vite`： Vite插件。它编译 `.brm` 文件，每个处理程序拆分客户端代码，在开发中提供服务器函数调用，并且可以预呈现页面。
-   `brumate/server`：渲染、流、路由、服务器功能、会话、cookie和标准模式验证。
-   `brumate/loader` 和 `brumate/client`：在浏览器中运行的加载器和内核。
-   `brumate/testing`：在DOM中挂载组件进行测试，具有真实服务器的功能。

## 文档

-   [开始](https://github.com/lxsmnsyc/brumate/blob/main/website/docs/getting-started.md)
-   [你的第一个应用](https://github.com/lxsmnsyc/brumate/blob/main/website/docs/tutorial.md)
-   [所有指南及参考资料](https://github.com/lxsmnsyc/brumate/tree/main/website/docs)

Brumate是0。页面格式可以在不同版本之间改变，因此服务器和客户端必须来自相同的版本。

## 许可证

麻省理工学院© [lxsmnsyc](https://github.com/lxsmnsyc)

## 常见问题

### 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 和提交记录判断。