@flatfile/gecko

中文文档
0.1.17发布于 2025/06/04近 30 天下载 1.7万

Gecko mascot, a green gecko wearing glasses

中文使用文档
文档目录5 节
  1. 先决条件
  2. 示例:反应 + Vite 前端
  3. 示例: Express REST API
  4. 项目结构
  5. 参考文献

盖克

Gecko mascot, a green gecko wearing glasses

Gecko是TypeScript的JSX代码生成框架.

先决条件

Gecko 以 TypeScript 写成, 需要 tx。 。 。 .

阿宝 计划提供支助.

示例:反应 + Vite 前端

要测试 Gecko, 请从此寄存器的根文件夹中运行以下 :

npm install
cd examples/calculator
npm --prefix project install
npm run gecko
npm --prefix project run dev

Gecko 应当运行和生成文件 ./examples/calculator/project/src/gecko_generated 文件夹.

如果在Gecko或Vite建设期间没有出错,那么计算器示例将会在 http://localhost:5173 上找到,看起来是这样的:

Calculator example

示例: Express REST API

要启动 API,首先运行 Gecko ,然后启动生成的 API:

npm install
cd examples/rest-api
npm install
npm --prefix project install
npm run gecko
npm --prefix project start

如果没有遇到出错,您应该能够访问http://localhost:30/users并查看用户列表:

[
  {
    "id": "1",
    "name": "Test user",
    "email": "[email protected]"
  }
]

项目结构

使用Gecko的项目应具有以下结构:

├── gecko.tsx
├── package.json
├── project
│   ├── (your project files)
│   ├── package.json
└── templates
    └── example.tsx

您的全部项目源代码, 包括其 package.json, (中文(简体) ), tsconfig.json,等等应位于 ./project 子文件夹。 这很重要,因为 gecko.tsx 模板文件必须从项目本身的 TypeScript 配置中分离出。 它会运行在Gecko的内部 tsconfig.json您可以使用任何您喜欢的结构,只要 gecko.tsx 文件不是嵌入到您的工程的源树上, 您可能在那里有另一个 tsconfig.json 文档,这可能造成冲突.

参考文献

Gecko 使用名为 gecko.tsx 以生成文件的工程根。 文件内容可能看起来像:

import {
  File,
  Folder,
  geckoJSX,
  Root,
  Text,
} from '@flatfile/gecko'

import { Button } from './templates/Button'

export default function () {
  return (
    <Root path="project/src/gecko_generated" erase>
      <File name="readme.md">
        <Text>Hello world</Text>
      </File>
      <Folder name="components">
        {[0, 1, 2, 3, 4, 5, 6, 7, 8, 9].map((digit) => (
          <File name={`Digit${digit}.tsx`}>
            <Button label={digit} />
          </File>
        ))}
      </Folder>
    </Root>
  )
}

Gecko支持许多JSX标记来构建生成的代码. 完整名单见 标签引用。 。 。 .

版本与发布记录

@flatfile/gecko 共发布 56 个版本,首次发布于 2024/05/08;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.1.17latest2025/06/041.5 年前
0.1.162025/06/041.5 年前
0.1.152024/10/042 年前
0.1.142024/09/192 年前
0.1.132024/09/192 年前
0.1.122024/09/192 年前

关于 @flatfile/gecko 的常见问题

如何安装 @flatfile/gecko?

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

@flatfile/gecko 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/flatfile__gecko 是否存在。

@flatfile/gecko 可以商用吗?

@flatfile/gecko 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@flatfile/gecko 的下载量有多少?

根据 npm 官方下载统计,@flatfile/gecko 在 2026/10/15 – 2026/11/13 这 30 天内被下载 16,749 次,日均约 558 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@flatfile/gecko 还在维护吗?

最新版本 0.1.17 发布于 2025/06/04(1.5 年前);至今共发布 56 个版本,其中过去 12 个月发布了 0 个;首次发布于 2024/05/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。