steamer-example

steamer starterkit 例子

目录规范

.steamer -- steamer 配置
dist -- 生产环境代码
|
src -- 源代码
|
config -- 项目配置，用户主要关注配置，steamer不更新
|------project.js -- 项目配置
|------steamer.config.js -- 可由steamer生成，包括 webserver, cdn, port, route 等
|      |
|      |
tools  -- 构建工具，steamer帮助更新
|      |
|——————script.js -- 生产环境或开发环境执行命令
|——————template.js -- 模板生成命令
|——————webpack.base.js -- webpack 基础配置
|
package.json

命令规范

// 开发环境
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。

配置的例子如下：

module.exports = {
    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/)'
        }
    ]
};

1. files

   • 此配置是任何会被拷贝到开发目录下的文件夹或者文件。

2. options

   • 我们使用 inquirer 去读取此配置，了解更多，可以去阅读 inquirer的文档。

• 在 package.json 中指定一个主要文件，此文件是上面添加的 .steamer 目录下的配置，因为 steamer-plugin-kit 的命令运行时候需要读取它。

"main": "./.steamer/steamer-example.js",

开发

// 到 starterkit 开发目录下使用此命令，能使 starterkit 建立了一份全局的软链接
cd steamer-example
npm link
 
// 当你测试完后，请取消这个全局的软链接。
npm unlink steamer-example