💭

TypeScriptで書かれたnpmモジュールをフォークして使いたい！

2022/09/19に公開

package.jsonにgitのURLが指定できる

package.jsonのdependenciesなどにgitのURLを指定してもちゃんと取ってきてくれます。すごい！
なので、フォークしたリポジトリのURLをdependenciesに指定しちゃいます

{
    "name": "packageName",
    "dependencies": {
        "mfm-js": "git+https://github.com/sim1222/mfm.js.git"
    }
}

.gitのあとに#をつけてブランチ名やタグを指定すると、そのブランチやタグの内容を取ってきてくれます

{
    "name": "packageName",
    "dependencies": {
        "mfm-js": "git+https://github.com/sim1222/mfm.js.git#develop"
    }
}

yarnなどでも同じことができます

yarn add https://github.com/sim1222/mfm.js

パッケージがTypeScriptなどで書かれていてmainなどにビルド後のファイルが指定されている場合、ビルドが必要になります。

フォークしたパッケージのpackage.jsonにpostinstallを指定することで、インストール時にビルドを実行できます

{
    ...,
    "scripts": {
        ...
        "postinstall": "npm run build"
    }
}

よきフォークライフを！