Chore: add comment to generated SWR or ReactQuery hooks

tsdk-monorepo · Dec 15, 2023 · 19a2dec · 19a2dec
1 parent 19fddbb
commit 19a2dec
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 5 deletions.
diff --git a/CHANGELOG.mdx b/CHANGELOG.mdx
@@ -2,6 +2,11 @@
 
 This is the log of notable changes to the `tsdk` that are developer-facing.
 
+
+### 0.0.30 2023/12/15
+
+- Chore: add comment to generated `SWR` or `ReactQuery` hooks
+
 ### 0.0.29 2023/12/11
 
 - Feat: respect `isGet` is `true` or `false` value

diff --git a/packages/bench/package.json b/packages/bench/package.json
@@ -15,7 +15,7 @@
     "checktype": "tsc --noEmit"
   },
   "dependencies": {
-    "tsdk-server-adapters": "^0.0.29",
+    "tsdk-server-adapters": "^0.0.30",
     "change-case": "^4.1.2",
     "express": "^4.18.2",
     "zod": "^3.22.4",

diff --git a/packages/tsdk-server-adapters/package.json b/packages/tsdk-server-adapters/package.json
@@ -1,6 +1,6 @@
 {
   "name": "tsdk-server-adapters",
-  "version": "0.0.29",
+  "version": "0.0.30",
   "main": "lib/index.js",
   "repository": "tsdk-monorepo/tsdk",
   "bugs": "https://github.com/tsdk-monorepo/tsdk/issues",

diff --git a/packages/tsdk/package.json b/packages/tsdk/package.json
@@ -1,6 +1,6 @@
 {
   "name": "tsdk",
-  "version": "0.0.29",
+  "version": "0.0.30",
   "description": "Type-safe API development and code share tool for TypeScript projects.",
   "repository": "tsdk-monorepo/tsdk",
   "bugs": "https://github.com/tsdk-monorepo/tsdk/issues",

diff --git a/packages/tsdk/src/sync-api.ts b/packages/tsdk/src/sync-api.ts
@@ -130,7 +130,11 @@ export async function syncAPI() {
         ${
           isGET
             ? `
-        
+/** 
+ * ${description}
+ * 
+ * @category ${category}
+ */
 export function use${name}(
 payload: ${name}Req,
 options?: SWRConfiguration<${name}Res>,
@@ -147,6 +151,11 @@ return useSWR(
 }
         `
             : `
+            /** 
+             * ${description}
+             * 
+             * @category ${category}
+             */
             export function use${name}(
               options?: SWRMutationConfiguration<
                 ${name}Res,
@@ -173,6 +182,11 @@ return useSWR(
           ${
             isGET
               ? `
+          /** 
+           * ${description}
+           * 
+           * @category ${category}
+           */
           export function use${name}(
             payload: ${name}Req,
             options?: UndefinedInitialDataOptions<${name}Res, Error>,
@@ -192,6 +206,11 @@ return useSWR(
             );
           }`
               : `
+              /** 
+               * ${description}
+               * 
+               * @category ${category}
+               */
               export function use${name}(
                 options?: UseMutationOptions<
                   ${name}Res,

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml