# @flatfile/gecko 中文文档

规范地址：https://npmcn.com/package/%40flatfile/gecko/

版本：0\.1\.17
npm 元数据更新时间：2026-04-23T23:54:20.077Z
中文译文更新时间：2026-11-14T21:52:08.985Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40flatfile/gecko
原文对照：https://npmcn.com/package/%40flatfile/gecko/?lang=original
项目主页：https://github.com/FlatFilers/gecko#readme
源码仓库：https://github.com/FlatFilers/gecko

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

- 包体积（解压后）：600 kB，155 个文件
- TypeScript 类型：未声明
- 运行依赖：8 个
- 首次发布：2024-05-08T03:57:20.462Z
- 最新版本发布：2025-06-03T20:03:03.526Z
- 近 30 天下载量：16749（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：56（近 12 个月 0 个）

## 中文简介

![Gecko mascot, a green gecko wearing glasses](https://npmcn.com/package/%40flatfile/gecko/resources/gecko.jpeg)

## 安装

```sh
npm install @flatfile/gecko
```

也可以使用：`pnpm add @flatfile/gecko`、`yarn add @flatfile/gecko`、`bun add @flatfile/gecko`

## README

# 盖克

![Gecko mascot, a green gecko wearing glasses](https://npmcn.com/package/%40flatfile/gecko/resources/gecko.jpeg)

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

## 先决条件

Gecko 以 TypeScript 写成, 需要 [tx](https://www.npmjs.com/package/tsx)。 。 。 .

[阿宝](https://bun.sh/) 计划提供支助.

## 示例:反应 + 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](https://npmcn.com/package/%40flatfile/gecko/resources/calculator.png)

## 示例: 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": "test@example.com"
  }
]
```

## 项目结构

使用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` 以生成文件的工程根。 文件内容可能看起来像:

```jsx
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标记来构建生成的代码. 完整名单见 [标签引用](https://npmcn.com/package/%40flatfile/gecko/TAGS.md)。 。 。 .

## 常见问题

### 如何安装 @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 和提交记录判断。