Como criar e publicar seu primeiro pacote NPM privado

Neste artigo, quero mostrar como podemos criar facilmente nosso primeiro . pacote npm privado Vamos criar e publicar um pacote privado no , portanto, certifique-se de conhecer os pré- antes de iniciar este artigo. Então vamos começar. GitHub requisitos Pré-requisitos: crie uma conta no ( ) GitHub se ainda não tiver leia o artigo Como configurar um Node Express com TypeScript leia o artigo ( ) How to Setup a CI CD Pipeline From Scratch with GitHub Actions recomendo fortemente que você leia este artigo para entender como o GitHub Actions funciona se você não estiver familiarizado com o GitHub Actions O que são pacotes npm privados e onde podem ser usados? Com pacotes npm privados, você pode hospedar código que só é visível para você e para aqueles com acesso, permitindo que você gerencie e use código privado juntamente com código público em seus projetos. Estrutura do Projeto math-lib/ --.github/ --workflows/ --main.yml --build/ this is autogenerated folder --src/ --app.ts --types/ --index.d.ts --.gitignore --package.json --tsconfig.json Construindo um pacote npm privado Parte 1: inicie um projeto Node.js com TypeScript. Etapa 1: Observação: você pode aprender como fazer isso seguindo este artigo Como configurar um Node Express com TypeScript ou simplesmente clonar este repositório https://github.com/YuraAbharian/node-express-typescript agora vamos criar fluxos de trabalho do GitHub Actions. Etapa 2: Crie um diretório .github/workflows No diretório , crie um arquivo .github/workflows main.yml Você pode se familiarizar com os fluxos de trabalho do GitHub Actions seguindo este artigo How to Setup a CI CD Pipeline From Scratch with GitHub Vamos adicionar algumas configurações: 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 Lembre-se falaremos mais sobre isso um pouco mais tarde de GITHUB_TOKEN, Vamos criar/atualizar o arquivo Passo 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; } Agora precisamos declarar um módulo para nosso pacote Passo 4: Crie um diretório de na raiz do seu projeto types Crie um arquivo no diretório de index.d.ts types Adicionar tipos de declaração 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; } Observação: - é seu nome de usuário do github GITHUB_USERNAME - é o nome do seu pacote particular PACKAGE_NAME Exemplo: "@yuraabharian/math-lib" vamos trabalhar no arquivo package.json Etapa 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" } } Exemplo: git://github.com/yuraabharian/math-lib.git (este será um link para seu repositório GitHub) Observação: esses campos @GITHUB_USERNAME/PACKAGE_NAME são os mesmos da Etapa 4 vamos configurar nosso ambiente de repositório antes de enviar o código Etapa 6: No eu pedi para você lembrar do porque essa variável é muito importante. Passo 2 GITHUB_TOKEN Acesse o GitHub Repository - Settings vá para Etapa 7: Secrets abertas Etapa 8: Actions Clique New repository secret Siga por este link para gerar um novo token. Necessário: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token . Nota: Salve o em outro lugar porque precisaremos deles na Parte 2 deste artigo GITHUB_TOKEN acesso Nota: Conceda apenas write:packages para este token agora vamos enviar nosso código para o Etapa 9: GitHub abra o e você verá que seu pacote foi implantado Etapa 10: Repositório → Ações Para encontrar seu pacote, acesse seu Etapa 11: perfil do GitHub → Pacotes Conclusão da primeira parte: neste ponto você deve ver seu pacote implantado Na segunda parte deste artigo, aprenderemos como instalar um pacote privado porque requer algumas ações, além . npm install package Instalação e Teste Parte 2: configurar o projeto Node.js Etapa 1: você pode ver como fazer isso na Observação: Parte 1 → Etapa 1 Em seguida, na raiz do projeto, intsall seu pacote. O link para o seu pacote você pode pegar pelo (este é o nome do seu pacote) Passo 2: perfil do GitHub → Packages → math-lib Agora vá para o arquivo src/app.ts e atualize-o Passo 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); }); Lembre-se de que estou importando math-lib do meu repositório @yuraabharian/math-lib para fazer seu modelo parecer @GITHUB_USERNAME/PACKAGE_NAME Nota: execute seu projeto Etapa 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á para o seu navegador e abra Passo 5 http://localhost:3001/sum Isso funciona, então agora vamos testar todos os métodos: http://localhost:3001/multiple http://localhost:3001/menos http://localhost:3001/divide Neste artigo, criamos e testamos seu primeiro pacote npm privado, espero que tenha gostado do meu artigo. Se você tiver alguma dúvida, pode entrar em contato comigo por e-mail, LinkedIn ou nos comentários. Muitas felicidades Resumo: