https://github.com/zekexu/ts-lib

TypeScript Library Base Code For React.
https://github.com/zekexu/ts-lib

library ts-lib typescript

Last synced: 17 days ago
JSON representation

TypeScript Library Base Code For React.

• Host: GitHub
• URL: https://github.com/zekexu/ts-lib
• Owner: ZekeXu
• License: mit
• Created: 2019-05-28T03:19:19.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T08:07:33.000Z (over 3 years ago)
• Last Synced: 2025-01-21T23:45:31.406Z (over 1 year ago)
• Topics: library, ts-lib, typescript
• Language: JavaScript
• Homepage:
• Size: 3.96 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# ts-lib

![GitHub package.json version](https://img.shields.io/github/package-json/v/zekexu/ts-lib.svg)

![GitHub last commit](https://img.shields.io/github/last-commit/zekexu/ts-lib.svg)

[![Coverage Status](https://coveralls.io/repos/github/ZekeXu/ts-lib/badge.svg?branch=master)](https://coveralls.io/github/ZekeXu/ts-lib?branch=master)

[![Build Status](https://travis-ci.org/ZekeXu/ts-lib.svg?branch=master)](https://travis-ci.org/ZekeXu/ts-lib)

[![CircleCI](https://circleci.com/gh/ZekeXu/ts-lib/tree/master.svg?style=svg)](https://circleci.com/gh/ZekeXu/ts-lib/tree/master)

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](folder_demo.png)

### 2.参考链接

[changelog format](https://github.com/conventional-changelog/conventional-changelog-config-spec/blob/master/versions/2.0.0/README.md)

### 3.Commit推荐格式

```bash

(): 

```

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

```bash

yarn remove coveralls

```

packages.json删除下面这行

```json

{

  "scripts": {

    "coverage": "jest --coverage --coverageReporters=text-lcov | coveralls"

  }

}

```

删除文件 **.travis.yml**

删除文件 **.circleci/config.yml**

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

## LICENSE

![GitHub](https://img.shields.io/github/license/zekexu/ts-lib.svg)

Copyright (c) 2019 ZekeXu