steamer-example
steamer starterkit 例子
目录规范
steamer -- steamer 配置dist -- 生产环境代码|src -- 源代码|config -- 项目配置,用户主要关注配置,steamer不更新|------projectjs -- 项目配置|------steamerconfigjs -- 可由steamer生成,包括 webserver cdn port route 等| || |tools -- 构建工具,steamer帮助更新| ||——————scriptjs -- 生产环境或开发环境执行命令|——————templatejs -- 模板生成命令|——————webpackbasejs -- webpack 基础配置|packagejson
命令规范
// 开发环境npm start // 生产环境npm run dist // 测试npm test // 规范代码命令npm run lint // 模板生成npm run tpl --tpl xxx模板 -path xxx路径
如何开发一个 steamer 规范的 starterkit
- 新建
.steamer
目录下的配置
你需要新建一个配置文件于 .steamer
目录下。如果你的 starterkit 名称是 steamer-example
,那么配置的文件名必须是 steamer-example.js
。
配置的例子如下:
moduleexports = files: "src" "tools" "config" "README.md" ".eslintrc.js" ".stylelintrc.js" ".gitignore" options: type: 'input' name: 'webserver' message: 'html url(//localhost:9000/)' type: 'input' name: 'cdn' message: 'cdn url(//localhost:8000/)' type: 'input' name: 'port' message: 'development server port(9000)' type: 'input' name: 'route' message: 'development server directory(/news/)' ;
- 在
package.json
中指定一个主要文件,此文件是上面添加的.steamer
目录下的配置,因为 steamer-plugin-kit 的命令运行时候需要读取它。
"main": "./.steamer/steamer-example.js"
开发
// 到 starterkit 开发目录下使用此命令,能使 starterkit 建立了一份全局的软链接cd steamer-examplenpm link // 当你测试完后,请取消这个全局的软链接。npm unlink steamer-example