Neste post, você vai aprender:
- O que é npm
- Como criar um pacote npm
- Como publicar no registro npm
- Como testar o pacote publicado
O que é npm?
O npm facilita o compartilhamento de código reutilizável. Com ele, você instala bibliotecas de terceiros em seus projetos (como Express, React e outras) e também pode publicar seus próprios pacotes para a comunidade.
Pré-requisitos
Antes de começar, você precisa de:
- Node.js instalado (18+ ou superior, LTS recomendado)
- Conta no npmjs.com
Se ainda não tiver conta, crie gratuitamente.
Criando um pacote npm
Vamos criar um pacote simples para calcular o fatorial de um número.
Crie uma pasta do projeto:
mkdir meu-pacote-fatorial
cd meu-pacote-fatorial
Inicialize o projeto:
npm init -y
Isso cria o arquivo package.json.
Edite o package.json:
{
"name": "@seu-usuario/meu-pacote-fatorial",
"version": "1.0.0",
"description": "Um pacote simples para calcular fatorial",
"main": "index.js",
"scripts": {
"test": "node test.js"
},
"author": "Seu Nome",
"license": "MIT"
}
Use seu usuário real no escopo (@seu-usuario) para evitar conflito de nome.
Crie o código principal (index.js):
function fatorial(n) {
if (!Number.isInteger(n) || n < 0) {
throw new Error('Informe um número inteiro maior ou igual a zero.');
}
if (n === 0 || n === 1) {
return 1;
}
return n * fatorial(n - 1);
}
module.exports = fatorial;
Crie um teste simples (test.js):
const fatorial = require('./index');
console.log('Fatorial de 5:', fatorial(5)); // 120
console.log('Fatorial de 0:', fatorial(0)); // 1
Teste localmente:
npm test
Se estiver tudo certo, os resultados serão exibidos no terminal.
Publicando o pacote
Faça login no npm:
npm login
Confirme o usuário autenticado (opcional):
npm whoami
Publique o pacote:
npm publish --access public
Para pacotes com escopo (@usuario/pacote), --access public é importante na primeira publicação.
Usando o pacote publicado
Agora vamos testar o pacote em outro projeto.
Crie um novo projeto de teste:
mkdir teste-pacote
cd teste-pacote
npm init -y
Instale o pacote:
npm install @seu-usuario/meu-pacote-fatorial
Substitua pelo nome real do pacote.
Crie o arquivo app.js:
const fatorial = require('@seu-usuario/meu-pacote-fatorial');
console.log('Testando o pacote:');
console.log('Fatorial de 4:', fatorial(4)); // 24
console.log('Fatorial de 6:', fatorial(6)); // 720
Execute:
node app.js
Pronto! Você criou, publicou e testou seu primeiro pacote npm.
Dicas adicionais
- Sempre aumente a versão antes de republicar (
npm version patch,minoroumajor). - Adicione um
README.mdcom instruções de uso. - Inclua testes automatizados (por exemplo, com Jest ou Vitest).
Você pode conferir o código-fonte completo de exemplo no repositório: meu-pacote-fatorial no GitHub.
Se tiver dúvidas, deixe nos comentários.
]]>
