Merge pull request #89 from InhiblabCore/dev

chore: run type & use-request type optimized

Author: inhiblab

.github/workflows/ci.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: pnpm/action-setup@v2
         with:
           version: 7.9.5

DEV_DOCUMENT.md

@@ -33,4 +33,16 @@ pnpm docs:dev
 
 ```
 
+or
+
+at `root` dir run
+
+```bash
+
+pnpm docs:dev
+
+```
+
+will implement script to finished `scripts/docs.ts`
+
 If the page startup is blank, you need to refresh the page.

package.json

@@ -3,17 +3,18 @@
   "version": "1.0.0",
   "private": true,
 	"scripts": {
-    "docs:dev":"cd packages/hooks &&  npm run initial && npm run docs:dev",
-    "docs:build":"cd packages/hooks &&  npm run initial && npm run docs:build",
-    "docs:build-github":"cd packages/hooks &&  npm run initial && npm run docs:build-github",
-    "docs:build-gitee":"cd packages/hooks &&  npm run initial && npm run docs:build-gitee",
+    "bootstrap": "tsx scripts/bootstrap.ts",
+    "docs:dev":"tsx scripts/docs.ts dev",
+    "docs:build":"tsx scripts/docs.ts build",
+    "docs:build-github":"tsx scripts/gitPage.ts github",
+    "docs:build-gitee":"tsx scripts/gitPage.ts gitee",
     "clean": " rimraf dist lib es",
-		"build": "cd packages/hooks && npm run clean  && vue-tsc --noEmit && vite build",
-		"build:types": "cd packages/hooks && vue-tsc --noEmit && vite build --mode fullTypes",
+		"build": "tsx scripts/build.ts",
     "test": "vitest",
 		"test:ui": "vitest --ui",
     "coverage": "vitest run --coverage",
-		"prepare": "husky install"
+		"prepare": "husky install",
+    "build:types": "cd packages/hooks && vue-tsc --noEmit && vite build --mode fullTypes"
 	},
 	"devDependencies": {
 		"@commitlint/cli": "^17.1.2",
@@ -43,6 +44,7 @@
 		"eslint-config-prettier": "^8.5.0",
 		"eslint-plugin-prettier": "^4.2.1",
 		"eslint-plugin-vue": "^9.6.0",
+    "execa":"^6.1.0",
 		"husky": "^8.0.1",
 		"lint-staged": "^13.0.3",
 		"vue-eslint-parser": "^9.0.3",

packages/hooks/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "vue-hooks-plus",
-	"version": "1.5.2",
+	"version": "1.5.3",
 	"description": "Vue hooks library",
 	"files": [
 		"dist",
@@ -21,7 +21,6 @@
 		"typeScript"
 	],
 	"scripts": {
-    "bootstrap": "tsx scripts/bootstrap.ts",
 		"initial": "initial-scan .docs",
 		"docs:dev": "vhp-vitepress dev .docs --host",
 		"docs:build": "vhp-vitepress build .docs",

packages/hooks/scripts/plugin.ts

@@ -1,5 +1,6 @@
+import { cyan } from 'kolorist'
 import { Logger, Plugin } from 'vite'
-import { cyan, move } from './utils'
+import { move } from './utils'
 
 export function movePlugin({ from, to }: { from: string; to: string }): Plugin {
   let logger: Logger

packages/hooks/scripts/utils.ts

@@ -1,93 +1,12 @@
-import fs, { existsSync, readdirSync, statSync } from 'fs-extra'
-import { resolve } from 'node:path'
-import { bgYellow, bgCyan, bgGreen, bgRed, yellow, cyan, green, red } from 'kolorist'
+import fs from 'fs-extra'
+import { cyan } from 'kolorist'
 import { Logger } from 'vite'
-import { Config } from 'prettier'
 
 const logPrefix = '[vite-plugin-move]'
 
-export const prettierConfig: Config = {
-  printWidth: 100,
-  arrowParens: 'avoid',
-  bracketSpacing: true,
-  endOfLine: 'lf',
-  bracketSameLine: false,
-  quoteProps: 'as-needed',
-  semi: false,
-  singleQuote: true,
-  tabWidth: 2,
-  trailingComma: 'none',
-  useTabs: false,
-  vueIndentScriptAndStyle: false,
-  overrides: [
-    {
-      files: '*.md',
-      options: {
-        embeddedLanguageFormatting: 'off',
-      },
-    },
-  ],
-}
-
 export function move(originalUrl: string, targetUrl: string, log: Logger) {
   fs.move(originalUrl, targetUrl, err => {
     if (err) return log.error(JSON.stringify(err))
     log.info(`\n${cyan(logPrefix)} File successfully moved!!`)
   })
 }
-
-export const rootDir = resolve(__dirname, '..')
-
-export const hooksDir = resolve(rootDir, 'src')
-
-export const hooks = readdirSync(hooksDir).filter(f => {
-  const path = resolve(hooksDir, f)
-  if (!statSync(path).isDirectory()) {
-    return false
-  }
-
-  return existsSync(`${path}/index.ts`)
-})
-
-type LogFn = () => void
-
-export const logger = {
-  ln: () => console.log(),
-  withStartLn: (log: LogFn) => {
-    logger.ln()
-    log()
-  },
-  withEndLn: (log: LogFn) => {
-    log()
-    logger.ln()
-  },
-  withBothLn: (log: LogFn) => {
-    logger.ln()
-    log()
-    logger.ln()
-  },
-  warning: (msg: string) => {
-    console.warn(`${bgYellow(' WARNING ')} ${yellow(msg)}`)
-  },
-  info: (msg: string) => {
-    console.log(`${bgCyan(' INFO ')} ${cyan(msg)}`)
-  },
-  success: (msg: string) => {
-    console.log(`${bgGreen(' SUCCESS ')} ${green(msg)}`)
-  },
-  error: (msg: string) => {
-    console.error(`${bgRed(' ERROR ')} ${red(msg)}`)
-  },
-  warningText: (msg: string) => {
-    console.warn(`${yellow(msg)}`)
-  },
-  infoText: (msg: string) => {
-    console.log(`${cyan(msg)}`)
-  },
-  successText: (msg: string) => {
-    console.log(`${green(msg)}`)
-  },
-  errorText: (msg: string) => {
-    console.error(`${red(msg)}`)
-  },
-}

packages/hooks/src/useRequest/Fetch.ts

@@ -1,7 +1,7 @@
 import { Ref } from 'vue'
 import { FetchState, Options, PluginReturn, Service } from './types'
 
-export default class Fetch<TData, TParams extends any[] = any> {
+export default class Fetch<TData, TParams extends unknown[] = any> {
   pluginImpls: PluginReturn<TData, TParams>[] | undefined
 
   count = 0

packages/hooks/src/useRequest/docs/basic/index.en-US.md

@@ -156,7 +156,7 @@ const {
   loading: Ref<boolean>,
   data?: Ref<TData>,
   error?: Ref<Error>,
-  params: Ref<TParams || []>,
+  params: Ref<TParams | []>,
   run: (...params: TParams) => void,
   runAsync: (...params: TParams) => Promise<TData>,
   refresh: () => void,
@@ -168,7 +168,7 @@ const {
   {
     manual?: boolean,
     defaultParams?: TParams,
-    formatResult?:(response:TData)=>any,
+    formatResult?:(response:TData)=>unknown,
     onBefore?: (params: TParams) => void,
     onSuccess?: (data: TData, params: TParams) => void,
     onError?: (e: Error, params: TParams) => void,
@@ -184,7 +184,7 @@ const {
 | data | Data returned by service | `Ref<TData>` \| `undefined` |
 | error | Exception thrown by service | `Ref<Error>` \| `undefined` |
 | loading | Is the service being executed | `Ref<boolean>` |
-| params | An array of parameters for the service being executed. For example, you triggered `run(1, 2, 3)`, then params is equal to `[1, 2, 3]` | `Ref<TParams>` \| `[]` |
+| params | An array of parameters for the service being executed. For example, you triggered `run(1, 2, 3)`, then params is equal to `[1, 2, 3]` | `Ref<TParams | []>` |
 | formatResult | Format the request results, which recommend to use `useFormatResult` | `(response: TData) => any` |  |
 | run | <ul><li> Manually trigger the execution of the service, and the parameters will be passed to the service</li><li>Automatic handling of exceptions, feedback through `onError`</li></ul> | `(...params: TParams) => void` |
 | runAsync | The usage is the same as `run`, but it returns a Promise, so you need to handle the exception yourself. | `(...params: TParams) => Promise<TData>` |

packages/hooks/src/useRequest/docs/basic/index.zh-CN.md

@@ -153,7 +153,7 @@ const {
   loading: Ref<boolean>,
   data?: Ref<TData>,
   error?: Ref<Error>,
-  params: Ref<TParams || []>,
+  params: Ref<TParams | []>,
   run: (...params: TParams) => void,
   runAsync: (...params: TParams) => Promise<TData>,
   refresh: () => void,
@@ -165,7 +165,7 @@ const {
   {
     manual?: boolean,
     defaultParams?: TParams,
-    formatResult?:(response:TData)=>any,
+    formatResult?:(response:TData)=>unknown,
     onBefore?: (params: TParams) => void,
     onSuccess?: (data: TData, params: TParams) => void,
     onError?: (e: Error, params: TParams) => void,
@@ -181,7 +181,7 @@ const {
 | data | service 返回的数据 | `Ref<TData>` \| `undefined` |
 | error | service 抛出的异常 | `Ref<Error>` \| `undefined` |
 | loading | service 是否正在执行 | `Ref<boolean>` |
-| params | 当次执行的 service 的参数数组。比如你触发了 `run(1, 2, 3)`，则 params 等于 `[1, 2, 3]` | `Ref<TParams>` \| `[]` |
+| params | 当次执行的 service 的参数数组。比如你触发了 `run(1, 2, 3)`，则 params 等于 `[1, 2, 3]` | `Ref<TParams | []>` |
 | formatResult | 格式化请求结果，建议使用 `useFormatResult` | `(response: TData) => any` |  |
 | run | <ul><li> 手动触发 service 执行，参数会传递给 service</li><li>异常自动处理，通过 `onError` 反馈</li></ul> | `(...params: TParams) => void` |
 | runAsync | 与 `run` 用法一致，但返回的是 Promise，需要自行处理异常。 | `(...params: TParams) => Promise<TData>` |

packages/hooks/src/useRequest/plugins/useAutoRunPlugin.ts

@@ -2,7 +2,7 @@ import { isRef, unref, ref, watch } from 'vue'
 import { FetchState, Plugin } from '../types'
 
 // support refreshDeps & ready
-const useAutoRunPlugin: Plugin<any, any[]> = (
+const useAutoRunPlugin: Plugin<unknown, unknown[]> = (
   fetchInstance,
   { manual, ready = true, defaultParams = [], refreshDeps = [], refreshDepsAction },
 ) => {