---

---

【TypeScript】Githubにprivateのnpmパッケージを公開する方法を解説

投稿日：2021年6月5日

汎用性のあるTypeScriptコードはgithub packageとgithub actionを使ってパッケージ化しましょう。

---

はじめに

この記事について

環境

サンプルコード

---

実践

パッケージディレクトリの初期設定

$ mkdir marsquai-sample-npm-package
$ cd marsquai-sample-npm-package

$ echo "my sample package" >> README.md
$ git init
$ git add README.md
$ git commit -m "first commit"
$ git branch -M main
$ git remote add origin <GITHUB_ORIGIN>
$ git push -u origin main

$ npm init -y

node_modules/

パッケージのコードを作成

$ npm install --save-dev typescript

$ npm install --save jsonwebtoken 
$ npm install --save-dev @types/jsonwebtoken

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "declaration": true,
    "outDir": "./lib",
    "strict": true
  },
  "include": ["src"],
  "exclude": ["node_modules", "**/__tests__/*"]
}

var jwt = require('jsonwebtoken');
import {sign} from "jsonwebtoken";

/**
 * 与えられた値から適当なJWTトークンを作成する
 * @param value 
 */
export const generateSampleJWTToken = (value: number) => {
    const token = sign({value: value}, "aaaaaa");
    console.log(token);
}

$ npx tsc

node_modules/
/lib/

"name": "@YOUR_USERNAME/PACKAGE_NAME",
  "main": "./lib/index.js",
  "types": "./lib/index.d.ts",
  "files": ["lib"],
  "publishConfig": {
    "registry":"https://npm.pkg.github.com/@YOUR_USERNAME"
  },

GithubActionでnpmパッケージを限定公開

$ node -v
v10.19.0

name: "publish-to-private"

on:
  push:
    branches:
      - main

jobs:
  publish-gpr:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v1
        with:
          node-version: 10
          registry-url: https://npm.pkg.github.com/
          scope: '@YOUR_USERNAME'
      - run: npm install
      - run: npx tsc
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

$ git add -all
$ git commit -m "publish"
$ git push

privateパッケージの使用方法

$ mkdir install_demo & cd install_demo
$ npm init -y

@YOUR_USERNAME:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=ACCESS_TOKEN

$ npm install @YOUR_USERNAME/PACKAGE_NAME

import { generateSampleJWTToken } from "@YOUR_USERNAME/PACKAGE_NAME";

generateSampleJWTToken(100);

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ2YWx1ZSI6MTAwLCJpYXQiOjE2MjMyNTc3NzB9.foO7kvBIQBnRpdq1nAqDgn1oCVdQi7LAg7cNwXgjt2k

---

さいごに

参考URL

---

---

---