🙆‍♀️

カスタマイズしたMirador 4をnpmパッケージとして公開する

2024/06/27に公開

iiif

Mirador

tech

概要

カスタマイズしたMirador 4をnpmパッケージとして公開する機会がありましたので、備忘録です。

Fork

以下の公式サイトからリポジトリをForkします。

以下のようになります。

ブランチを作成する

クローンし、ブランチを作成します。

git clone https://github.com/nakamura196/mirador
cd mirador
git checkout -b feature-add-immediately-property

以下のように出力されます。

Switched to a new branch 'feature-add-immediately-property'

開発

以下で紹介したような改修を加えます。

テスト

テストして、問題がないか確認します。

pnpm test

コミット

git add .
git commit -a -m "feat: add immediately property"

マージ

masterブランチに戻って、feature-add-immediately-propertyの内容をマージする

git checkout master
git merge feature-add-immediately-property

push

masterブランチの変更内容をpushしておきます。

git push

publish

以下のコマンドにより、ローカルの変更を一時的に無視するようにします。（他に良い方法がありそうです...）

git update-index --assume-unchanged package.json

パッケージ名を別名に変更します。

{
  "name": "@nakamura196/mirador",
  "version": "4.0.0-alpha.3",
  "description": "An open-source, web-based 'multi-up' viewer that supports zoom-pan-rotate functionality, ability to display/compare simple images, and images with annotations.",
  "main": "dist/cjs/src/index.js",
  "module": "dist/es/src/index.js",
  "files": [
    "dist"
  ],
  "sideEffects": false,
...

publishします。

pnpm publish

結果、以下のように、公開されます。

Press ENTER to open in the browser...

+ @nakamura196/mirador@4.0.0-alpha.3

まとめ

変更内容のプルリクエストについては、今回の改修内容の影響を調査した後、別途行いたいと思います。

おかしな手順も含まれているかもしれませんが、参考になりましたら幸いです。