birc-generator 0.9.0 → 0.9.1

package/PROJECT.md

@@ -48,7 +48,7 @@ anchor 就不要重寫整份設定；推測以後會用到的模組先不要做
 
 ## 慣例
 
-**make 一次整組。** `make` 串 `makeStackActions`：Entity + DAO + Mapper + DTO + Service + Controller。`--migration` 生 `create_{table}_table`（Flyway SQL）。`--seed` 生 `XxxSeeder`（Java，走 DAO；`birc seed` 才執行）。單層指令共用同一組 actions，不另寫一份。`make:entity` 產出 Entity、`XxxDAO extends BaseDAO`。`--migration` / `--seed` 同 `make:model`；已有 Entity 就跳過，只補 SQL / Seeder。`make:model` 同 Entity + DAO；`--migration` / `--seed` 同上，`--controller` 生 Controller。`make:seeder BookSeeder` 只生 Seeder（寫 `Book` 也可以，結尾 `Seeder` 會剝掉再對 Entity）。`--soft-delete` 在 Entity 加 Hibernate `@SoftDelete(columnName = "deleted_at", strategy = TIMESTAMP)`，migration 加 `deleted_at TIMESTAMP NULL`；`deleteById` 不用改。不做 restore / withTrashed。`make:entity --dto` 與 `make:entity --mapper` 一併生 Mapper 與 Request / Response DTO（同一組檔）。`make:mapper` 連 Request / Response DTO，並把 MapStruct 依賴接到 `build.gradle` 的 dependency-anchor 後面（已有則跳過）。`make:service` 的 `XxxService extends BaseService`，CRUD 在 `BaseServiceImpl`；多出來的業務方法寫在 `XxxService` / `XxxServiceImpl`。指令是 `make:entity`，不是 `make::entity`。預設只生引入與初稿；加 `--example` 或 `--fields` 才生完整範例（CRUD、欄位、`@Column`）。`--example` 的 Entity 與 `make:migration` 一樣帶 `created_at` / `updated_at`（DB 填，JPA `insertable = false`），不進 CreateRequest。多模組時 Entity / DAO 落在 `databaseconfig`。路徑以 `.bircrc.json` 的 `entityPath` / `daoPath` 為準。
+**make 一次整組。** `make` 串 `makeStackActions`：Entity + DAO + Mapper + DTO + Service + Controller。`--migration` 生 `create_{table}_table`（Flyway SQL）。`--seed` 生 `XxxSeeder`（Java，走 DAO；`birc seed` 才執行）。加 `--migration` / `--seed` 時已有 Java 就跳過，只補缺的檔與 SQL / Seeder。單層指令共用同一組 actions，不另寫一份。`make:entity` 產出 Entity、`XxxDAO extends BaseDAO`。`--migration` / `--seed` 同 `make:model`；已有 Entity 就跳過，只補 SQL / Seeder。`make:model` 同 Entity + DAO；`--migration` / `--seed` 同上，`--controller` 生 Controller。`make:seeder BookSeeder` 只生 Seeder（寫 `Book` 也可以，結尾 `Seeder` 會剝掉再對 Entity）。`--soft-delete` 在 Entity 加 Hibernate `@SoftDelete(columnName = "deleted_at", strategy = TIMESTAMP)`，migration 加 `deleted_at TIMESTAMP NULL`；`deleteById` 不用改。不做 restore / withTrashed。`make:entity --dto` 與 `make:entity --mapper` 一併生 Mapper 與 Request / Response DTO（同一組檔）。`make:mapper` 連 Request / Response DTO，並把 MapStruct 依賴接到 `build.gradle` 的 dependency-anchor 後面（已有則跳過）。`make:service` 的 `XxxService extends BaseService`，CRUD 在 `BaseServiceImpl`；多出來的業務方法寫在 `XxxService` / `XxxServiceImpl`。指令是 `make:entity`，不是 `make::entity`。預設只生引入與初稿；加 `--example` 或 `--fields` 才生完整範例（CRUD、欄位、`@Column`）。`--example` 的 Entity 與 `make:migration` 一樣帶 `created_at` / `updated_at`（DB 填，JPA `insertable = false`），不進 CreateRequest。多模組時 Entity / DAO 落在 `databaseconfig`。路徑以 `.bircrc.json` 的 `entityPath` / `daoPath` 為準。
 
 **例外走 ProjectException。** 基底是專案內的 `ProjectException`（`getErrorCode` / `getHttpStatus`），不是 starter 的 `BusinessException`。`create` 會生 `ProjectException`、`NotFoundException`、`ExceptionHandleController`、`web/Result`。`make:exception` 生的類別一律 `extends ProjectException`。Controller 回傳專案內 `Result<T>`，不引用 `tw.edu.ntub.birc.starter`。
 

