@astralsight/astroforge-rsbuild-plugin 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 AstroForge contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,46 @@
+# @astralsight/astroforge-rsbuild-plugin
+
+AstroForge 的 [Rsbuild](https://rsbuild.dev/) 插件：在 TSX 源码与厂商 quick-app runtime（小米 Vela / vivo BlueOS 等）之间生成跨进程 IR 契约（`docs/ir-document.schema.json`）。
+
+## 安装
+
+```bash
+pnpm add -D @astralsight/astroforge-rsbuild-plugin @rsbuild/core
+pnpm add @astralsight/astroforge-core
+```
+
+## 使用
+
+```ts
+// rsbuild.config.ts
+import { defineConfig } from "@rsbuild/core";
+import { pluginAstroForge } from "@astralsight/astroforge-rsbuild-plugin";
+
+export default defineConfig({
+  plugins: [pluginAstroForge({ target: "vela" })],
+});
+```
+
+插件会在 `onBeforeBuild` / `onBeforeDevCompile` 阶段：
+
+1. 扫描 `src/pages/**` 发现页面入口；
+2. 解析 TSX，把节点 / 属性 / 事件 / 列表 / 条件 / 生命周期 / `useState` / `useEffect` 等下沉到 IR；
+3. BFS 加载相对路径 import 的子组件；
+4. 收集图片 / 字体等静态资源；
+5. 在 `node_modules/.cache/astroforge/ir-document.json` 写出统一 IR，供下游 `astroforge` Rust CLI 消费。
+
+## 配置
+
+```ts
+pluginAstroForge({
+  target: "vela", // 仅支持 "vela"
+  cacheDir: "node_modules/.cache/astroforge",
+  root: undefined, // 默认取 Rsbuild context.rootPath
+  configFile: "astroforge.config.ts",
+  outFile: undefined, // 显式 IR 输出路径，优先级高于 cacheDir
+});
+```
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,229 @@
+import { PlatformId } from "@astralsight/astroforge-core/platform";
+import { RsbuildPlugin } from "@rsbuild/core";
+
+//#region src/ir.d.ts
+declare const IR_VERSION = 1;
+type JsonValue = null | boolean | number | string | JsonValue[] | {
+  [key: string]: JsonValue;
+};
+interface IrDocument {
+  ir_version: number;
+  manifest: Manifest;
+  app: AppModule;
+  pages: Record<string, Page>;
+  components: Record<string, Component>;
+  assets: AssetRef[];
+}
+interface Manifest {
+  package: string;
+  name: string;
+  version_name: string;
+  version_code: number;
+  min_platform_version: number;
+  icon: string;
+  simulation_version?: string;
+  device_type_list: string[];
+  features: Feature[];
+  config: AppConfig;
+  router: Router;
+  source?: Record<string, JsonValue>;
+}
+interface Feature {
+  name: string;
+}
+interface AppConfig {
+  log_level?: string;
+  design_width?: string;
+}
+interface Router {
+  entry: string;
+  pages: Record<string, RoutePage>;
+}
+interface RoutePage {
+  component: string;
+}
+interface AppModule {
+  lifecycle: Record<string, string>;
+}
+interface Page {
+  route: string;
+  imports: Record<string, string>;
+  template: Node[];
+  script: Script;
+  style: StyleTable;
+}
+interface Component {
+  name: string;
+  template: Node[];
+  script: Script;
+  style: StyleTable;
+}
+interface Script {
+  props: Record<string, Prop>;
+  private_data: Record<string, JsonValue>;
+  methods: Record<string, string>;
+  lifecycle: Record<string, string>;
+}
+interface Prop {
+  type: string;
+  default?: JsonValue;
+}
+interface StyleTable {
+  rules: StyleRule[];
+}
+interface StyleRule {
+  selectors: Selector[];
+  declarations: Record<string, string>;
+}
+interface Selector {
+  kind: SelectorKind;
+  name: string;
+}
+type SelectorKind = "class" | "id" | "tag" | "keyframes" | "font_face";
+interface AssetRef {
+  path: string;
+  source_path: string;
+  digest: string;
+}
+type Node = {
+  kind: "element";
+  value: Element;
+} | {
+  kind: "text";
+  value: string;
+} | {
+  kind: "expression";
+  value: Binding;
+} | {
+  kind: "conditional";
+  value: Conditional;
+} | {
+  kind: "list";
+  value: List;
+} | {
+  kind: "fragment";
+  value: Node[];
+};
+interface Element {
+  tag: string;
+  is_component: boolean;
+  attrs: Record<string, Attr>;
+  events: Record<string, Binding>;
+  children: Node[];
+}
+type Attr = {
+  kind: "static";
+  value: JsonValue;
+} | {
+  kind: "dynamic";
+  value: Binding;
+} | {
+  kind: "style_object";
+  value: StyleSlot[];
+};
+interface StyleSlot {
+  name: string;
+  value: StyleSlotValue;
+}
+type StyleSlotValue = {
+  kind: "static";
+  value: JsonValue;
+} | {
+  kind: "dynamic";
+  value: Binding;
+};
+interface Binding {
+  path: string;
+  is_callable: boolean;
+}
+interface Conditional {
+  branches: ConditionalBranch[];
+}
+interface ConditionalBranch {
+  guard: Binding | null;
+  body: Node[];
+}
+interface List {
+  source: Binding;
+  item_var: string;
+  index_var?: string;
+  key?: Binding;
+  body: Node[];
+}
+declare function createEmptyScript(): Script;
+declare function createEmptyStyleTable(): StyleTable;
+//#endregion
+//#region src/config.d.ts
+interface AstroForgeManifestInput {
+  package: string;
+  name: string;
+  versionName: string;
+  versionCode: number;
+  minPlatformVersion: number;
+  icon: string;
+  simulationVersion?: string;
+  deviceTypeList: string[];
+  features?: Array<{
+    name: string;
+  }>;
+  config?: {
+    logLevel?: string;
+    designWidth?: string;
+  };
+  [extra: string]: JsonValue | undefined;
+}
+interface AstroForgeProjectConfig {
+  manifest: AstroForgeManifestInput;
+  plugin?: AstroForgePluginConfig;
+}
+interface AstroForgePluginConfig {
+  target?: PlatformId;
+  cacheDir?: string;
+}
+declare function readAstroForgeConfig(root: string, configFile?: string): AstroForgeProjectConfig;
+declare function parseAstroForgeConfig(source: string, filename?: string): JsonValue & AstroForgeProjectConfig;
+//#endregion
+//#region src/project.d.ts
+interface CompileProjectOptions {
+  root: string;
+  configFile?: string;
+  cacheDir?: string;
+  outFile?: string;
+  config?: AstroForgeProjectConfig;
+}
+interface CompileProjectResult {
+  document: IrDocument;
+  outFile?: string;
+  pages: PageModule[];
+}
+interface PageModule {
+  route: string;
+  component: string;
+  file: string;
+}
+declare function compileAstroForgeProject(options: CompileProjectOptions): CompileProjectResult;
+declare function discoverPages(root: string): PageModule[];
+declare function createRsbuildEntries(root: string): Record<string, string>;
+declare function defaultIrOutFile(root: string, cacheDir?: string): string;
+//#endregion
+//#region src/tsx.d.ts
+interface ExtractPageOptions {
+  route: string;
+  filename?: string;
+  loadStyle?: StyleImportLoader;
+}
+declare function extractPageFromTsx(source: string, options: ExtractPageOptions): Page;
+type StyleImportLoader = (specifier: string, importer?: string) => string | undefined;
+//#endregion
+//#region src/index.d.ts
+interface AstroForgePluginOptions {
+  target?: PlatformId;
+  cacheDir?: string;
+  root?: string;
+  configFile?: string;
+  manifest?: AstroForgeManifestInput;
+  outFile?: string;
+}
+declare function pluginAstroForge(options?: AstroForgePluginOptions): RsbuildPlugin;
+//#endregion
+export { type AppConfig, type AppModule, type AssetRef, type AstroForgeManifestInput, type AstroForgePluginConfig, AstroForgePluginOptions, type AstroForgeProjectConfig, type Attr, type Binding, type CompileProjectOptions, type CompileProjectResult, type Component, type Conditional, type ConditionalBranch, type Element, type Feature, type IR_VERSION, type IrDocument, type JsonValue, type List, type Manifest, type Node, type Page, type PageModule, type Prop, type RoutePage, type Router, type Script, type Selector, type SelectorKind, type StyleRule, type StyleSlot, type StyleSlotValue, type StyleTable, compileAstroForgeProject, type createEmptyScript, type createEmptyStyleTable, createRsbuildEntries, defaultIrOutFile, discoverPages, extractPageFromTsx, parseAstroForgeConfig, pluginAstroForge, readAstroForgeConfig };