lib-flow

0.0.1 • Public • Published

lib-flow(最新版本:0.0.1)

一个支持typescript的类库脚手架;

开发文档

安装

npm i 

开发模式

npm run dev

开发调试:

http://localhost:8089/

http://127.0.0.1:8089/

http://{你的ip}:8089/

编译项目

编译后的代码,会在 根目录的 dist 目录

npm run build

其他依赖

eslint

eslint 官方文档

代码风格,使用eslint来限制; eslint规则在跟目录的:.eslintrc.js文件;

为了开发方便,在开发和编译的过程中,有些配置是不同的,具体可以去配置文件查看;

例如:开发中可以使用console.log,但是编译时,console.log会报错,无法编译成功;

typescript

官方文档其他文档

代码的静态检查使用 typescript ,所以需要你去简单了解一下语法;

pre-commit

增加git commit前的钩子,来做一些限制;

目前只有两个限制:

  1. commit 前会再次验证eslint
  2. commit 前会限制提交信息规范;

commit 的提交类型主要包含以下几种:

  1. feat : 新增功能;
  2. fix: BUG修复;
  3. docs:修改文档;
  4. style:样式修改;
  5. refactor:代码重构,比如重构某个组件;
  6. perf:提升性能的改动
  7. test:单元测试修改;
  8. workflow: 工作流相关修改
  9. chore:构建过程,依赖库,辅助工具等相关;
  10. revert:回滚
  11. delete:删除代码;
  12. merge:合并分支,解决冲突时;

所以,按照这个类型,当你commit的时候,你需要需要提交的内容如下:

feat为例:

git commit -m "feat: 描述信息"
git commit -m "feat(信息): 描述信息"

小括号部分,可有可无,描述信息必须要有;

npm包发布

npm run publish

Readme

Keywords

none

Package Sidebar

Install

npm i lib-flow

Weekly Downloads

2

Version

0.0.1

License

MIT

Unpacked Size

7.78 kB

Total Files

13

Last publish

Collaborators

  • zhangyunling