package/README.md

@@ -122,7 +122,7 @@ ValidGroup、Spotless、注入 agent 文件），不再問。
 | `birc update` | 更新本機 `birc`（`npm install -g birc-generator@latest`） |
 | `birc add` | 往既有專案加模組。沒帶名稱會互動勾選；`birc add email sentry` 直接加。`--force` 覆寫已選的已安裝 feature 檔 |
 | `birc sync` | 用目前 template 覆寫全部已安裝 feature 的檔（不動 yml / gradle） |
-| `birc make` | 一次生 Entity + DAO + Mapper + DTO + Service + Controller；加 `--migration` / `--seed` |
+| `birc make` | 一次生 Entity + DAO + Mapper + DTO + Service + Controller；加 `--migration` / `--seed`。已有 Java 時加這兩個旗標會跳過，只補缺的檔與 SQL / Seeder |
 | `birc make:entity` | Entity、`XxxDAO`；加 `--migration` / `--seed` / `--dto`、`--mapper`、`--soft-delete`。已有檔要覆寫加 `--force`；只要表或 Seeder 可 `--migration` / `--seed`，不會覆寫 Entity |
 | `birc make:model` | 同 `make:entity`；加 `--migration` / `--seed` / `--controller` / `--soft-delete` |
 | `birc make:mapper` | Mapper 和 CreateRequest / Response |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "birc-generator",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "Spring Boot 4 CRUD scaffold generator built on Plop.js",
   "license": "MIT",
   "author": "lucashsu95",

package/plopfile.js

@@ -201,6 +201,10 @@ function includeModelSeed(data) {
   return Boolean(data && data.seed) || process.env.BIRC_MAKE_SEED === '1';
 }
 
+function skipExistingMakeFiles(data) {
+  return includeModelMigration(data) || includeModelSeed(data);
+}
+
 function includeModelController(data) {
   return Boolean(data && data.controller) || process.env.BIRC_MAKE_CONTROLLER === '1';
 }
@@ -1157,12 +1161,13 @@ module.exports = function (plop) {
     ];
   }
 
-  function makeMapperActions(data) {
+  function makeMapperActions(data, options) {
     const { root, gradlePath, templateData } = makeContext(data);
+    const skipIfExists = Boolean(options && options.skipIfExists);
     return [
-      { type: 'add', path: `${root}/dto/{{pascalCase entityName}}CreateRequest.java`, templateFile: 'templates/dto-request.hbs', data: templateData },
-      { type: 'add', path: `${root}/dto/{{pascalCase entityName}}Response.java`, templateFile: 'templates/dto-response.hbs', data: templateData },
-      { type: 'add', path: `${root}/mapper/{{pascalCase entityName}}Mapper.java`, templateFile: 'templates/mapper.hbs', data: templateData },
+      { type: 'add', path: `${root}/dto/{{pascalCase entityName}}CreateRequest.java`, templateFile: 'templates/dto-request.hbs', data: templateData, skipIfExists },
+      { type: 'add', path: `${root}/dto/{{pascalCase entityName}}Response.java`, templateFile: 'templates/dto-response.hbs', data: templateData, skipIfExists },
+      { type: 'add', path: `${root}/mapper/{{pascalCase entityName}}Mapper.java`, templateFile: 'templates/mapper.hbs', data: templateData, skipIfExists },
       {
         type: 'appendFragment',
         path: gradlePath,
@@ -1174,16 +1179,18 @@ module.exports = function (plop) {
     ];
   }
 
-  function makeServiceActions(data) {
+  function makeServiceActions(data, options) {
     const { root, templateData } = makeContext(data);
+    const skipIfExists = Boolean(options && options.skipIfExists);
     return [
-      { type: 'add', path: `${root}/service/{{pascalCase entityName}}Service.java`, templateFile: 'templates/service.hbs', data: templateData },
-      { type: 'add', path: `${root}/service/impl/{{pascalCase entityName}}ServiceImpl.java`, templateFile: 'templates/serviceImpl.hbs', data: templateData }
+      { type: 'add', path: `${root}/service/{{pascalCase entityName}}Service.java`, templateFile: 'templates/service.hbs', data: templateData, skipIfExists },
+      { type: 'add', path: `${root}/service/impl/{{pascalCase entityName}}ServiceImpl.java`, templateFile: 'templates/serviceImpl.hbs', data: templateData, skipIfExists }
     ];
   }
 
-  function makeControllerActions(data) {
+  function makeControllerActions(data, options) {
     const { root, templateData } = makeContext(data);
+    const skipIfExists = Boolean(options && options.skipIfExists);
     return [
       {
         type: 'add',
@@ -1192,16 +1199,17 @@ module.exports = function (plop) {
         data: templateData,
         skipIfExists: true
       },
-      { type: 'add', path: `${root}/controller/{{pascalCase entityName}}Controller.java`, templateFile: 'templates/controller.hbs', data: templateData }
+      { type: 'add', path: `${root}/controller/{{pascalCase entityName}}Controller.java`, templateFile: 'templates/controller.hbs', data: templateData, skipIfExists }
     ];
   }
 
   function makeStackActions(data) {
+    const skipIfExists = skipExistingMakeFiles(data);
     return appendMakeSqlActions([
-      ...makeEntityActions(data),
-      ...makeMapperActions(data),
-      ...makeServiceActions(data),
-      ...makeControllerActions(data)
+      ...makeEntityActions(data, { skipIfExists }),
+      ...makeMapperActions(data, { skipIfExists }),
+      ...makeServiceActions(data, { skipIfExists }),
+      ...makeControllerActions(data, { skipIfExists })
     ], data);
   }
 
@@ -1215,10 +1223,10 @@ module.exports = function (plop) {
     description: '產生 Entity 與 DAO；--migration / --seed / --dto / --mapper / --soft-delete',
     prompts: [entityNamePrompt, fieldsPrompt],
     actions(data) {
-      const extras = includeModelMigration(data) || includeModelSeed(data);
+      const extras = skipExistingMakeFiles(data);
       const actions = makeEntityActions(data, { skipIfExists: extras });
       if (includeMapperWithEntity(data)) {
-        actions.push(...makeMapperActions(data));
+        actions.push(...makeMapperActions(data, { skipIfExists: extras }));
       }
       appendMakeSqlActions(actions, data);
       return actions;

package/project-docs/PROJECT.md.hbs

@@ -58,7 +58,7 @@ DB → Entity → Mapper → XxxResponse → Result<T>
 ## 統一規範
 
 - 例外丟 `ProjectException` 子類（例如 `NotFoundException`），由 `ExceptionHandleController` 轉成回應。Controller 不手動 try-catch 包錯誤訊息。
-- 整組骨架用 `birc make`；單層用 `birc make:entity` / `make:model` / `make:mapper` / `make:service` / `make:controller` / `make:exception`。`make:entity` 只生 Entity 與 DAO；`--migration` / `--seed` 同 `make:model`（已有 Entity 就跳過，只補 SQL / Seeder）。`--dto` 與 `--mapper` 一併生 Mapper 與 DTO。`make:model` 可加 `--migration` / `--seed` / `--controller`。`make` 也可加 `--migration` / `--seed`。`make:seeder BookSeeder` 生 Java Seeder。`--soft-delete` 用 Hibernate `@SoftDelete` 的 `deleted_at`，查詢自動排除已刪；不要自寫 `@SQLDelete`。預設是初稿，完整範例加 `--example` 或 `--fields`。`make:migration create_{table}_table` 讀對應 Entity 欄位寫進 SQL。`--seed` 生 Java Seeder，用 DAO 塞資料；`birc seed` 才執行。清空資料庫用 `birc db:wipe`。不要複製其他 Entity 的程式碼來改名。
+- 整組骨架用 `birc make`；單層用 `birc make:entity` / `make:model` / `make:mapper` / `make:service` / `make:controller` / `make:exception`。`make:entity` 只生 Entity 與 DAO；`--migration` / `--seed` 同 `make:model`（已有 Entity 就跳過，只補 SQL / Seeder）。`--dto` 與 `--mapper` 一併生 Mapper 與 DTO。`make:model` 可加 `--migration` / `--seed` / `--controller`。`make` 也可加 `--migration` / `--seed`（已有 Java 就跳過，只補缺的檔與 SQL / Seeder）。`make:seeder BookSeeder` 生 Java Seeder。`--soft-delete` 用 Hibernate `@SoftDelete` 的 `deleted_at`，查詢自動排除已刪；不要自寫 `@SQLDelete`。預設是初稿，完整範例加 `--example` 或 `--fields`。`make:migration create_{table}_table` 讀對應 Entity 欄位寫進 SQL。`--seed` 生 Java Seeder，用 DAO 塞資料；`birc seed` 才執行。清空資料庫用 `birc db:wipe`。不要複製其他 Entity 的程式碼來改名。
 - 欄位驗證用專案內 `validation/ValidGroup`。CRUD 用 `Create` / `Update`。`Delete` 給「刪除還要帶原因、確認碼、樂觀鎖 version」的 body。`Submit` 給草稿可少填、送審要全填（活動送審就是這組）。Controller 的 `@Validated` 與欄位 `groups` 對同一組。
 - email / sso / oauth / validGroup 用 `birc add`，不要從別的專案抄設定。
 - 格式化走 Spotless（`./gradlew spotlessApply`），不要另裝 Checkstyle。

package/test.md

@@ -35,7 +35,7 @@
 - CLI dest：檔落在呼叫者目錄，不是 generator repo。
 - 產出 Java 沒有 `tw.edu.ntub.birc.starter` / `birc-spring-boot-starter`。
 - `make:entity --dto` / `--mapper` 與 `make:mapper` 同一組 Mapper + DTO；預設 `make:entity` 不生它們。
-- `make --fields --migration --seed` 寫 CREATE TABLE 與 Java `XxxSeeder`，不生 seed SQL；`make:model --migration` 的表名跟 Entity `@Table` 一致。已有 Entity 時 `make:entity --migration` / `--seed` 跳過 Java，只補 CREATE TABLE / `XxxSeeder`。
+- `make --fields --migration --seed` 寫 CREATE TABLE 與 Java `XxxSeeder`，不生 seed SQL；`make:model --migration` 的表名跟 Entity `@Table` 一致。已有 Entity 時 `make` / `make:entity --migration` / `--seed` 跳過 Java，只補 CREATE TABLE / `XxxSeeder`。
 - `make:seeder` / `--seed` 讀既有 Entity 欄位寫進 `setXxx`；沒有欄位時 `run()` 是空的。`make:seeder BookSeeder` 生 `BookSeeder.java`，不是 `BookSeederSeeder`。
 - `make:migration create_{table}_table` 讀既有 Entity 欄位寫進 SQL；找不到 Entity 時仍只有 `id`。
 - `--soft-delete` 的 Entity 用 `deleted_at` + `SoftDeleteType.TIMESTAMP`；沒加 flag 的 Entity / migration 沒有這欄。