見出し画像

Semver とパッケージのメモ

semver

package.json の semver 範囲指定 (^ とか)

[major, minor, patch] tuple.

^1.2.3 := >=1.2.3 <2.0.0-0
^0.2.3 := >=0.2.3 <0.3.0-0
^0.0.3 := >=0.0.3 <0.0.4-0

最初に登場する non zero の数字を上げることを認めない

~1.2.3 := >=1.2.3 <1.(2+1).0 := >=1.2.3 <1.3.0-0
~1.2 := >=1.2.0 <1.(2+1).0 := >=1.2.0 <1.3.0-0 (Same as 1.2.x)
~1 := >=1.0.0 <(1+1).0.0 := >=1.0.0 <2.0.0-0 (Same as 1.x)
~0.2.3 := >=0.2.3 <0.(2+1).0 := >=0.2.3 <0.3.0-0
~0.2 := >=0.2.0 <0.(2+1).0 := >=0.2.0 <0.3.0-0 (Same as 0.2.x)
~0 := >=0.0.0 <(0+1).0.0 := >=0.0.0 <1.0.0-0 (Same as 0.x)

minor 指定があれば patch のみ上げて良い、major 指定のみなら minor も上げて良い

そうそう、いつも忘れるのよね・・・

本家

0.x.y のときは breaking change をいつでも作ってよい。開発初期のモラトリアム期間。minor でも patch でもあり。1.0.0 以降は breaking change がある場合は major を上げなければならない。

Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable.

Version 1.0.0 defines the public API. The way in which the version number is incremented after this release is dependent on this public API and how it changes.

Patch version Z (x.y.Z | x > 0) MUST be incremented if only backwards compatible bug fixes are introduced. A bug fix is defined as an internal change that fixes incorrect behavior.

Minor version Y (x.Y.z | x > 0) MUST be incremented if new, backwards compatible functionality is introduced to the public API. It MUST be incremented if any public API functionality is marked as deprecated. It MAY be incremented if substantial new functionality or improvements are introduced within the private code. It MAY include patch level changes. Patch version MUST be reset to 0 when minor version is incremented.

Major version X (X.y.z | X > 0) MUST be incremented if any backwards incompatible changes are introduced to the public API. It MAY also include minor and patch level changes. Patch and minor versions MUST be reset to 0 when major version is incremented.

package-lock.json や yarn.lock がある理由

package.json のバージョン指定は幅があるので要求を満たせばインストール時点での最新版が選ばれ、開発者ごとに使うパッケージのバージョンがずれる。

package-lock.json や yarn.lock をリポジトリに入れていれば、git clone & yarn install したときに yarn.lock に記載されているバージョンがインストールされる。

package.json の x.x.x や ^x.x.x をどのバージョンに「解決」するかの resolver だと思えばよい。メンテしてあげないと共通のバージョンを使えるパッケージも別のバージョンに解決してしまうエントリができていたりするので注意。

パッケージ間でやりとりする u64, BN, Decimal はバージョンを揃えて置かないと受け渡しができなくなる。

モジュールタイプ

cjs (commonjs) で配布されているものが多いが、esm とかブラウザ用の browser を含むものもある。

どのタイプかは package.json の type 情報か、拡張子などで判断される。node は何もしなければ cjs と期待している。


依存パッケージの依存パッケージにも特定バージョンを強制

yarn だけが resolutions を使える。

"dependencies": {
    "@orca-so/stablecurve": "^1.0.6",
    "@orca-so/whirlpools-sdk": "^0.5.3",
},
"resolutions": {
    "@solana/spl-token": "^0.1.8"
}

stablecurve が古い spl-token を使うので 0.1.8 の使用を強制する


この記事が気に入ったらサポートをしてみませんか?