工程规范

创建工程

使用 coolie create 命令创建工程

# 创建静态项目coolie create --static --dirname static-project# 创建 express 项目coolie create --express express-project# 更多帮助查看coolie create --help

目录规范

第一级

.
├── app.js
├── bs-config.js
├── clis
├── configs.js
├── docs
├── logs
├── node_modules
├── package.json
├── pm2.json
├── readme.md
├── test
├── versions
├── webroot-dev
├── webroot-pro
└── webserver

9 directories, 6 files

• clis：命令行目录，通常包含了项目的启动文件 start.js

• docs：文档目录，通常包含了对外的文档说明

• logs：日志目录，记录工程产生的日志

• test：单元测试目录

• versions：版本记录目录

• webroot-dev：前端根目录（开发环境）

• webroot-pro：前端根目录（生产环境）

• webserver：服务端目录

• app.js：项目起始文件

• bs-config.js：browser-sync 的配置文件

• configs.js：工程启动配置文件

• package.json：工程配置文件

• pm2.json：PM2 配置文件

第二级

versions

• 1.0.md：一个大版本一个文件

• 2.0.md：如上

webroot-dev

webroot-dev
├── coolie.config.js
├── favicon.ico
├── readme.md
├── robots.txt
└── static
    ├── css
    ├── fonts
    ├── img
    └── js

5 directories, 4 files

• .views：视图文件目录，开头打点，不会被直接访问

• static：静态资源目录，包含 JS、CSS、图片、字体等

• coolie.config.js：前端构建配置文件

• favicon.ico：网站图标

• robots.txt：爬虫声明文件

webserver

webserver
├── controllers
├── index.js
├── middlewares
├── models
├── modules
├── services
├── static
├── utils
└── validations

8 directories, 1 file

• controllers：控制器目录

• middlewares：中间件目录

• models：模型目录，如果有数据库的话

• services：服务目录，如路由服务、日志服务、expres 服务等

• static：静态变量目录

• utils：工具函数目录

• validations：数据验证函数目录

• index.js：服务端出口

第三级

static/js

webroot-dev/static/js
├── 3rd
├── app
├── coolie-config.js
├── coolie.js
├── coolie.min.js
├── donkey
├── modules
├── readme.md
├── utils
└── widgets

6 directories, 4 files

• 3rd：第三方脚本

• app：入口模块目录

• coolie-config.js：前端模块加载器配置文件

• coolie.js：前端模块加载器

• donkey：前端脚本库

• modules：项目模块

• utils：项目工具函数

• widgets：项目挂件