oceanifier/Readme.md

# Oceanifier - 基于 oceanify 的命令行工具

使用 Oceanifier，前端工程师可以快速开发独立的前端模块。


## Usage - 用法


### Component Development - 单个模块开发

可以参考 central 中使用 oceanifier 开发的一些前端模块：

1. [yen][yen]

Oceanifier 在启动的时候，会检查当前目录下是否有 package.json 文件，如果有，就会认为当前模块（也就是 package.name）为本地模块，在接到当前模块的请求时，会进入源码模式，将当前目录作为这个模块的源码目录。

比如，假设我在 [yen][yen] 项目目录中，那么所有到 `yen` 路径的访问，都会用当前目录中的文件作为内容返回：

| 请求路径 | 实际文件 |
|---------|---------|
| /yen/index.js | /index.js |
| /yen/test/test.yen.js | /test/test.yen.js |

这个模式在开发独立模块时非常方便，仍然以 yen 为例。

```bash
➜  yen git:(master) tree . -I node_modules
.
├── History.md
├── Readme.md
├── easing.js
├── events.js
├── index.js
├── package.json
└── test
    ├── runner.html
    ├── test.events.js
    └── test.yen.js

6 directories, 6 files
```

我们可以到 yen 的根目录运行 oceanify 服务：

```bash
➜  yen git:(master) oceanify serve      # --port 5000
```

然后访问 <http://localhost:5000/test/runner.html> 即可执行 yen 的单元测试了。参考 yen/package.json 文件，我们还可以在 `scripts` 字段里写上：

```js
"scripts": {
  "start": "oceanify serve",
  "test": "totoro --runner=http://`oceanify ip`:5000/test/runner.html"
}
```

然后就可以用 `npm start` 运行服务，用 `npm test` 执行多浏览器测试了。


### Web Development - 日常前端开发

// TODO


## Diff - 与 oceanify 的区别


### Oceanify

在使用 Node 开发的 Web 应用中，如果你采用的框架是 connect、express、或者 koa，那么你可以直接使用 [oceanify][oceanify] 提供的中间件：

```js
// connect/express
var oceanify = require('oceanify')
app.use(oceanify())

// koa
var oceanify = require('oceanify/g')
app.use(oceanify({ base: './components' }))
```

详见 [oceanify][oceanify] 的说明文档。


### Oceanifier

如前文所述，oceanify 只是一个中间件。如果你并非后端开发，只是想用 oceanify 的方式开发前端代码；如果你只是想以 CommonJS 形式开发一个可以通过 NPM 发布的前端或者前后端共享的模块，那用 Oceanifier 就对了。


[oceanify]: https://github.com/erzu/oceanify
[yen]: https://github.com/erzu/yen