自定义物料初始模板

简介

用于自定义物料，支持自定义区块、布局、模板

目前只用来开发自定义区块

使用

安装开发者工具

$ npm install @spaas/spaas-devtools -g

在项目根目录下配置好 ossConfig.js 文件

// 文件内容如下
// 对应的OSS_REGION，OSS_KEY，OSS_SECRET，OSS_BUCKET，OSS_DIR分别为
module.exports = {
  region: OSS_REGION,
  accessKeyId: OSS_KEY,
  accessKeySecret: OSS_SECRET,
  bucket: OSS_BUCKET,
  dir: OSS_DIR,
};

区块预览

$ cd blocks/ExampleBlock
$ npm install
$ npm run start

模板预览

$ cd scaffolds/ExampleScaffold
$ npm install
$ npm run start

添加物料

# 根据提示自定义添加
# 需要到根目录下添加
$ spaas add

添加区块物料

1. 在根目录执行如下命令

spaas add

2. 在 shell 选中“block” 选项

3. 填写好输入的完整信息

根据提示填写好所有信息，就会在项目根目录下  的 block 文件夹中生成对应的区块项目

4. 进入到 block 文件夹下生成的区块项目，进行开发

# 安装相应的依赖
npm install
# 启动项目进行开发
npm run start

5. 开发完毕区块后不用发 npm 包

注意：区块开发不需要 npm 包发布，只需要在项目目录下执行如下命令即可

npm run prepublishOnly

6. 如果执行上一步没报错，即可将代码提交到 git 远程仓库

TODO 后面需要一个人改 build/materilas.json 文件

添加组件物料

1. 在项目根目录下执行如下命令

spaas add

2. 在 shell 选中“component”选项

3. 填写好输入的完整信息

根据提示填写好所有信息，就会在项目根目录下  的 component 文件夹中生成对应的区块项目

4. 进入到 component 文件夹下生成的组件项目，进行开发

# 安装相应的依赖
npm install
# 启动项目进行开发
npm run start

注意：现在的组件脚手架已经去除 elementUI 的依赖，需要自己进行引入。

引入 ElementUI

npm install element-ui --save

新增一个文件：styleguide/element.js

import Vue from 'vue';
import Element from 'element-ui';
import 'element-ui/lib/theme-chalk/index.css';
Vue.use(Element);

修改配置文件：styleguide.config.js

module.exports = {
  // ...
  require: ['./styleguide/element.js'],
};

如需要添加其他依赖，详情请看链接

5. 开发完毕组件后需要发布对应的 npm 包

# 1、需要手动升级package.json文件中的version版本（具体的version版本定义如下：）
# 2、执行发版命令（在事先应该进行npm login，以及npm不能是淘宝源）
npm publish --access=public

注意：布局组件统一命名： ContainerXXX

将新增的包添加到飞冰库进行管理

1. 进入到整个物料库项目的根目录更改 package.json 的版本号

A.B.C 第一位为大版，第二位为小版（例如我们新添加了组件就是小版本），第三位为修复 bug，或者完善小功能

2. 执行如下命令

npm run deploy

3. 如果提示 success 则发版成功

注意：发布成功后，如果需要在飞冰上看到对应的区块/组件，则需要选择对应的分类，点击右上角的刷新列表按钮。

详情

4. 将本地代码提到远程仓库