Cómo crear y publicar su primer paquete NPM privado

En este artículo, quiero mostrar cómo podemos crear fácilmente nuestro primer . paquete npm privado Vamos a crear y publicar un paquete privado en , así que asegúrese de familiarizarse con los antes de comenzar este artículo. Entonces empecemos. GitHub requisitos previos requisitos previos: crea una cuenta de ( ) GitHub si aún no la tienes lea el artículo Cómo configurar un Node Express con TypeScript lea el artículo ( ) Cómo configurar una canalización de CD de CI desde cero con acciones de GitHub le recomiendo que lea este artículo para comprender cómo funcionan las acciones de GitHub si no está familiarizado con las acciones de GitHub ¿Qué son los paquetes npm privados y dónde se pueden usar? Con paquetes de npm privados, puede alojar código que solo usted y aquellos con acceso pueden ver, lo que le permite administrar y usar código privado junto con código público en sus proyectos. Estructura del proyecto math-lib/ --.github/ --workflows/ --main.yml --build/ this is autogenerated folder --src/ --app.ts --types/ --index.d.ts --.gitignore --package.json --tsconfig.json Creación de un paquete npm privado Parte 1: Inicie un proyecto de Node.js con TypeScript. Paso 1: Nota: Puede aprender cómo hacer esto siguiendo este artículo Cómo configurar un Node Express con TypeScript o simplemente puede clonar este repositorio https://github.com/YuraAbharian/node-express-typescript Ahora vamos a crear flujos de trabajo de GitHub Actions. Paso 2: Crear un directorio .github/workflows En el directorio , cree un archivo .github/workflows main.yml Puede familiarizarse con los flujos de trabajo de GitHub Actions siguiendo este artículo Cómo configurar una canalización de CD de CI desde cero con GitHub Agreguemos algunas configuraciones: 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}} : Nota Recuerde hablaremos más sobre esto un poco más tarde. GITHUB_TOKEN, Vamos a crear/actualizar el archivo Paso 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; } Ahora necesitamos declarar un módulo para nuestro paquete Paso 4: Cree un directorio de en la raíz de su proyecto types Cree un archivo en el directorio de index.d.ts types Agregar tipos de declaración para este módulo 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; } Nota: - es tu nombre de usuario de github GITHUB_USERNAME - es el nombre de tu paquete privado PACKAGE_NAME Ejemplo: "@yuraabharian/math-lib" Trabajemos en el archivo package.json Paso 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" } } Ejemplo: git://github.com/yuraabharian/math-lib.git (este será un enlace a su repositorio de GitHub) Nota: estos campos @GITHUB_USERNAME/PACKAGE_NAME son los mismos que en el Paso 4 configuremos nuestro entorno de repositorio antes de enviar el código Paso 6: En el te pedí que recordaras porque esta variable es muy importante. Paso 2 GITHUB_TOKEN Ir al GitHub Repository - Settings luego ve a Paso 7: Secrets abiertas Paso 8: Actions Haz clic New repository secret siga este enlace para generar un nuevo token. Obligatorio: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token . Nota: Guarde el en otro lugar porque los necesitaremos en la Parte 2 de este artículo GITHUB_TOKEN acceso de Nota: Otorgue solo write:packages para este token ahora envíemos nuestro código a Paso 9: GitHub Abra el y debería ver que su paquete ha sido implementado Paso 10: Repositorio → Acciones Para encontrar su paquete, vaya a su Paso 11: perfil de GitHub → Paquetes Conclusión de la primera parte: en este punto debería ver su paquete implementado En la segunda parte de este artículo, aprenderemos cómo instalar un paquete privado porque requiere algunas acciones, además de . npm install package Instalación y prueba Parte 2: configurar el proyecto Node.js Paso 1: Puede ver cómo hacerlo en la Nota: Parte 1 → Paso 1 Luego, en la raíz del proyecto, instale todo su paquete. Puede tomar el enlace a su paquete mediante el (este es el nombre de su paquete) Paso 2: perfil de GitHub → Paquetes → math-lib ahora ve al archivo src/app.ts y actualízalo Paso 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); }); tenga en cuenta que estoy importando math-lib desde mi repositorio @yuraabharian/math-lib para que su plantilla se vea como @GITHUB_USERNAME/PACKAGE_NAME Nota: Ejecute su proyecto Paso 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 : Vaya a su navegador y abra Paso 5 http://localhost:3001/sum Esto funciona, así que ahora probemos todos los métodos: http://localhost:3001/múltiple http://localhost:3001/menos http://localhost:3001/dividir en este artículo, creamos y probamos su primer paquete npm privado, espero que haya disfrutado mi artículo. Si tiene alguna pregunta, puede contactarme por correo electrónico, LinkedIn o en los comentarios. Los mejores deseos Resumen: