@allkit/shared 0.0.2 → 0.0.3

package/dist/skills/references/storage.md

@@ -0,0 +1,113 @@
+# storage
+
+本地存储工具函数，自动处理 JSON 序列化，支持 TypeScript 类型推断
+
+## Functions
+
+### setLocal
+
+设置 LocalStorage
+
+```ts
+function setLocal<T>(key: string, content: T): void
+```
+
+### getLocal
+
+获取 LocalStorage
+
+```ts
+function getLocal<T>(key: string): T
+```
+
+### removeLocal
+
+删除 LocalStorage
+
+```ts
+function removeLocal(key: string): void
+```
+
+### clearLocal
+
+清空 LocalStorage
+
+```ts
+function clearLocal(): void
+```
+
+### setSession
+
+设置 SessionStorage
+
+```ts
+function setSession<T>(key: string, content: T): void
+```
+
+### getSession
+
+获取 SessionStorage
+
+```ts
+function getSession<T>(key: string): T
+```
+
+### removeSession
+
+删除 SessionStorage
+
+```ts
+function removeSession(key: string): void
+```
+
+### clearSession
+
+清空 SessionStorage
+
+```ts
+function clearSession(): void
+```
+
+### setStore
+
+设置本地存储
+
+```ts
+function setStore<T>(key: string, value: T, type?: 'local' | 'session'): void
+```
+
+### getStore
+
+获取本地存储
+
+```ts
+function getStore<T>(key: string, type?: 'local' | 'session'): T
+```
+
+### removeStore
+
+删除本地存储
+
+```ts
+function removeStore(key: string, type?: 'local' | 'session'): void
+```
+
+## Example
+
+```ts
+import { setLocal, getLocal, setSession, getSession } from '@allkit/shared'
+
+// LocalStorage
+setLocal('token', '123')
+const token = getLocal<string>('token') // '123'
+removeLocal('token')
+
+// SessionStorage
+setSession('userInfo', { name: '张三', age: 18 })
+const userInfo = getSession<{ name: string; age: number }>('userInfo')
+removeSession('userInfo')
+
+// 通用方法
+setStore('token', '123', 'local')
+const token2 = getStore<string>('token', 'local')
+```

package/dist/skills/references/string.md

@@ -0,0 +1,126 @@
+# string
+
+字符串操作工具函数
+
+## Functions
+
+### camelize
+
+中划线转小驼峰
+
+```ts
+function camelize(str: string): string
+```
+
+**Example**
+
+```ts
+camelize('user-info')  // 'userInfo'
+camelize('hello-world-test') // 'helloWorldTest'
+```
+
+### kebabCase
+
+驼峰转中划线
+
+```ts
+function kebabCase(str: string): string
+```
+
+**Example**
+
+```ts
+kebabCase('userInfo')  // 'user-info'
+kebabCase('helloWorldTest') // 'hello-world-test'
+```
+
+### snakeCase
+
+驼峰转下划线
+
+```ts
+function snakeCase(str: string): string
+```
+
+**Example**
+
+```ts
+snakeCase('userInfo')  // 'user_info'
+snakeCase('helloWorldTest') // 'hello_world_test'
+```
+
+### lowerFirst
+
+首字母转小写
+
+```ts
+function lowerFirst(str: string): string
+```
+
+**Example**
+
+```ts
+lowerFirst('UserInfo')  // 'userInfo'
+lowerFirst('Hello') // 'hello'
+```
+
+### upperFirst
+
+首字母转大写
+
+```ts
+function upperFirst(str: string): string
+```
+
+**Example**
+
+```ts
+upperFirst('userInfo')  // 'UserInfo'
+upperFirst('hello') // 'Hello'
+```
+
+### trim
+
+去除字符串首尾空白
+
+```ts
+function trim(str: string, chars?: string): string
+```
+
+**Example**
+
+```ts
+trim('  hello  ') // 'hello'
+trim('--hello--', '-') // 'hello'
+```
+
+### repeat
+
+重复字符串
+
+```ts
+function repeat(str: string, count: number): string
+```
+
+**Example**
+
+```ts
+repeat('a', 3) // 'aaa'
+repeat('ab', 2) // 'abab'
+```
+
+### padStart / padEnd
+
+字符串补全
+
+```ts
+function padStart(str: string, length: number, chars?: string): string
+function padEnd(str: string, length: number, chars?: string): string
+```
+
+**Example**
+
+```ts
+padStart('5', 2, '0') // '05'
+padEnd('hi', 4, '!') // 'hi!!'
+```

package/dist/skills/references/timer.md

@@ -0,0 +1,78 @@
+# timer
+
+定时器工具函数
+
+## Functions
+
+### sleep
+
+睡眠函数
+
+```ts
+function sleep(timer: number): Promise<void>
+```
+
+**Example**
+
+```ts
+await sleep(1000) // 等待 1 秒
+```
+
+### raf
+
+监听下一动画帧（Promise）
+
+```ts
+function raf(): Promise<void>
+```
+
+**Example**
+
+```ts
+raf().then(() => {
+  console.log('执行下一帧')
+})
+```
+
+### doubleRaf
+
+监听双帧动画帧（Promise）
+
+```ts
+function doubleRaf(): Promise<void>
+```
+
+**Example**
+
+```ts
+doubleRaf().then(() => {
+  console.log('执行双帧后')
+})
+```
+
+### clearTimer
+
+清除定时器
+
+```ts
+function clearTimer(timerId: number | undefined): void
+```
+
+## Usage
+
+```ts
+import { sleep, raf, doubleRaf } from '@allkit/shared'
+
+// 睡眠
+await sleep(100)
+
+// 下一帧
+raf().then(() => {
+  console.log('执行下一帧')
+})
+
+// 双帧
+doubleRaf().then(() => {
+  console.log('执行双帧后')
+})
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allkit/shared",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "this is a shared package",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/scripts/build.mjs

@@ -7,7 +7,7 @@ import fse from 'fs-extra'
 import { build } from 'vite'
 import { viteLibConfig } from '@allkit/vite-config'
 
-const { outputFile } = fse
+const { outputFile, copy } = fse
 
 const require = createRequire(import.meta.url)
 
@@ -79,14 +79,17 @@ const buildAll = async () => {
 // copy文件
 // README.md
 // 样式 index.css
-const copyFiles = () => {
+// skills 目录
+const copyFiles = async () => {
   const markdown = createReadStream(resolve(__dirname, '../README.md'))
   markdown.pipe(createWriteStream(resolve(__dirname, '../dist/README.md')))
+
+  await copy(resolve(__dirname, '../skills'), resolve(__dirname, '../dist/skills'))
 }
 
 const buildLib = async () => {
   await buildAll()
-  copyFiles()
+  await copyFiles()
 }
 
 buildLib()