ZekeXu / ts-lib

TypeScript Library Base Code For React.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ts-lib

GitHub package.json version GitHub last commit Coverage Status Build Status CircleCI

TypeScript library initial code.

一、功能

  • TypeScript
  • Prettier + TSLint
  • Git Hooks
  • Unit Test(Jest) && Coverage
  • commitlint
  • editorconfig
  • stylelint
  • changelog
  • commit提示 使用yarn cm 代替 git commit
  • Travis CI
  • Circle CI

二、需要修改的文件

  • package.json

三、参考

1.推荐目录结构

Folder

2.参考链接

changelog format

3.Commit推荐格式

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

4.私有项目可去掉 Travis CI、Circle CI 和 Coveralls

yarn remove coveralls

packages.json删除下面这行

{
  "scripts": {
    "coverage": "jest --coverage --coverageReporters=text-lcov | coveralls"
  }
}

删除文件 .travis.yml

删除文件 .circleci/config.yml

5. 使用 yarn audit检测有漏洞的deps

LICENSE

GitHub Copyright (c) 2019 ZekeXu

About

TypeScript Library Base Code For React.

License:MIT License


Languages

Language:JavaScript 95.2%Language:TypeScript 4.5%Language:CSS 0.3%