給公司寫的composer包開發的規範

2019 年 11 月 23 日
筆記

版本格式

主版本號.次版本號.修訂號

版本號遞增規則

主版本號：當你做了不兼容的 API 修改
次版本號：當你做了向下兼容的功能性新增
修訂號：當你做了向下兼容的問題修正
先行版本號及版本編譯元數據可以加到「主版本號.次版本號.修訂號」的後面，作為延伸。

發佈 1.0.0 版本的時機

被用於正式環境
如果有個穩定的 API 被使用者依賴
如果很擔心向下兼容的問題

總而言之，由於0.x版本在機制和語義上和大於1.0的版本有一定差異，容易產生誤用，被用於生產環境的包的版本號都必須>=1.0

composer.lock的規範

開發應用程序必須提交 composer.lock 文件到 git 版本庫中

這會確保每一個人 —— 你、你的合作夥伴、你的 CI 服務器以及你的產品服務器 —— 所運行的應用程序擁有相同依賴的版本。

開發庫不需要提交composer.lock

該文件對使用該庫的項目不會有任何影響，無法達到限制版本的目的

composer.json中依賴版本的規範

不允許在項目中使用不限定版本的方式

由於主版本的升級可能伴隨着api的不兼容，如果require * 這種不限定版本的方式很可能帶來不兼容的隱患，所以推薦至少鎖定主版本號

例如

目前使用xxx/service的1.0.0版本，則請寫~1.0或者^1.0.0，這樣效果等同於>= 1.0且< 2.0，如果第三方使用時引用了xxx/service的2.0版本且引用了你的依賴1.0的版本，則會安裝出錯，立刻引起注意

如果 require * 則安裝會正常進行，但是可能發生使用時的意外（api不兼容）

版本號鎖定中^和~的重要區別

~的作用

~ 的作用是允許表達式中最後一位變到最大值

符號	效果
~0.0.1	>= 0.0.1 且 < 0.1.0
~0.1.1	>= 0.1.1 且 < 0.2.0
~0.1	>= 0.1.0 且 < 1.0.0
~1.1	>= 1.1 且 < 2.0.0

^的作用

++^ 鎖定的是x.y.z版本號中從左到右非0的第一個版本號的版本++

比如^ 1.2.3 為鎖定主版本號1；而^ 0.1.2則為鎖定0.1；^ 0.0.3則為鎖定0.0.3版本

所以^ 的行為在>=1.0和< 1.0的情況下存在特殊情況，使用時請特別注意，

版本大於1.0.0的情況

^ 鎖定不允許變的第一位

符號	效果
^ 1.2	>= 1.2 且 < 2.0
^ 1.3.1	>= 1.3.1 且 < 2.0

版本為0.x的情況

^鎖定的是從左到右非0的第一個版本號的版本

符號	效果
^0.0.1	>= 0.0.1 且 < 0.0.2
^0.1.1	>= 0.1.1 且 < 0.2.0
^0.1	>= 0.1.0 且 < 0.2.0