# 🐸 @omni-door/tpl-toolkit
The JS-SDK project template for @omni-door

[![NPM downloads](http://img.shields.io/npm/dm/%40omni-door%2Ftpl-toolkit.svg?style=flat-square)](https://www.npmjs.com/package/@omni-door/tpl-toolkit)
[![npm version](https://badge.fury.io/js/%40omni-door%2Ftpl-toolkit.svg)](https://badge.fury.io/js/%40omni-door%2Ftpl-toolkit)
[![install size](https://packagephobia.now.sh/badge?p=%40omni-door%2Ftpl-toolkit)](https://packagephobia.now.sh/result?p=%40omni-door%2Ftpl-toolkit)
[![license](http://img.shields.io/npm/l/%40omni-door%2Ftpl-toolkit.svg)](https://github.com/omni-door/tpls/blob/master/packages/tpl-toolkit/LICENSE)

## Install
* Clone the repo: `git@github.com:omni-door/tpls.git`

* Install with [Npm](https://www.npmjs.com/package/@omni-door/tpl-toolkit): `npm install @omni-door/tpl-toolkit`

* Install with [Yarn](https://yarnpkg.com/en/package/@omni-door/tpl-toolkit): `yarn add @omni-door/tpl-toolkit`

## Templates
| folder | file |
| --- | --- |
| babel | babel.config.js |
| commitlint | commitlint.config.js |
| editor | .editorconfig |
| eslint | .eslintrc.js |
| ignore | .eslintignore & .gitignore & .npmignore & .prettierignore |
| karma | karma.conf.js |
| mocha | mocha.opts |
| new | the standard templates for `omni new` command |
| omni | omni.config.js |
| package | package.json |
| prettier | prettier.config.js |
| readme | README.md & README.zh-CN.md & DEV.md & DEV.zh-CN.md |
| source | the standard templates in `src` folder |
| tsconfig | tsconfig.json |
| umi | .umirc.js & .env |
| vsc | .vscode/settings.json |