Publicar pacotes no NPM (Node package manager) não é apenas uma forma de compartilhar seu trabalho com outros desenvolvedores, mas também de se destacar na comunidade de desenvolvimento. Imagine criar uma solução reutilizável que possa ser integrada a diversos projetos pelo mundo todo, economizando tempo e esforço de outros programadores.
Neste artigo, você aprenderá, passo a passo, como configurar, publicar e manter seu próprio pacote no NPM, tornando suas contribuições acessíveis e aumentando sua visibilidade como desenvolvedor.
Pré-requisitos
Antes de começar, certifique-se de que tenha:
- O NPM instalado. Você pode baixá-lo em (Node version manager).
- Uma conta criada no para indicar alterações.
description: Uma breve explicação sobre o que o pacote faz.
main: O arquivo do ponto de entrada, por exemplo,index.js.
keywords: Palavras-chave para categorizar e facilitar que outros desenvolvedores encontrem o pacote.
author: Adicione detalhes relevantes do autor.
license: A licença define como o código pode ser usado, modificado e distribuído por outros. A licença mais comum é a MIT, que é permissiva e permite grande liberdade de uso, desde que seja fornecido o aviso de direitos autorais original.
Caso termine as perguntas e o NPM tenha criado o arquivo sem alguma dessas informações, abra o arquivo criado em um editor e adicione o que estiver faltando.
Exemplo:
{
"name": "string-reverser-jm",
"version": "1.0.0",
"description": "A simple utility to reverse strings, useful for demonstrations and small projects.",
"main": "index.js",
"scripts": {
"test": "echo \"No test specified\" && exit 1"
},
"author": "Juliana Macedo <[email protected]> (https://www.starcoders.info)",
"keywords": [
"string",
"reverse",
"utility"
],
"license": "MIT"
}
Escrevendo o código
Crie o arquivo index.js na raiz do projeto.
function reverseString(str) {
if (typeof str !== "string") {
throw new TypeError("Expected a string as input");
}
return str.split("").reverse().join("");
}
module.exports = reverseString;
Testando o pacote
Para testar o pacote antes de publicá-lo, vamos utilizar o comando npm link
No diretório do pacote, execute o comando:
npm link
No projeto onde deseja testar o pacote, execute o comando:
npm link string-reverser-jm
Importe e use o pacote no seu projeto de teste para garantir que está funcionando:
const reverseString = require("string-reverser-jm");
console.log(reverseString("Hello, world!")); // Output: '!dlrow ,olleH'
Para remover os links criados, basta executar o comando npm unlink string-reverser-jm no diretório do projeto de teste e depois npm unlink no diretório do pacote.
Preparando o pacote para publicação
Primeiro, crie um repositório Git para o pacote e vincule-o ao NPM. Isso aumenta a transparência e confiança ao disponibilizar o código-fonte, facilita colaborações e contribuições da comunidade, e permite automação com CI/CD para um gerenciamento e manutenção mais eficientes.
Para vincular ao NPM, copie o endereço https do repositório e adicione-o ao package.json:
{
"name": "string-reverser-jm",
"version": "1.0.0",
"description": "A simple utility to reverse strings, useful for demonstrations and small projects.",
"main": "index.js",
"scripts": {
"test": "echo \"No test specified\" && exit 1"
},
"author": "Juliana Macedo <[email protected]> (https://www.starcoders.info)",
"keywords": [
"string",
"reverse",
"utility"
],
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/Jullymac/string-reverser-jm.git"
}
}
.gitignore: Crie um arquivo.gitignorepara excluir pastas e arquivos, comonode_modulese.env, do versionamento.
.npmignore: Crie um arquivo.npmignorepara especificar quais arquivos e pastas não devem ser incluídos no pacote NPM.
README.md: Crie um arquivo com informações sobre o pacote.
Publicando o pacote
Faça login no NPM usando seus dados de acesso:
npm login
Execute o comando abaixo para publicar o pacote:
npm publish
Pronto, em breve o pacote estará disponível no registro do NPM!
SOCIAL SHARE CARD GENERATOR