# edpx-mobile

**Repository Path**: mirrors_ecomfe/edpx-mobile

## Basic Information

- **Project Name**: edpx-mobile
- **Description**: EDP extension for Mobile project.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-01-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

edpx-mobile
===

[![NPM version](https://img.shields.io/npm/v/edpx-mobile.svg?style=flat-square)](https://npmjs.org/package/edpx-mobile) [![License](https://img.shields.io/npm/l/edpx-mobile.svg?style=flat-square)](./LICENSE) [![EFE Mobile Team](https://img.shields.io/badge/EFE-Mobile_Team-blue.svg?style=flat-square)](http://efe.baidu.com)

EDP extension for Mobile project.

专注于移动开发的 [edp](https://github.com/ecomfe/edp) 扩展，为您提供最佳的 [Fate](http://ecomfe.github.io/fate) 开发体验

## Installation

不用特殊安装，第一次使用 `edpx-mobile` 提供的功能时 `edp` 会自动安装该插件，如果想提前手动安装的话请使用以下方法：

```sh
$ npm install -g edpx-mobile
```

## CLI

### init <theme>

初始化项目，会完成项目目录结构的初始化，导入所有依赖的模块并且生成基础代码。主题参数 `theme` 表明生成哪种类型的项目，有以下取值：

* `spa` 单页应用
* `iso` 同构应用

```sh
# 初始化同构的项目
$ edp mobile init iso
```

### add [type] <path> [file_name_prefix]

添加业务，会为 `path` （是以 `/` 开头的有效 URL 路径）指定的路径添加相应的 Presenter、View、Model、Template 与 Style 文件，比如：

```sh
$edp mobile add /
```

会添加处理 `/` 路径的相关文件，并且以 `path` 为基础来命名文件，比如此时 Presenter 为 `index.js`，Model 为 `indexModel.js`

也可以通过指定 `type` 来单独添加某一类文件，`type` 的有效取值如下：

* `presenter` 添加 Presenter 文件，同时会自动往路由配置信息文件中添加对应的路由信息
* `view` 添加 View 文件
* `model` 添加 Model 文件
* `template` 添加模版文件文件
* `style` 添加样式文件

还也可以使用 `file_name_prefix` 指定生成的文件名前缀，比如：

```sh
$ edp mobile add /detail/:id product/detail
```

以上命令会生成处理 `/detail/:id` 路径的相关文件并且以 `file_name_prefix` 指定的名称作为文件名前缀，比如此时 Presenter 为 `product/detail.js`，Model 为 `product/detailModel.js`

生成文件的具体路径由当前项目的主题决定，如果是 `spa` 单页面应用，则所有生成的文件都在 `src` 目录下，而如果是 `iso` 同构项目则 `lib` 与 `src` 文件夹下都会新增文件，所以在指定 `file_name_prefix` 时不需要写 `src` 或者 `lib` 文件夹名

### start

启动测试服务器，第一次启动测试服务器时会先安装缺失的依赖，所以可能会有些慢，稍安去燥，正好起身喝杯茶～ （这里的“第一次”是对系统而言的哟，所以你可能有且只有一次机会能去喝杯茶 :) ）

```sh
$ edp mobile start
```

自测服务器的相关配置在 `edp-webserver-config.js` 中，详细配置信息[请参考这里](https://github.com/ecomfe/edp/wiki/WebServer)。在自测服务器中我们集成了 `Weinre` 与 `livereload` 功能，方便移动端的调试，并且对于 `iso` 同构的项目默认启动了代码监控与自动重启，在修改了 JavaScript、模版文件或者 JSON 配置信息后都无需手动重启服务～

### build [--config=<configFile>] [--stage=<stage>] [--force]

构建项目

* **--config** 指定构建配置文件
* **--stage** 指定Processors的组合
* **--force** 强制构建。如果输出目录存在时，指定此选项，将强制删除现有的输出目录，并重新创建空目录

构建时会根据项目主题来进行相应的构建操作

#### SPA

单页应用直接使用 [edp-build](https://github.com/ecomfe/edp-build) 进行前端代码的构建，相关的配置在 `edp-build-config.js` 中，具体请参考 [edp build 说明](https://github.com/ecomfe/edp/wiki/Build)

#### ISO

同构项目分成前端构建与后端构建两部分，对于前端构建与 [SPA](#spa) 主题的项目构建一样，直接使用 [edp-build](https://github.com/ecomfe/edp-build) 进行处理。

后端构建主要进行以下操作：

* **文件拷贝** 后端代码不需要编译，只需要进行简单的文件拷贝就可以，默认会将 `app.js`，`lib` 与 `node_modules` 拷贝到输出目录
* **配置文件夹拷贝** 会根据命令中的 `--stage` 参数与构建配置信息中设置的 `config` 来选择正确的配置文件夹将其拷贝到输出目录
* **主文件处理** 将前端编译完成的主页面移动到后端的输出目录中

相关的构建配置信息也在 `edp-build-config.js` 中，默认的配置如下：

```js
exports.rebas = {
    // 指定输出目录
    output: 'output/node',
    // 指定需要直接拷贝到输出目录的文件
    files: ['app.js', 'lib', 'node_modules'],
    // 指定主文件
    index: 'index.html',
    // 指定配置文件夹
    configDir: 'config'
};
```

## More

`edpx-mobile` 目前只提供了 `init`、`add`、 `start` 与 `build` 四条命令，并不能独立的完全覆盖开发的方方面面，剩下的部分我们认为 `edp` 已经完成得很贴心了，所以如果还有其它需求就请直接使用 `edp` 提供的相关功能，如果感觉某些 `edp` 或者 `edpx-mobile` 提供的功能不好用、不符合预期，请[告诉我们](https://github.com/ecomfe/edpx-mobile/issues/new)或者直接给我们提交 PR ～