open-index/open-npm huggingface dataset:
npm package: @flatfishjs/api
Description: Flatfish common API
Author: yuche
Latest version: 0.0.12

# `@flatfishjs/api`

暴露给 @flatfishjs/flatfish 的所有端的公有 API。`@flatfishjs/api` 会跨 node/浏览器/小程序/React Native 使用，不得使用/包含平台特有特性。
npm package: @flatfishjs/components
Description: Flatfish 组件库。
Latest version: 0.0.12

# @flatfishjs/components

Flatfish 组件库。

在小程序端，React/Nerv 指向 `mini/index.js`，Vue 无需使用此包。

在 H5 端，React/Nerv 指向 `h5/react/index.js`，Vue 指向 `h5/vue/index.js`。H5 端使用 [stencil](https://stenciljs.com/) 把组件编译为 Web Components 以提供跨框架调用。
npm package: @flatfishjs/flatfish-h5
Description: 暴露给 `@flatfishjs/flatfish` 的 H5 端 API。
Latest version: 0.0.12

# @flatfishjs/flatfish-h5

暴露给 `@flatfishjs/flatfish` 的 H5 端 API。

需要配合 `babel-plugin-transform-flatfishapi` 才能使用 ES6 default import 的语法，相关配置详情在 `babel-preset-flatfish` 中。
npm package: @flatfishjs/flatfish-loader
Description: > TODO: description
Latest version: 0.0.12

# `@flatfishjs/flatfish-loader`

暴露给 `@flatfishjs/mini-runner` 和 `@flatfishjs/webpack-runner` 使用的 Webpack loader，包含以下 `loader`:

## app

小程序专用。在小程序入口文件调用 `@flatfishjs/runtime` 的 `createReactApp`/`createVueApp` 方法创建一个小程序 `App` 构造函数接受的对象。

### options: 
* `framework`: 框架类型，`'react' | 'nerv' | 'vue' | 'vue3'`
* `prerender`: [预渲染配置](https://flatfish-docs.jd.com/flatfish/next/docs/prerender.html)

## page

小程序专用。在小程序页面文件调用 `@flatfishjs/runtime` 的 `createPageConfig` 方法创建一个小程序 `Page` 构造函数接受的对象。
### options: 
* `framework`: 框架类型，`'react' | 'nerv' | 'vue' | 'vue3'`
* `name`: 页面路径

## page

小程序专用。在小程序页面文件调用 `@flatfishjs/runtime` 的 `createComponentConfig` 方法创建一个小程序 `Component` 构造函数接受的对象。

### options: 
* `framework`: 框架类型，`'react' | 'nerv' | 'vue' | 'vue3'`
* `name`: 页面路径

## h5

H5 专用。在小程序入口文件调用 `@flatfishjs/router` 的 `createRouter` 方法创建兼容小程序生命周期和路由系统的应用。

### options: 
* `framework`: 框架类型，`'react' | 'nerv' | 'vue' | 'vue3'`
* `config`: 应用配置，对应 app.config.js
* `pages：页面配置，对应` page.config.js
* `filename`: 文件名
npm package: @flatfishjs/mini-runner
Description: Mini app runner for flatfish
Latest version: 0.0.12

# `@flatfishjs/mini-runner`

暴露给 `@flatfishjs/cli` 的小程序 Webpack 启动器。

`@flatfishjs/mini-runner` 从 `@flatfishjs/cli` 接受 [Flatfish 编译配置](https://flatfish-docs.jd.com/flatfish/docs/config.html)，把编译配置分解成 Webpack 配置，并刚启动 Webpack 把项目源码编译为适配小程序目录结构的代码。
npm package: @flatfishjs/react
Description: like react-dom, but for mini apps.
Author: yuche
Latest version: 0.0.12

# @flatfishjs/react

基于 `react-reconciler` 的小程序专用 React 渲染器，连接 `@flatfishjs/runtime 的 DOM 实例，相当于小程序版的 `react-dom`，暴露的 API 也和 `react-dom` 保持一致。
npm package: @flatfishjs/reactize
Description: 低代码为 react 代码
Latest version: 0.0.12

# `@flatfishjs/reactize`

暴露给 `@flatfishjs/cli/convert` 的低代码转 react 转换器。

## 核心 API

### parse(options)

解析小程序源文件为 React/Vue 组件、

#### options

```typescript
interface Option {
  json?: string, // 小程序配置文件
  script?: string, // 小程序的 JavaScript 文件
  wxml?: string, // wxml 文件
  path: string, // 当前页面路径
  rootPath: string // 根目录路径
}
```