@ getforma/ 创建- app
脚手架 新的 福玛 应用程序 —— Rust 服务器 + TypeScript 前端,全线化.
此所坐之处. 一个储存库,八个协调源包:
TS/JSX → @getforma/compiler → FMIR 3 → forma-ir → forma-server → HTML @getforma/build joins the assets @getforma/core adopts islands @getforma/create-app supplies the templates; forma-ir-derive types props你在这里: 前门 新来的? 读取 堆栈结构 - 它解释了管道。 所有8个源包都住进去了 getforma-dev/formata 数据格式 并公布为一套. 现有0.6.x项目可沿用 3.0 模板迁移。 。 。 .
使用量
使用坐标 3.2.0 CLI(英语:CLI). 对于连接的本地路由器应用程序:
npx @getforma/[email protected] my-routed-app --template native-router
对于未公布的源更改,撰稿人使用 包装的候选工作流程。 。 。 .
npx @getforma/[email protected] my-app
cd my-app
然后说:
# Build the frontend
cd admin && npm ci && npm run build && cd ..
# Start the Rust server
cargo run
开通http://localhost:30. 所有模板绑定到 127.0.0.1 默认
仪表板可以选择与 FORMA_HOST并警告你们,
因为它 /api/* 路径没有认证.
选项
npx @getforma/[email protected] my-app --template dashboard
npx @getforma/[email protected] my-app --template minimal
npx @getforma/[email protected] my-app --dry-run
npx @getforma/[email protected] --help
npx @getforma/[email protected] --version
项目名称必须以小写字母开头, 只使用小写
字母、数字、连字符和下划线,最多64个字符。 名称
成为箱子的名字,所以CLI也拒绝 货物拒绝新的
软件包(如: fn, (中文(简体) ), test,构建目录名称,例如
build)和一个Windows设备名称(con, (中文(简体) ), nul);其信息命名规则. 它检查
在写出任何内容之前先写出名称, 并拒绝写入已经存在的路径
已存在.
模板
| 模板 | 渲染 | 说明 |
|---|---|---|
dashboard | 明确的浏览器渲染 | DevOps 管理面板 — 4页, 8 API 路由, SVG 图表, Tailwind CSS, Gruvbox 主题 16 Playwright 测试 |
minimal | 浏览器,或本地 SSR 与 npm run build:ssr | Rust 服务器 + 一个逆变页面和一个关于页面的静态 |
native-router | 具有可选自主导航的本地SSA | 持续布局,打出所有者分支,普通链接和历史 |
native-router (a) 列入3.2.0
出版了3.0/3.1档案。 对于未公布的修改,使用文件包装
候选工作流程和选择 --template native-router 从候选人CLI.
3.2套还加上: @getforma/router 到本模板和仪表板。 仪表板仍然是
明确的浏览器应用程序,保留版式和路由页面所有权.
最小模板保留了它现有的依赖图并渲染行为. 见其
所有权和部署指南 编辑
连接的路由通过。 。 。 .
仪表板明确使用客户端渲染. FMIR 编译器行走源 而不是执行它,只接受有文件记载的本地子集。 这个 以编码诊断拒绝不支持的本地源; 它不会发出 空占位符或默默地将本地路径更改为客户端渲染. 最低模板显示已宣布岛屿状态的本土渲染; 见 允许的子集 财务报告和审定财务报表 模板渲染指南 选择模式时 用于新模板.
你得到的东西
- Rust 服务器 (单位:千美元)
src/main.rs)——轴+forma-server: 有约束的页面渲染PageHandle<Props>(或render_browser_shell每页 aPageResponse携带其按要求提交的CSP非ce和Cache-Control: no-store,从rust-embed没有服务员,和atracing按代码和路由记录每个渲染错误的订阅者 - 类型脚本前端 (单位:千美元)
admin/src/——有JSX,信号,组件的FormaJS - 建设管道 (单位:千美元)
admin/build.ts(b) ——@getforma/build: 捆绑、 内容散列、 Brotli/ gzip, 显示, 以严格模式显示, 所以构造服务器不能用它的代码和行实现构建失败 - A 类
.gitignore包括产出、秘密和(仪表板) 剧作家文物——刻意不忽略Cargo.lock - 锁定文件 (单位:千美元)
admin/package-lock.json财务报告和审定财务报表Cargo.lock持有这个repo的脚手架门所建造和使用的准确版本,所以一个新的工程从一个测试的集合开始,而不是从那天的解决开始
发展
npm test # structural tests — builds the CLI explicitly first
npx tsc --noEmit
候选门需要一个网络和一个Rust工具链. 从仓库 根、 构建和输入源, 然后使用新工艺/ 工作目录 :
npm run build
node scripts/candidate-scaffold.mjs pack /absolute/path/to/candidate-artifacts
# Use the record SHA-256 printed by pack and this checkout's full Git commit.
node scripts/candidate-scaffold.mjs run /absolute/path/to/candidate-artifacts RECORD_SHA256 COMMIT /absolute/path/to/candidate-work /absolute/path/to/report.json
CI总是在Linux和Windows上运行完整的候选套房. 分开 在所有版本合适的协调包时运行实际公布的 CLI 已存在。 缺少或跳过候选人的工作 失败了释放门。 源锁 种子从不直接传递给未公布的注册安装.
脚手架将每个模板装入一个临时目录,从
模板的锁定文件 npm ci,构建前端,运行
cargo check --locked,然后启动每个编译的服务器并读取其
响应: 最小模板必须服务于服务器在服务器后发送的标记
build:ssr,仪表板必须服务于每个页面作为其宣布的浏览器外壳
其 CSP 非ce 匹配脚本标记; 本地路由器必须在所有三个浏览器引擎中通过打入的导航保留其布局, 每页必须回答
Cache-Control: no-store 每次取回时都有一个新的非ce, 没有注册服务
工人,离开 /sw.js 到福玛服务员的退休工人。 也运行
npm audit signatures 覆盖每个模板的安装, 失败于任意
use of deprecated 从模板的 Rust 发出警告,检查是否
构造服务器无法渲染失败 ,
而最小的服务器拒绝从一个被截断的模块开始
对失败的渲染以自己的500来回答,既不包含错误,也不包含
空壳. 在原始的SSR HTML中必须显示一个单独的处理器值为7;
缺少/错误道具和不受约束的路径必须在听众打开前停止.
已打包的本地- 岛屿检查采用服务器值而无需初始写入
并检查静态路线是否要求所有三个引擎没有代码. 这个
仪表盘工具提示检查将API值作为文本保存在强制信任类型下.
目前的"八打包"候选门需要全部24个重控外加结构套间,没有跳过. 历史 3.0/3.1 套装保留了原来的控制.
| 文档 | 这是什么 |
|---|---|
| 捐款额 | 设置,大门,审查员会问什么 |
| 文件/主题 | 模板解剖学,脚手架重写什么,如何添加一个 |
| 文件/更新-菲律宾 | 明确的浏览器和本地 SSR 模式, 以及被允许的编译器子集 |
| 堆栈结构 | 整个管道及其推理. 如果你是新来的就从这里开始. |
| 测试政策 | 此堆栈中每个测试的标准都按 |
福玛堆栈的一部分
前端( TypeScript)
| 软件包 | 说明 |
|---|---|
| @ getforma/ 核心 | 反应 DOM 库 - 信号、 h (), 岛屿、 SSR 水分 |
| @ getforma/ 编译器 | FMIR 生成、编码诊断和建立安全部门改革一体化 |
| @ getforma/ 构建 | 生产管道——捆绑、散货、压缩、明细表 |
| @ getforma/ 路由器 | 可选浏览器/本地导航和持续布局 |
后端( Rust)
| 软件包 | 说明 |
|---|---|
| 福玛尔 | FMIR 二进制格式、结构验证和原生 Rust 行走器 |
| forma 服务器 | Axum 中件: SSR, 资产服务, CSP 头 |
完整框架
| 软件包 | 说明 |
|---|---|
| @ getforma/ 创建- app | 这个包 - 脚手架堆满了 |
许可证
麻省理工学院
原始模板和已出版文物
入帐模板使用已申报道具并敲定了Pages API. 最小的宣布一个"反"岛 在其静态的家园标记和单独的 关于页面的空道具。 本地处理器从 7 开始,同时使用明确的浏览器 模式从 0 开始。 出版的3.0.0集包括岛屿综合收养 和静态路线检查; 后期考生需要自己包装的资质.
明确识别出源模板锁 种子 在协调部门
软件包版本。 他们保留所有外部的登记校验和,只省略
已知的 Forma 候选校验和, 在档案之前无法存在
都装好了 从实际存档字节中释放这些条目,
验证已发运的锁,并恢复所有十个源文件。 唯一来源
template-lock-seeds.json 标记从未被运出。 使用已打包的候选人
用于本地端到端开发的脚手架工作流程;复制源模板
手工不产生可安装的未公布的成套候选人.
脚手架上写着一个单独的应用程序身份 admin/build.ts。 。 。 .
有效工人姓名保持不变;已接受的项目名称有下划线或
64个字符使用可读前缀外加确定性的SHA-256后缀. 这个
保留已接受的 CLI 名称,而不合并不同的缓存名称空间。 这个
服务器启用的工人必须使用此功能 app 值为
sw::configure_for_manifest(worker, &manifest) 绑定前; 模板离开
工人离开。 见 兼容性和迁移。 。 。 .
验证人: tests/scaffold.test.ts, (中文(简体) ), scripts/release-template-lock.test.mjs
在寄存器根,以及精确的艺术P17模板运行.