homlux-sdk v0.1.4

Intro

基于 father 及 wx 小程序接口搭建

┏━━━━━━━━━━ homlux-sdk ━━━━━━━━━━━━━┓
┃                                   ┃
┃ ┌─── WechatMiniprogram.Wx ──────┐ ┃
┃ │ wx.request │ wx.connectSocket │ ┃
┃ └────────────┴──────────────────┘ ┃
┃         ┌─── cloud ───┐           ┃
┃         │  meizgd.com │           ┃
┃         └─────────────┘           ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

在项目使用

pnpm i homlux-sdk

执行 构建npm 后即可引用：

// ~/package-mine/device-replace/index.ts
import { deviceReplace } from 'homlux-sdk'

const res = await deviceReplace({
    newDevId,
    oldDevId,
}, { loading: true })

console.log('deviceReplace', res.result)

如下动图，支持接口 payload、参数、返回数据的类型自动提示：

开发&调试

$ pnpm i # 安装开发依赖
$ pnpm i yalc -g # 全局安装yalc，本地调试可代替 `npm link`
$ pnpm dev # 运行项目
$ yalc publish # 发布到本地仓库
$ yalc link homlux-sdk # 在要关联的项目下执行
$ yalc remove all # 清除项目关联

关联项目中，忽略文件增加：

# ~/.gitignore

yalc.lock
.yalc

构建&发布

$ yalc push # 手动同步，本地发布到关联项目
$ pnpm build:push # 构建的同时，本地发布到关联项目

$ pnpm build # 构建

$ npm version major # 更新主版本号(major)，做了不兼容的API修改
$ npm version minor # 更新次版本号(minor)，做了向下兼容的功能性新增
$ npm version patch # 修订号(patch)，做了向下兼容的问题修正

$ npm publish # 发布

代码结构

homlux-sdk
 ├── docs // 接口文档
 ├── src // 源代码目录
 │    ├── apis // 接口定义
 │    ├── config // 项目配置
 │    ├── request // 请求方法定义
 │    ├── types // 类型定义
 │    ├── utils // 工具方法定义
 │    └── index.ts // 入口文件
 └── .fatherrc.ts // SDK 框架参数定义

相关文档

umijs/father

yalc