# @hlang-org/compiler 中文文档

规范地址：https://npmcn.com/package/%40hlang-org/compiler/

版本：2\.0\.1
npm 元数据更新时间：2026-11-01T05:50:25.258Z
中文译文更新时间：2026-11-01T08:56:04.344Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40hlang-org/compiler
原文对照：https://npmcn.com/package/%40hlang-org/compiler/?lang=original
项目主页：https://github.com/hlang-tech/hlang/tree/main/packages/compiler#readme
源码仓库：https://github.com/hlang-tech/hlang

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

- 包体积（解压后）：89.3 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：2 个
- 首次发布：2024-09-05T03:58:18.307Z
- 最新版本发布：2026-11-01T05:50:25.092Z
- 已发布版本数：3（近 12 个月 2 个）

## 中文简介

用于hlang的预先编译器：将IGraph程序编译成独立的ES模块。

## 安装

```sh
npm install @hlang-org/compiler
```

也可以使用：`pnpm add @hlang-org/compiler`、`yarn add @hlang-org/compiler`、`bun add @hlang-org/compiler`

## README

![hlang compiler](https://raw.githubusercontent.com/hlang-tech/hlang/main/media/brand/packages/compiler.png)

# @hlang-org编译器

编译一个hlang程序(`IGraph`)提前转换为独立的ES模块。模块以相同的行为运行图形 [`@hlang-org/interpreter`](https://www.npmjs.com/package/@hlang-org/interpreter)，在运行时没有解释器或图形JSON。

[![npm](https://img.shields.io/npm/v/@hlang-org/compiler?color=c8ccd4&labelColor=0f1114)](https://www.npmjs.com/package/@hlang-org/compiler) [![license](https://img.shields.io/npm/l/@hlang-org/compiler?color=c8ccd4&labelColor=0f1114)](https://github.com/hlang-tech/hlang/blob/main/LICENSE)

## 安装

```sh
npm install -D @hlang-org/compiler
```

相同的构建发布为 `@hlang-tech/compiler`。ESM和CommonJS的构建带有类型声明。

## 使用

```ts
import { writeFile } from 'node:fs/promises';
import { compile } from '@hlang-org/compiler';

const { code, imports } = compile(graph, {
  nodes: {
    numbers: { from: './nodes/numbers.js' },             // default export
    double: { from: '@acme/hlang-nodes', name: 'Double' }, // named export
    log: { from: './nodes/log.js' },
  },
});

await writeFile('program.mjs', code);
// `imports` lists every module the program imports, for example
// ['@hlang-org/runtime', 'rxjs', './nodes/numbers.js', '@acme/hlang-nodes', './nodes/log.js'].
```

运行编译后的程序：

```js
import { run } from './program.mjs';

const handle = run({ env: 'prod', onError: ({ nodeId, error }) => console.error(nodeId, error) });
handle.nodes.numbers; // the constructed node
handle.dispose();     // stop long-running nodes
```

`compile` 是一个纯函数。它不写入任何文件，也不安装任何东西。

## 生成模块

`compile` 用验证图 `planGraph` 从 [`@hlang-org/ir`](https://www.npmjs.com/package/@hlang-org/ir)，构建一个ESTree程序，并使用 [astring](https://github.com/davidbonnet/astring)。值是由打印机作为字面值发出的，因此输出是任何节点id或参数的有效JavaScript。同样的图形总是产生同样的文本。

```js
// Generated by @hlang-org/compiler. Do not edit.
import {Flow} from "@hlang-org/runtime";
import {Subject} from "rxjs";
import Node0 from "./nodes/numbers.js";
// ...
export function run(options = {}) {
  const flowId = options.flowId ?? "flow-" + Date.now().toString(36);
  // ...
  const nodes = {
    numbers: new Node0({ nodeId: "numbers", flowId, env, middleware, config: { params: {} }, signal }),
    // ...
  };
  nodes["numbers"].O("out").connect(nodes["double"].I("in"));
  const flow = new Flow();
  flow.run(nodes["numbers"]);
  return { flowId, nodes, dispose: () => { /* ... */ } };
}
```

`run(options)` 接受 `flowId`， `env` (默认 `'prod'`)， `middleware`, `onError`． 它返回 `{ flowId, nodes, dispose }`.

## API

### `compile(graph, options)`

| 选项 | 描述 |
| --- | --- |
| `nodes` | 必需的。映射每个节点 `code` 来 `{ from, name? }`：模块说明符和导出名称（默认导出时） `name` 省略)。 |
| `runtime` | 导出的模块 `Flow`。默认的 `'@hlang-org/runtime'`. |
| `rxjs` | 导出的模块 `Subject`。默认的 `'rxjs'`. |

返回 `{ code, imports }`.

### 错误

-   `GraphError` (再出口 `@hlang-org/ir`)处理无效图。
-   `CompileError` 与 `code`：
    -   `unresolved-node`：节点 `code` 没有入口 `options.nodes`.
    -   `invalid-import`：导出名称不是有效的标识符。
    -   `unserializable-config`:一个 `bizData` value不是JSON(例如 `undefined`， `NaN`，函数，或 `Date`）. 该消息命名路径。

## 从1.x迁移

版本2是重写的。1.X仍然在npm上，并且 `^1.0.0` 范围不能解析为2.x。

| 1.倍 | 2.倍 |
| --- | --- |
| 默认的出口 `build(graph)` 将一个项目写入临时目录并运行 `npm install`. | `compile(graph, options)` 返回 `{ code, imports }`。自己编写和安装它们。 |
| 节点模块来自每个节点 `runtimeResource`. | 地图每一个 `code` 在 `options.nodes`. |
| 产出取决于 `@hset/xlang-runtime-middleware`lodash和子进程IPC。 | 输出只依赖于运行时、RxJS和节点模块。将服务作为 `middleware`. |
| `complier` 出口。 | 移除。使用 `compile`. |

来源和文件： [github.com/hlang-tech/hlang](https://github.com/hlang-tech/hlang).

## 许可证

麻省理工学院

## 常见问题

### @hlang-org/compiler 是什么？

用于hlang的预先编译器：将IGraph程序编译成独立的ES模块。

### 如何安装 @hlang-org/compiler？

在项目目录运行 npm install @hlang-org/compiler，或使用 pnpm add / yarn add / bun add。

### @hlang-org/compiler 支持 TypeScript 吗？

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

### @hlang-org/compiler 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @hlang-org/compiler 需要什么版本的 Node\.js？

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

### @hlang-org/compiler 可以商用吗？

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

### @hlang-org/compiler 还在维护吗？

最新版本 2\.0\.1 发布于 2026/11/01（2 天前）；至今共发布 3 个版本，其中过去 12 个月发布了 2 个；首次发布于 2024/09/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。