swagger-fsd-gen 1.0.3 → 1.0.4

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 1.0.4
+
+- Added stale generated module pruning (enabled by default) so removed/renamed Swagger tags no longer leave old `entities/{module}/api/*` files behind.
+- Added `--prune-stale <true|false>` option to control stale-file pruning behavior.
+- Fixed axios template method generation to use correct axios signatures:
+  - `post/put/patch(url, data, config)`
+  - `delete(url, config)` with optional `data` in config
+  - `get(url, config)` and other non-body methods.
+- This resolves mixed-client leftovers (for example stale `ky` modules) when regenerating with `--http-client axios`.
+
 ## 1.0.3
 
 - Fixed invalid TypeScript identifiers in generated mutation keys when API paths contain `-` (for example `undo-upload`, `applied-campaigns`, `notification-settings`, `custom-filters`).

package/README.md

@@ -39,6 +39,9 @@ yarn generate-all --uri https://api.example.com/swagger.json --http-client axios
 
 # ky 클라이언트로 생성 (기본값)
 yarn generate-all --uri https://api.example.com/swagger.json --http-client ky
+
+# stale 파일 정리를 끄고 생성
+yarn generate-all --uri https://api.example.com/swagger.json --prune-stale false
 ```
 
 ### 2. package.json에 스크립트 추가 (권장)
@@ -98,6 +101,7 @@ src/
 | --username             | Basic Auth 사용자명   | -                                          |
 | --password             | Basic Auth 비밀번호   | -                                          |
 | --http-client          | HTTP 클라이언트 선택  | ky (`axios`, `ky`)                         |
+| --prune-stale          | stale 생성 파일 정리  | true (`true`, `false`)                     |
 | --dto-output-path      | DTO 파일 경로         | src/shared/api/dto.ts                      |
 | --api-output-path      | API 클래스 경로       | src/entities/{moduleName}/api/index.ts     |
 | --query-output-path    | Query 훅 경로         | src/entities/{moduleName}/api/queries.ts   |

package/USAGE.md

@@ -46,6 +46,9 @@ generate-all --uri ./swagger/my-api.yml --http-client axios
 # ky 클라이언트로 생성 (기본값)
 generate-all --uri ./swagger/my-api.yml --http-client ky
 
+# stale 생성 파일 정리 비활성화
+generate-all --uri ./swagger/my-api.yml --prune-stale false
+
 # 인증이 필요한 경우
 generate-all --uri https://api.example.com/swagger.json --username admin --password secret
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-fsd-gen",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "main": "index.js",
   "description": "Swagger API client generator that creates type-safe API clients using axios or ky and TanStack Query with Feature Sliced Design pattern. Automatically generates API client code from Swagger/OpenAPI specifications.",
   "scripts": {

package/scripts/generate-all.js

@@ -80,6 +80,7 @@ const parseArguments = () => {
       "mutation-output-path",
       "project-template",
     ],
+    boolean: ["prune-stale"],
     alias: {
       u: "uri",
       un: "username",
@@ -91,6 +92,10 @@ const parseArguments = () => {
       qp: "query-output-path",
       mp: "mutation-output-path",
       pt: "project-template",
+      ps: "prune-stale",
+    },
+    default: {
+      "prune-stale": true,
     },
   });
 
@@ -105,6 +110,7 @@ const parseArguments = () => {
     queryOutputPath: argv["query-output-path"],
     mutationOutputPath: argv["mutation-output-path"],
     projectTemplate: argv["project-template"],
+    pruneStale: argv["prune-stale"],
   };
 };
 
@@ -197,6 +203,7 @@ const printUsage = (outputPaths) => {
       "[--api-output-path <api-output-path>] " +
       "[--query-output-path <query-output-path>] " +
       "[--mutation-output-path <mutation-output-path>] " +
+      "[--prune-stale <true|false>] " +
       "[--project-template <project-template>]"
   );
   console.error(
@@ -208,6 +215,79 @@ const printUsage = (outputPaths) => {
   );
 };
 
+/**
+ * 모듈 파일명에서 모듈명을 추출
+ * @param {string} fileName
+ * @returns {string}
+ */
+const extractModuleName = (fileName) => fileName.replace("Route", "").toLowerCase();
+
+/**
+ * 템플릿 경로에서 현재 생성 대상이 아닌 모듈 파일을 정리
+ * @param {string} templatePath
+ * @param {Set<string>} generatedModules
+ */
+const pruneStaleFilesByTemplate = async (templatePath, generatedModules) => {
+  if (!templatePath.includes("{moduleName}")) return;
+
+  const [prefix, suffix] = templatePath.split("{moduleName}");
+  const modulesRoot = prefix;
+
+  if (!fs.existsSync(modulesRoot)) return;
+
+  const moduleDirs = await fs.promises.readdir(modulesRoot, {
+    withFileTypes: true,
+  });
+
+  for (const dirent of moduleDirs) {
+    if (!dirent.isDirectory()) continue;
+
+    const moduleName = dirent.name;
+    if (generatedModules.has(moduleName)) continue;
+
+    const targetFilePath = path.join(modulesRoot, moduleName, suffix);
+    if (!fs.existsSync(targetFilePath)) continue;
+
+    await fs.promises.unlink(targetFilePath);
+    console.log(`🧹 Pruned stale generated file: ${targetFilePath}`);
+
+    const removableDirs = [
+      path.dirname(targetFilePath),
+      path.dirname(path.dirname(targetFilePath)),
+    ];
+
+    for (const candidateDir of removableDirs) {
+      if (!candidateDir.startsWith(modulesRoot)) continue;
+      if (!fs.existsSync(candidateDir)) continue;
+
+      const entries = await fs.promises.readdir(candidateDir);
+      if (entries.length === 0) {
+        await fs.promises.rmdir(candidateDir);
+      }
+    }
+  }
+};
+
+/**
+ * 이전 스웨거 기준 stale 생성 파일 정리
+ * @param {Object} outputPaths
+ * @param {Set<string>} generatedModules
+ */
+const pruneStaleGeneratedFiles = async (outputPaths, generatedModules) => {
+  if (generatedModules.size === 0) return;
+
+  await pruneStaleFilesByTemplate(outputPaths.api.absolutePath, generatedModules);
+  await pruneStaleFilesByTemplate(
+    outputPaths.apiInstance.absolutePath,
+    generatedModules
+  );
+  await pruneStaleFilesByTemplate(outputPaths.query.absolutePath, generatedModules);
+  await pruneStaleFilesByTemplate(
+    outputPaths.mutation.absolutePath,
+    generatedModules
+  );
+};
+
 /**
  * swagger-typescript-api를 사용하여 API 코드 생성
  * @param {Object} params - 생성 파라미터
@@ -290,6 +370,8 @@ const generateApiFunctionCode = async (args, outputPaths) => {
     prettier: { parser: "typescript" },
   });
 
+  const generatedModules = new Set();
+
   for (const { fileName, fileContent } of apiFunctionCode.files) {
     if (fileName === "http-client") continue;
 
@@ -300,7 +382,8 @@ const generateApiFunctionCode = async (args, outputPaths) => {
       formatWithProjectPrettier(outputPath);
       console.log(`✅ Generated DTO: ${outputPaths.dto.relativePath}`);
     } else {
-      const moduleName = fileName.replace("Route", "").toLowerCase();
+      const moduleName = extractModuleName(fileName);
+      generatedModules.add(moduleName);
 
       if (fileName.match(/Route$/)) {
         outputPath = outputPaths.apiInstance.absolutePath.replace(
@@ -325,6 +408,8 @@ const generateApiFunctionCode = async (args, outputPaths) => {
       }
     }
   }
+
+  return generatedModules;
 };
 
 /**
@@ -351,10 +436,13 @@ const generateTanstackQueryCode = async (args, outputPaths) => {
     prettier: { parser: "typescript" },
   });
 
+  const generatedModules = new Set();
+
   for (const { fileName, fileContent } of tanstackQueryCode.files) {
     if (fileName === "http-client" || fileName === "data-contracts") continue;
 
-    const moduleName = fileName.replace("Route", "").toLowerCase();
+    const moduleName = extractModuleName(fileName);
+    generatedModules.add(moduleName);
     let outputPath;
 
     if (fileName.match(/Route$/)) {
@@ -379,6 +467,8 @@ const generateTanstackQueryCode = async (args, outputPaths) => {
       );
     }
   }
+
+  return generatedModules;
 };
 
 /**
@@ -401,10 +491,21 @@ const main = async () => {
     console.log(`🌐 HTTP client mode: ${args.httpClient}`);
 
     // 1. API 클래스와 DTO 생성
-    await generateApiFunctionCode(args, outputPaths);
+    const generatedApiModules = await generateApiFunctionCode(args, outputPaths);
 
     // 2. TanStack Query 훅 생성
-    await generateTanstackQueryCode(args, outputPaths);
+    const generatedTanstackModules = await generateTanstackQueryCode(
+      args,
+      outputPaths
+    );
+
+    if (args.pruneStale) {
+      const generatedModules = new Set([
+        ...generatedApiModules,
+        ...generatedTanstackModules,
+      ]);
+      await pruneStaleGeneratedFiles(outputPaths, generatedModules);
+    }
 
     console.log("\n🎉 API client generation completed successfully!");
     console.log("\n📁 Generated files:");

package/templates/procedure-call.ejs

@@ -94,7 +94,23 @@ const instance = <%= instanceParamName %> ?? this.instance;
 <% } %>
 
 <% if (isAxios) { %>
-return instance.<%= route.request.method.toLowerCase() %><<%= responseType %>>(`<%= route.request.path.replace(/{/g, '{').replace(/}/g, '}').slice(1,) %>`, {
+<% if (['post', 'put', 'patch'].includes(route.request.method.toLowerCase())) { %>
+return instance.<%= route.request.method.toLowerCase() %><<%= responseType %>>(
+`<%= route.request.path.replace(/{/g, '{').replace(/}/g, '}').slice(1,) %>`,
+<% if (payload) { %>
+data,
+<% } else { %>
+undefined,
+<% } %>
+{
+<% if (query) { %>
+    params, // 쿼리 파라미터 설정
+<% } %>
+    ...options, // 추가 axios 옵션 병합
+}
+).then((response) => response.data);
+<% } else if (route.request.method.toLowerCase() === 'delete') { %>
+return instance.delete<<%= responseType %>>(`<%= route.request.path.replace(/{/g, '{').replace(/}/g, '}').slice(1,) %>`, {
 <% if (query) { %>
     params, // 쿼리 파라미터 설정
 <% } %>
@@ -104,6 +120,14 @@ return instance.<%= route.request.method.toLowerCase() %><<%= responseType %>>(`
     ...options, // 추가 axios 옵션 병합
 }).then((response) => response.data);
 <% } else { %>
+return instance.<%= route.request.method.toLowerCase() %><<%= responseType %>>(`<%= route.request.path.replace(/{/g, '{').replace(/}/g, '}').slice(1,) %>`, {
+<% if (query) { %>
+    params, // 쿼리 파라미터 설정
+<% } %>
+    ...options, // 추가 axios 옵션 병합
+}).then((response) => response.data);
+<% } %>
+<% } else { %>
 // HTTP 요청 실행 및 JSON 응답 반환
 return instance.<%= route.request.method.toLowerCase() %><<%= responseType %>>(`<%= route.request.path.replace(/{/g, '{').replace(/}/g, '}').slice(1,) %>`,{
 <% if (query) { %>