1.0.0 • Published 2 years ago
ryzh-jssdk v1.0.0
项目名
项目简介
特性
如何安装
npm i @supcon/are-utils
如何使用
import { Greeter } from '@supcon/are-utils'
const str = Greeter('Bob')
console.log('str', str)
API
这里列出所有的 API,如果有很多的话,建议这里只写索引,具体的参数信息可以导航到 docs 目录下的文件
executeCustomAction
import { createSubscriber, CONSTANTS } from '@supcon/are-utils'
const subscriberInstance = createSubscriber({
id: '',
groupName: 'are-log-web',
})
subscriberInstance.executeCustomAction({
name: CONSTANTS.customAction.openPage,
payload: {
page: CONSTANTS.tabPages.log,
params: {
sourceTag: 'var://65cb9bd3-b3cf-4d07-9d66-f0e45b10d090/tag1',
},
},
})
如何开发
yarn
yarn start
本项目采用prettier来统一代码风格,并且会在pre-commit
前自动 format 你本次提交的代码,推荐你在你的编辑器里安装 prettier 插件,并且开启保存文件就自动 format 选项,这样可以在开发的时候,就能自动 format
本项目采用git flow 工作流,请按照 git flow 工作流来提交合并代码
如何提交代码并打包发布
推荐使用npm run commit
来代替git commit
作为格式化 commit 信息的工具
# 自动打tag和生成changelog,并修改package.json
git add .
yarn commit
yarn release
npm publish
git push origin HEAD
注意:yarn commit 必须写以下两项(scope name 不能为大写开头):
? What is the scope of this change (e.g. component or file name)? (press enter to skip)
docs
? Write a short, imperative tense description of the change:
修改readme描述
如何删除本地 tag
每次 yarn release 脚本运行成功时,会自动修改 package.json 的 version,并在本地生成 tag,如果提示fatal: tag 'v1.0.1' already exists
或者打错 tag,则需要删除 tag 记录:
# 错误信息
fatal: tag 'v1.0.1' already exists
Command failed: git tag -a v1.0.1 -m "chore(release): 1.0.1"
fatal: tag 'v1.0.1' already exists
git tag -d v1.0.1
Deleted tag 'v1.0.1' (was 7d5c8a7)
如何提交尚未推送到远程的本地标签
git push origin --tags
Enumerating objects: 1, done.
Counting objects: 100% (1/1), done.
Writing objects: 100% (1/1), 168 bytes | 168.00 KiB/s, done.
Total 1 (delta 0), reused 0 (delta 0)
To git.xian.supcon.com:mare/vxsip/are-utils-web.git
* [new tag] v1.1.0 -> v1.1.0
如何删除远程分支
git push origin :refs/tags/v1.1.0
1.0.0
2 years ago