この記事では、最初の を簡単に作成する方法を示したいと思います。 プライベート npm パッケージ プライベート パッケージを作成し で公開する予定なので、この記事を開始する前に を理解していることを確認してください。それでは始めましょう。 て GitHub 前提条件 前提条件:   アカウントを作成します ( ) GitHub まだ持っていない場合   の記事を読む TypeScript を使用して Node Express をセットアップする方法 )。 GitHub Actions を使用して最初から CI CD パイプラインをセットアップする方法の記事を読んでください (GitHub Actions に慣れていない場合は、この記事を読んで GitHub Actions の仕組みを理解することを強くお勧めします プライベート npm パッケージとは何ですか? どこで使用できますか? プライベート npm パッケージを使用すると、自分とアクセスできる人だけが見ることができるコードをホストできるため、プロジェクトでパブリック コードと一緒にプライベート コードを管理および使用できます。 プロジェクトの構造 math-lib/ --.github/ --workflows/ --main.yml --build/ this is autogenerated folder --src/ --app.ts --types/ --index.d.ts --.gitignore --package.json --tsconfig.json プライベート npm パッケージのビルド パート 1:  TypeScript を使用して Node.js プロジェクトを開始します。 ステップ 1: に従って学習するか、 注: これを行う方法については、この記事 How to Setup a Node Express with TypeScript このレポを複製するだけです https://github.com/YuraAbharian/node-express-typescript それでは、GitHub Actions ワークフローを作成しましょう。 ステップ 2:   ディレクトリを作成する .github/workflows ディレクトリで、  ファイルを作成します。 .github/workflows main.yml この記事「  に従って、GitHub Actions ワークフローに慣れることができます。 How to Setup a CI CD Pipeline From Scratch with GitHub」 いくつかの設定を追加しましょう:   name: Node.js Private Package on: push: branches: - master jobs: publish-gpr: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-node@v2 with: node-version: '14.x' registry-url: 'https://npm.pkg.github.com/' - run: npm install - run: npm run build - run: npm publish env: NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}   : 注 を覚えておいてください。これについては後で詳しく説明します。 GITHUB_TOKEN   ファイルを作成/更新しましょう ステップ 3: src/app.ts export function sum(a: number, b: number): number { return a + b; } export function minus(a: number, b: number): number { return a - b; } export function divide(a: number, b: number): number { return a / b; } export function multiple(a: number, b: number): number { return a * b; } パッケージのモジュールを宣言する必要があります ステップ 4: プロジェクトのルートに ディレクトリを作成します types ディレクトリに ファイルを作成します。 types index.d.ts このモジュールの宣言型を追加します declare module "@GITHUB_USERNAME/PACKAGE_NAME" { function sum(a: number, b: number): number; function minus(a: number, b: number): number; function divide(a: number, b: number): number; function multiple(a: number, b: number): number; } ノート：   -  はあなたの github ユーザー名です GITHUB_USERNAME -  あなたのプライベートパッケージ名です PACKAGE_NAME   例: 「@yuraabharian/math-lib」  package.json ファイルに取り組みましょう ステップ 5: { "name": "@GITHUB_USERNAME/PACKAGE_NAME", "version": "1.0.0", "description": "", "main": "./build/app.js", "author": "", "license": "ISC", "types": "./types/index.d.ts", "publishConfig": { "registry": "https://npm.pkg.github.com/" }, "repository": { "url": "git://github.com/GITHUB_USERNAME/PACKAGE_NAME.git" }, "scripts": { "build": "npx tsc" }, "devDependencies": { "@types/node": "^18.0.0", "typescript": "^4.7.4" } }   例: git://github.com/yuraabharian/math-lib.git (これは GitHub リポジトリへのリンクになります) 。 注: これらの @GITHUB_USERNAME/PACKAGE_NAME フィールドは、 と同じです 手順 4 コードをプッシュする前にリポジトリ環境を構成しましょう ステップ 6: で、  を覚えておくようにお願いしました。この変数は非常に重要だからです。 ステップ 2 GITHUB_TOKEN     GitHub Repository - Settings 次に、  に移動します ステップ 7: Secrets   開く ステップ 8: Actions [  クリックします。  New repository secret このリンク に従って、新しいトークンを生成します。 必須: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token 。 注: この記事のパート 2 で必要になるため、  を別の場所に保存します GITHUB_TOKEN は アクセス権 を付与します 注: このトークンに write:packages のみ コードを にプッシュしましょう ステップ 9: GitHub を開くと、パッケージがデプロイされていることがわかります。  ステップ 10: リポジトリ → アクション パッケージを見つけるには、  に移動します。  ステップ 11: GitHub プロファイル → パッケージ 最初の部分の結論: この時点で、パッケージがデプロイされていることがわかります。 この記事の第 2 部では、  以外にいくつかのアクションが必要なため、プライベート パッケージをインストールする方法を学習します。 npm install package インストールとテスト パート 2:  Node.js プロジェクトをセットアップする ステップ 1: その方法は、 で確認できます。 注: パート 1 → ステップ 1 次に、プロジェクトのルートでパッケージをすべてインストールします。  取得できるパッケージへのリンク (これがパッケージ名です)  ステップ 2: GitHub プロファイル → Packages → math-lib で  src/app.ts ファイルに移動して更新します ステップ 3: import express, {Application, Request, Response} from 'express'; import {sum, minus, multiple, divide} from '@yuraabharian/math-lib'; const app: Application = express(); const PORT: number = 3001; app.use('/sum', (req: Request, res: Response): void => { res.send(`RESULT: ${sum(5, 2)}`, ); }); app.use('/minus', (req: Request, res: Response): void => { res.send(`RESULT: ${minus(2, 2)}`); }); app.use('/multiple', (req: Request, res: Response): void => { res.send(`RESULT: ${multiple(12, 2)}`); }); app.use('/divide', (req: Request, res: Response): void => { res.send(`RESULT: ${divide(10, 2)}`); }); app.listen(PORT, (): void => { console.log('SERVER IS UP ON PORT:', PORT); }); テンプレートを @GITHUB_USERNAME/PACKAGE_NAME のように見せるために、@yuraabharian/math-lib リポジトリから math-lib をインポートしていることに注意してください。 注: プロジェクトを実行する ステップ 4: npm start   node-express-typescript % npm start > express-typescript@1.0.0 start > npx tsc && node build/app.js SERVER IS UP ON PORT: 3001  : ブラウザーに移動し、  を開きます ステップ 5 http://localhost:3001/sum これは機能するので、すべてのメソッドをテストしましょう。     http://localhost:3001/multiple   http://localhost:3001/マイナス     http://localhost:3001/divide この記事では、最初のプライベート npm パッケージを作成してテストしました。記事を楽しんでいただければ幸いです。ご不明な点がございましたら、メール、LinkedIn、またはコメントでご連絡ください。幸運をお祈りしています 概要:

Alongside

2022 - HackerNoon Contributor of the Year - Cicd

2022 - HackerNoon Contributor of the Year - Debugging

2022 - HackerNoon Contributor of the Year - Performance

2022 - HackerNoon Contributor of the Year - Typescript

2022 - No No No Nodejs

Get It Done

Nominated for 2022 - HackerNoon Contributor of the Year - Typescript

Nominated for 2022 - HackerNoon Contributor of the Year - Cicd

Nominated for 2022 - HackerNoon Contributor of the Year - Performance

Nominated for 2022 - HackerNoon Contributor of the Year - Debugging

Nominated for 2022 - No No No Nodejs

このオーディオは、ストーリーの元の言語で制作されています。

長すぎる; 読むには

初めてのプライベート NPM パッケージを作成して公開する方法

初めてのプライベート NPM パッケージを作成して公開する方法

About Author

コメント

ラベル

この記事は

Related Stories

海を航海する: データレイクを使用した本番環境レベルの RAG アプリケーションの開発

AI の力を解き放つ。最先端技術の体系的レビュー: 概要と序論

ユニークなエコシステムを支えるビットコインUTXOのモデル

フロキのヴァルハラがインドのスリランカツアーのアソシエイトスポンサーに加わる

海を航海する: データレイクを使用した本番環境レベルの RAG アプリケーションの開発

AI の力を解き放つ。最先端技術の体系的レビュー: 概要と序論

ユニークなエコシステムを支えるビットコインUTXOのモデル

フロキのヴァルハラがインドのスリランカツアーのアソシエイトスポンサーに加わる

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps