@sdkset/types

简介

简单易用，性能出色的前端工具库。使用menorepo组织项目结构，支持模块单独引入。

• 官网：https://true-z.github.io/sdkset-doc/

• github：https://github.com/True-Z/sdkset

• gitee：https://gitee.com/trueAlways/sdkset

安装

强烈建议使用pnpm or yran安装（npm暂不支持workspace语法，）。

pnpm add @sdkset/<pluginName>
or
yran add @sdkset/<pluginName>

使用

类型支持

import type { List } from '@sdkset/types'

ES module

import * as sdk from '@sdkset/all'
or
import * as anyName from '@sdkset/<pluginName>'

CommonJS

const { ... } = require('@sdkset/all')
or
const { ... } = require('@sdkset/<pluginName>')

UMD

<!-- 引入插件，全局对象：sdk<PluginName> -->
<script src="https://cdn.jsdelivr.net/npm/@sdkset/<PlginName>"></script>

<!-- 注意，对于存在对等依赖的 UMD 插件方法，需提前引入对应依赖，示例： -->
<script src="https://cdn.jsdelivr.net/npm/@sdkset/mode"></script>
<script src="https://cdn.jsdelivr.net/npm/@sdkset/core"></script>
<script>
  sdkSocket.useWebSocket().then( ... )
</script>

babel

webpack

1. 安装依赖

pnpm add babel-loader @babel/core @babel/preset-env @babel/plugin-transform-runtime @babel/runtime-corejs3 -D

2. webapck 配置

// webpack.config.js
module.exports = {
  ...
  module: {
    rules: [
      {
        test: /\.(ts|js)x?$/,
        exclude: /node_modules/,
        loader: 'babel-loader'
      }
    ]
  }
}

3. babel 配置

// babel.config.js
module.exports = {
  presets: [
    [
      '@babel/env',
      {
        targets: ['defaults', 'not IE 11']
      }
    ]
  ]
  plugins: [
    [
      '@babel/plugin-transform-runtime',
      {
        corejs: { version: 3, proposals: true }
      }
    ]
  ]
}

vite

1. 安装依赖

pnpm add @vitejs/plugin-legacy terser -D

2. vite 配置

// vite.config.js
import legacy from '@vitejs/plugin-legacy'

export default {
  plugins: [
    legacy({
      targets: ['defaults', 'not IE 11']
    })
  ]
}

相关项目

插件名称	插件简介	ES Module 支持	Common 支持	UMD 支持	全局对象
sdkset/all	sdkset 插件集合	✅	✅
sdkset/types	sdkset 类型声明	✅
sdkset/core	sdkset 工具插件集合	✅	✅	✅	sdkCore
sdkset/mode	mode 设计模式实现	✅	✅	✅	sdkMode
sdkset/utils	sdkset 函数库实现	✅	✅	✅	sdkUtils

主要项目负责人

@True-Z

参与贡献方式

欢迎提交 PR 申请，经过审查后，贡献代码会及时进行合并。

开源协议

MIT @True-Z