Keel 项目说明

1. 关于如何开发

开发

keel 项目现在进行开发时所有源码都存放于 src 目录下, 使用 common.js 规范定义。

测试

目前 Keel 已经可以十分方便的进行测试测试代码存放于 src/keel/__tests__ 目录下，使 用jest进行测试 示例：

var Model = require('。。/model');
describe('Keel.Model', function () {
  it('will trigger change:attr event on attr change', function () {
    var model = new Model({ name: 'test' });
    model.on('change:name', function (model) {
      expect(model).toEqual(model);
    });
    model.set('name', 'tester');
  });
});

质量检查

集成了@gsmlg/scripts中的lint任务，使用：

npm run lint

格式约定

遵循统一的代码格式约定，在编辑器中安装 editorconfig 插件来之后编辑器在进入项目目录后会自动 入去.editroconfig文件内的格式来进行自动设置 @插件链接

tasks

所有任务都书写在 tasks 目录下，通过npm命令来执行,如

npm run lint // 检查
npm run build  // 构建代码
npm run format // 格式化代码
npm run test // 启用测试服务
npm run validate // lint and test with codecovarage

当前可执行的任务在package.json中的 scripts 里