@durka/example-template

basic template for create durka template only

Usage no npm install needed!

<script type="module">
  import durkaExampleTemplate from 'https://cdn.skypack.dev/@durka/example-template';
</script>

README

{{projectName}}

{{projectDescription}}

Installation

确保有全局安装 @durka/cli

npm install -g @durka/cli

再运行下面命令创建新项目

durka init --templateName {{projectName}}

Usage

基本配置

创建一个模板，需要先确定好要使用的框架(vue/react/node)，要使用的 脚本语言(js/ts)，及如果是 web 项目的话，是单页还是多页应用。确定 好后，在 durka.json 文件中的 framework、language及type 中配置好对应的值，这样可以保证 durka 在编译的时候加载合适的配置信息。

版本管理

package.json 中的 version 字段需要根据使用的 durka 版本号来配置， 建议 major/minor 和 durka 的 major/minor 保持一到处，如 durka 版本为 1.2.3，则此项目的版本可以设置成 1.2.4 或 1.2.0，但不要设置成 2.2.3 或 1.3.3 。

另外模板中的 package.json 文件中的 engines 字段中需要指定 durka 的版本号， 避免项目无法使用合适的 durka 版本，导致无法运行起来。

自动注入 durka-scripts 里的模块到项目中

为了避免频繁安装 npm 模块，durka.json 中可以配置 injects 字段，指定要注入的 的 npm 模块，模块只能是 durka-scripts 中存在的，不存在的无法注入，另外可以指定 安装位置，或者是使用 link 方式，还是 copy 方式注入。

建议同时将 package.json 中的 scripts.postinstall 配置成 durka inject -f， 可以在每次安装完项目后自动注入指定的模块。

发布模板

模板开发完成使用 durka pack 来打包项目到 res/pack 文件夹中，此命令 会根据 durka.json 中的 templateFiles 字段来打包文件；

如果要发布项目，使用 durka pack --publish，会将项目发布到 npm 上

Support

  • 咨询：{{userName}} <{{userEmail}}>

Changelog

[Changelog][./CHANGELOG.md]

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT