解析composer.json中所有屬性字段

下面由composer使用教程欄目給大家介紹解析composer.json中所有屬性字段,希望對需要的朋友有所幫助!

解析composer.json中所有屬性字段

1、name

包的名字。由供應方(vendor)名和項目名組成,用 / 分隔。

在發布包的時候需要填。

2、description

對包的一個簡短描述,通常是一行的長度。

在發布包的時候需要填。

3、version

包的版本。

格式必須是 X.Y.Z,選擇性后綴:-dev、-alphaN、-betaN、-RCN。

4、type

包的類型,默認為 library。

包類型用于定制安裝邏輯。如果你的包的安裝需要一些特殊的邏輯,你可以定義一個定制的類型。它可以是一個 symfony-bundle 的類型,或者 WordPress-plugin,或者 typo3-module。這些類型將被特定的項目所用,它們將提供安裝器來安裝這些類型的包。

Composer 支持 3 種類型:

library:默認值。它將復制文件到 vendor 目錄。

project:它表示這是個項目,而不是庫。比如像 Symfony 標準版這種應用。

metapackage:一個含有依賴的空包,能觸發安裝,但不包含文件,不會向文件系統寫任何東西。

composer-install:為其他的定制類型的包提供安裝器的包。

5、keywords

一個與包相關的關鍵詞數組。用于包的搜索和過濾。

可選。

6、homepage

項目的網站 URL。

可選。

7、time

版本發布時間。必須是 YYYY-MM-DD 或 YYYY-MM-DD HH:MM:SS 格式。

可選。

8、license

包的許可證。可以是字符串或字符串數組。

可選,但強烈建議加上。

9、authors

包的作者。是個對象數組。

每個 author 對象有這些屬性:

name:作者名字

email:作者郵箱

homepage:作者網站 URL

role:作者在項目中的角色(如:developer 或 translator)

10、support

各種關于該項目如何獲取支持的信息。包含這些屬性:

email:獲取支持的郵箱

issues:問題跟蹤的 URL

forum:論壇的 URL

wiki:Wiki 的 URL

irc:IRC 的頻道

source:查看或下載源碼的 URL

可選。

11、Package links

依賴包的映射表,由包名映射版本約束。如:

?

{ ????"require":?{ ????????"monolog/monolog":?"1.0.*" ????} }

(1)require

列出包所依賴的包。除非這些依賴已經存在,否則這個包不會被安裝。

(2)require-dev(root-only)

列出開發這個包(或跑測試等等)所依賴的包。在使用 install 命令時,只有帶上 “–dev” 參數才能安裝 dev 包。在使用 update 命令時,帶上 “–no-dev” 則不更新。

(3)conflict

列出包會和哪些包發生沖突。它們將不被允許和你的包一起安裝。如果約束了版本,則只會針對特定的版本。

(4)replace

列出哪些包要被這個包替代。

(5)provide

這個包所推薦的包列表。這個對公共接口最有用,一個包可以依賴一個虛擬的 logger 包,而實現 logger 接口的庫可以放到 provide 字段中。

12、suggest

建議一些能讓這個包工作的更好或得到增強的包列表。這些信息只在包安裝完成時給出,暗示用戶可以添加更多包,雖然不是必須要安裝的。

格式是,包名映射文字說明,如:

?

{ ????"suggest":?{ ????????"monolog/monolog":?"Allows?more?advanced?logging?of?the?application?flow" ????} }

13、autoload

提供給 php autoloader 的自動加載映射。

目前支持的有:PSR-0 自動加載規范,classmap 生成器,還有 files。

PSR-0 是比較推薦的,因為它的優秀的擴展性(在添加新的類的適合,不需要重新生成自動加載器)。

(1)PSR-0

在 psr-0 鍵名下,定義一個命名空間到路徑的映射表,相對于包的根目錄。注意,這也同樣支持 PEAR-style 的沒有命名空間的風格。

請注意命名空間的聲明得以 結尾,確保自動加載器正確響應。

PSR-0 的引用可以在安裝或更新時生成的文件中查看:

vendor/composer/autoload_namespaces.php

例子:

?

{ ????"autoload":?{ ????????"psr-0":?{ ????????????"Monolog":?"src/", ????????????"VendorNamespace":?"src/", ????????????"Vendor_Namespace_":?"src/" ????????} ????} }

如果你需要在多個目錄里查找同一個前綴的命名空間,你可以用數組,如:

?

{ ????"autoload":?{ ????????"psr-0":?{?"Monolog":?["src/",?"lib/"]?} ????} }

PSR-0 風格并不局限于加載命名空間的聲明的東西,也可以用于類這個層級。當庫中只有一個在全局命名空間中的類時,這種方式就能用上。比如你有個 PHP 源文件放在項目的根目錄,你可以這樣聲明:

?

{ ????"autoload":?{ ????????"psr-0":?{?"UniqueGlobalClass":?""?} ????} }

如果你有個目錄下全是用命名空間組織的,你可以用空前綴:

?

{ ????"autoload":?{ ????????"psr-0":?{?"":?"src/"?} ????} }

(2)Classmap

classmap 的引用可以在安裝或更新時生成的文件中查看:

vendor/composer/autoload_classmap.php

類映射表是通過掃描指定的目錄或文件下的所有的 .php 和 .inc 文件生成的。

你可以給任何不支持 PSR-0 的庫用 classmap 生成器實現自動加載。配置上只要指定類所在的目錄或文件即可:

?

{ ????"autoload":?{ ????????"classmap":?["src/",?"lib/",?"Something.php"] ????} }

(3)files

如果你確定需要在任何請求中都加載某些文件,你可以使用 files 自動加載機制。對于那些包中有些 PHP 函數但不能自動加載時特別有用。例如:

?

{ ????"autoload":?{ ????????"files":?["src/MyLibrary/functions.php"] ????} }

14、include-path

(將被棄用,它的功能由 autoload 代替。其實就是設置 include_path,可選)

15、target-dir

指定安裝目標路徑。

如果包的根目錄是在命名空間下,自動加載就不正確了,所以才有 target-dir 來解決這個問題。

Symfony 就是個例子。它由很多組件包組成。Yaml 組件是在

?

SymfonyComponentYaml

命名空間下的,它的根目錄是 Yaml 目錄。要讓自動加載正常工作,我們要確保它不是安裝在

?

vendor/symfony/yaml

,而是在

?

vendor/symfony/yaml/Symfony/Component/Yaml

,這樣自動加載器才能從 vendor/symfony/yaml 加載它。

所以要定義 target-dir 如下:

?

{ ????"autoload":?{ ????????"psr-0":?{?"SymfonyComponentYaml":?""?} ????}, ????"target-dir":?"Symfony/Component/Yaml" }

16、minimum-stability(root-only)

定義根據穩定性如何過濾包。默認是 stable,如果你信賴一個 dev 包,你需要指明。

17、prefer-stable(root-only)

如果開啟,Composer 會在穩定包和不穩定包中選擇前者。

18、repositories(root-only)

定制包的倉庫地址。

默認的,Composer 只使用 Packagist 倉庫。通過指定倉庫地址,你可以從任何地方獲取包。

倉庫不能遞歸。你只能將它們添加到主的 composer.json 中。所依賴包中 composer.json 文件中的倉庫定義是被忽略的。

支持的倉庫的類型有:

(1)composer

composer 倉庫通過網絡提供 packages.json 文件,它包含一個 composer.json 對象的列表,還有額外的 dist 或 source 信息。packages.json 文件通過 PHP 流加載。

(2)vcs

版本控制系統倉庫,如:gitsvn、hg。

(3)pear

通過它,你可以導入任何 pear 倉庫到你的項目中。

(4)package

如果你依賴一個不支持 composer 的項目,你可以定義一個 package 類型的倉庫,然后將 composer.json 對象直接寫入。

完整的例子:

?

{ ????"repositories":?[ ????????{ ????????????"type":?"composer", ????????????"url":?"http://packages.example.com" ????????}, ????????{ ????????????"type":?"composer", ????????????"url":?"https://packages.example.com", ????????????"options":?{ ????????????????"ssl":?{ ????????????????????"verify_peer":?"true" ????????????????} ????????????} ????????}, ????????{ ????????????"type":?"vcs", ????????????"url":?"https://github.com/Seldaek/monolog" ????????}, ????????{ ????????????"type":?"pear", ????????????"url":?"http://pear2.php.net" ????????}, ????????{ ????????????"type":?"package", ????????????"package":?{ ????????????????"name":?"smarty/smarty", ????????????????"version":?"3.1.7", ????????????????"dist":?{ ????????????????????"url":?"http://www.smarty.net/files/Smarty-3.1.7.zip", ????????????????????"type":?"zip" ????????????????}, ????????????????"source":?{ ????????????????????"url":?"http://smarty-php.googlecode.com/svn/", ????????????????????"type":?"svn", ????????????????????"reference":?"tags/Smarty_3_1_7/distribution/" ????????????????} ????????????} ????????} ????] }

19、config(root-only)

針對項目的一些配置。

process-timeout:默認?300?秒,Composer?進程執行超時時間; use-include-path:默認?false,如果是?true,Composer?自動加載器也會到?PHP?的?include_path?中查找; preferred-install:默認?auto,設置?Composer?安裝方式; github-protocols:默認?[“git”,?“https”],設置與?github?通信協議; github-oauth:設置?oauth; vendor-dir:默認?vendor,你可以換成別的; bin-dir:默認?vendor/bin,如果項目有二進制文件,會鏈接到這; cache-dir:默認?$home/cache,存放?Composer?運行時產生的緩存; cache-files-dir:默認?$cache-dir/files,存放包的?zip?文件; cache-repo-dir:默認?$cache-dir/repo,存放倉庫元數據; cache-vcs-dir:默認?$cache-dir/vcs,存放?vcs?克隆; cache-files-ttl:默認六個月,緩存的過期時間; cache-files-maxsize:默認?300M; notify-no-install:默認?true,從倉庫安裝包會有個通知,可以關掉; discard-changes:默認false,如何處理臟的更新;

20、scripts(root-only)

Composer 允許你在安裝進程中安裝鉤子腳本,鉤子是基于事件的;

21、extra

供 scripts 消費的額外數據;

22、bin

指定哪些文件必須被當做二進制文件處理的;

23、archive

設置創建包時的選項,exclude 屬性可以設置排除哪些目錄,例如:

?

{ ????"archive":?{ ????????"exclude":?["/foo/bar",?"baz",?"/*.test",?"!/foo/bar/baz"] ????} }

更多composer相關知識,請訪問composer欄目:composer

? 版權聲明
THE END
喜歡就支持一下吧
點贊7 分享