@flashaim-gmb/interface

整合 GMB 所有 interface

開發流程

1. 先根據 googleBooking 開立對應的 branch dev-5-[issue] 其中 5 是標示從那個次版本開出。
2. 當確認需求開發完畢要入主線 master 請增加主版版號。

本地建置 (Build)

執行以下指令進行編譯：

npm run build

此指令會將 TypeScript 原始碼編譯為實體 .js 與型別宣告檔 .d.ts。

發布 (Publish) 設定與流程

為了避免開發者在發布時不小心洩漏驗證 Token，且為了防止發布時包含 .ts 原始碼導致引用套件的專案編譯失敗，請遵循以下步驟進行發布：

1. 本地驗證設定 (一次性)

在第一次發布前，請將根目錄下的範本檔複製並填寫 Token：

1. 複製範本檔：

   cp .npmrc.example .npmrc

2. 開啟產生的 .npmrc 檔案，填入您的 npm 驗證 Token：

   //registry.npmjs.org/:_authToken=您的Token值
   package-lock=true

   註：.npmrc 已被加入 .gitignore 中，您的驗證 Token 絕對不會被提交至 Git。

💡 如何獲取 npm 驗證 Token (建議產生 Bypass 2FA Token)：

1. 登入 npm 官網 (npmjs.com)。
2. 點擊右上角個人頭像，進入 Access Tokens -> Generate New Token -> 選擇 Granular Access Token。
3. 進行以下設定：
   • Token name：輸入識別名稱（例如 flashaim-interface-publish）。
   • Permissions：選擇 Read and write，並在下方勾選對應的組織或套件（如 @flashaim-gmb）。
   • 繞過 2FA（關鍵）：在下方 Require two-factor authentication 設定中，勾選 Bypass two-factor authentication for publishing（這可以讓您在發布時免用手機 Authenticator 收驗證碼）。
4. 點擊 Generate Token，複製產生的 npm_xxxx Token 並貼入 .npmrc 中。

2. 執行發布

執行發布指令：

npm publish

• 發布前 (prepare)：系統會自動執行 npm run build 產生 .js 與 .d.ts 檔案。
• 打包過濾：根據 .npmignore 設定，只會將 .js 與 .d.ts 打包發布至 npm，並自動排除所有 .ts 原始碼與備份檔案。
• 發布後 (postpublish)：自動刪除本地產生的所有 .js 檔案，保持開發目錄乾淨。