Cách tạo và xuất bản gói NPM riêng tư đầu tiên của bạn

Trong bài viết này, tôi muốn giới thiệu cách chúng ta có thể dễ dàng tạo đầu tiên của mình. gói npm riêng tư Chúng tôi sẽ tạo và xuất bản một gói riêng tư trên , vì vậy hãy đảm bảo rằng bạn đã làm quen với các trước khi bắt đầu bài viết này. Vậy hãy bắt đầu. GitHub điều kiện tiên quyết Điều kiện tiên quyết: tạo tài khoản ( ) GitHub nếu bạn chưa có đọc bài viết Cách thiết lập Node Express với TypeScript đọc bài viết ( ) Cách thiết lập đường ống CD CI từ Scratch với GitHub Actions Tôi thực sự khuyên bạn nên đọc bài viết này để hiểu cách hoạt động của GitHub Actions nếu bạn không quen thuộc với GitHub Actions Gói npm riêng tư là gì và nó có thể được sử dụng ở đâu? Với các gói npm riêng tư, bạn có thể lưu trữ mã chỉ hiển thị cho bạn và những người có quyền truy cập, cho phép bạn quản lý và sử dụng mã riêng cùng với mã công khai trong các dự án của mình. Cấu trúc dự án math-lib/ --.github/ --workflows/ --main.yml --build/ this is autogenerated folder --src/ --app.ts --types/ --index.d.ts --.gitignore --package.json --tsconfig.json Xây dựng gói npm riêng Phần 1: Init một dự án Node.js với TypeScript. Bước 1: Lưu ý: Bạn có thể tìm hiểu cách thực hiện việc này bằng cách làm theo bài viết này Cách thiết lập Node Express với TypeScript hoặc bạn có thể sao chép repo này https://github.com/YuraAbharian/node-express-typescript Bây giờ chúng ta hãy tạo dòng công việc GitHub Actions. Bước 2: Tạo .github/workflows Trong thư mục , tạo tệp .github/workflows main.yml Bạn có thể làm quen với quy trình làm việc của GitHub Actions bằng cách làm theo bài viết này Cách thiết lập đường ống CD CI từ Scratch với GitHub Hãy thêm một số cấu hình: 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}} : Lưu ý Hãy nhớ chúng ta sẽ nói thêm về nó sau GITHUB_TOKEN, Hãy tạo / cập nhật tệp Bước 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; } Bây giờ chúng ta cần khai báo một mô-đun cho gói của chúng ta Bước 4: Tạo một thư mục ở thư mục gốc của dự án của bạn types Tạo tệp trong thư mục index.d.ts types Thêm các loại khai báo cho mô-đun này 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; } Ghi chú: - đó là tên người dùng github của bạn GITHUB_USERNAME - đó là tên gói riêng của bạn PACKAGE_NAME Ví dụ: "@ yuraabharian / math-lib" Hãy làm việc trên tệp package.json Bước 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" } } Ví dụ: git: //github.com/yuraabharian/math-lib.git (đây sẽ là liên kết đến kho lưu trữ GitHub của bạn) Lưu ý: Các fieds @ GITHUB_USERNAME / PACKAGE_NAME này giống như ở Bước 4 Hãy cấu hình môi trường kho lưu trữ của chúng tôi trước khi đẩy mã Bước 6: Ở , tôi đã yêu cầu bạn nhớ vì biến này rất quan trọng. Bước 2 GITHUB_TOKEN Đi tới GitHub Repository - Settings Sau đó đi tới Bước 7: Secrets Mở tác Bước 8: Actions Nhấp vào New repository secret Theo liên kết này để tạo mã thông báo mới. Bắt buộc: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token . Lưu ý: Lưu ở nơi khác vì chúng tôi sẽ cần chúng trong Phần 2 của bài viết này GITHUB_TOKEN cung cấp quyền Lưu ý: Chỉ write:packages truy cập cho mã thông báo này Bây giờ hãy đẩy mã của chúng ta lên Bước 9: GitHub Mở và bạn sẽ thấy rằng gói của bạn đã được triển khai Bước 10: Kho lưu trữ → Hành động Để tìm gói của bạn, hãy chuyển đến Bước 11: hồ sơ GitHub của bạn → Gói Kết luận của phần đầu tiên: tại thời điểm này, bạn sẽ thấy gói của mình được triển khai Trong phần thứ hai của bài viết này, chúng ta sẽ tìm hiểu cách cài đặt gói riêng tư vì nó yêu cầu một số hành động, bên cạnh . npm install package Cài đặt và Kiểm tra Phần 2: Thiết lập dự án Node.js Bước 1: Bạn có thể xem cách thực hiện điều đó trong Lưu ý: Phần 1 → Bước 1 Sau đó, tại thư mục gốc của dự án sẽ nhập gói của bạn. Liên kết đến gói của bạn mà bạn có thể sử dụng theo (đây là tên gói của bạn) Bước 2: hồ sơ GitHub → Gói → math-lib Bây giờ hãy truy cập tệp src / app.ts và cập nhật nó Bước 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); }); Hãy nhớ rằng tôi đang nhập math-lib từ kho lưu trữ @ yuraabharian / math-lib của mình để làm cho mẫu của bạn trông giống như @ GITHUB_USERNAME / PACKAGE_NAME Lưu ý: Chạy dự án của bạn Bước 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 : Vào trình duyệt của bạn và mở Bước 5 http: // localhost: 3001 / sum Điều này hoạt động, vì vậy bây giờ hãy kiểm tra tất cả các phương pháp: http: // localhost: 3001 / nhiều http: // localhost: 3001 / trừ http: // localhost: 3001 / split Trong bài viết này, chúng tôi đã tạo và thử nghiệm gói npm riêng tư đầu tiên của bạn, tôi hy vọng bạn thích bài viết của tôi. Nếu bạn có bất kỳ câu hỏi nào, bạn có thể liên hệ với tôi qua email, LinkedIn hoặc trong phần bình luận. Lời chúc tốt nhất Tóm tắt: