0.1.2 • Published 3 years ago

egg-crc-framework v0.1.2

Weekly downloads
-
License
MIT
Repository
-
Last release
3 years ago

egg-crc-framework

CRC专属Egg开发框架,将通用的contexthelpermiddlewareplugin收集到此框架内。

上手开发

$ znpm i
$ npm test

publish your framework to npm, then change app's framework config:

// {app_root}/package.json
{
  "name": "projectName",
  "egg": {
    "framework": "egg-crc-framework"
  }
}

本地测试

当修改了内容需要到项目中测试,为了避免频繁的发布包,可使用npm link命令,具体参考链接

# 本项目
$ npm link

# 测试项目
$ npm link egg-crc-framework

发布

  1. 在测试没问题之后,需要先跑test检查。
$ npm test
  1. 发布时注意修改版本号(package.json version)。

    版本号遵循语义化版本控制规范,发布到

  2. 发布到内网npm

    znpmzuzuche-npm

# 登录账号,任意填写
$ znpm login

# 发布
$ znpm publish

其他事项

  1. ctx.getRequestSource 来源pluginegg-zzc-detector(同样发布到内网npm)。
  2. 维护index.d.ts,有利于typescript项目能够知道此框架扩展了哪些具体的方法。
  3. 使用npm link来测试框架时遇见项目的egg-core和框架的egg-core冲突。 Symbol.for('egg#eggPath') is required on Application | https://github.com/eggjs/egg/issues/3591
// node_modules/egg-core/lib/loader/egg_loader.js, L262.
if (proto === Object.prototype || proto === EggCore.prototype || proto.constructor.name === 'EggCore') {
    break;
}