Angular 應用裡 ng-package.json 檔案的作用是什麼？

JerryWang_汪子熙發表於2023-03-26
AngularPackageJSON

如下圖所示：

{
  "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
  "dest": "../../dist/core",
  "lib": {
    "entryFile": "./public_api.ts"
  }
}

在 Angular 應用中，ng-package.json 檔案用於配置 Angular 庫的打包和釋出。它是 Angular CLI 中 Angular Package Format（APF）的一部分，它為開發者提供了一種簡單的方式來建立和打包 Angular 庫。

下面是 ng-package.json 檔案中一些重要的配置選項：

"lib": 配置庫的名稱和版本號，以及該庫所依賴的其他庫和模組。
"dest": 配置打包後的庫的輸出路徑。
"entryFile": 配置庫的入口檔案。
"whitelistedNonPeerDependencies": 配置庫依賴的非同級依賴項，以避免在使用 npm install 安裝庫時出現錯誤。
"assets": 配置庫打包時需要包含的靜態資源，如影像和 CSS 檔案。

透過配置 ng-package.json 檔案，你可以自定義 Angular 應用中的包的打包方式，從而更好地管理你的程式碼庫，並提高程式碼的可重用性。

檔案 ng-package.schema.json 的作用？

ng-package.schema.json 檔案是用來定義 ng-package.json 檔案的 JSON Schema 的，它定義了 ng-package.json 檔案中允許的屬性、型別、格式等資訊。透過使用 JSON Schema，可以對 ng-package.json 檔案進行語法檢查和提示，幫助開發人員正確地編寫 ng-package.json 檔案。

在 Angular CLI 中，ng-package.json 檔案會自動載入 ng-package.schema.json 檔案，從而實現自動提示和錯誤檢查的功能。這樣，在編寫 ng-package.json 檔案時，開發人員就可以透過 IDE 或文字編輯器的提示來快速、準確地編寫配置，避免因為拼寫錯誤、屬性格式不正確等問題導致的打包錯誤。

總之，ng-package.schema.json 檔案是一個很有用的工具，可以幫助開發人員更高效地編寫 ng-package.json 檔案，並確保打包配置的正確性。

JSON Schema 是一個用於描述 JSON 資料格式的後設資料標準，它提供了一種定義 JSON 資料結構和資料格式的方式，從而使得開發者可以更加清晰地定義和驗證 JSON 資料。JSON Schema 通常用於描述 RESTful API 的請求和響應資料格式、資料儲存和傳輸格式等。

JSON Schema 定義了一組屬性、關鍵字和資料型別，開發人員可以透過這些屬性和關鍵字來定義 JSON 資料的格式、型別、值域、必選性等約束條件，以及如何處理資料型別轉換、預設值、正規表示式驗證等細節。透過使用 JSON Schema，開發人員可以確保 JSON 資料格式的正確性、一致性和可靠性，提高系統的健壯性和可維護性。

JSON Schema 的標準由 IETF 維護，目前最新版本是 JSON Schema 2020-12。許多程式語言和工具都支援 JSON Schema，例如 JavaScript 的 Ajv 庫、Python 的 jsonschema 庫等，這些庫可以將 JSON Schema 用於資料驗證、模型生成、檔案生成等場景。

相關文章