Como publicar pacote npm
Abraão Moreira
Posted on August 31, 2021
Como todo desenvolvedor eu construí uma biblioteca relativamente grande e crescente de funções comuns para o meu trabalho, essa biblioteca vinha ajudando muito na minha vida como desenvolvedor, mas com o uso em vários projetos diferentes e a biblioteca mudando constantemente, começaram a surgir problemas de versionamento dificultando a manutenção, foi então que tive a ideia de utilizar uma tecnologia muito popular no desenvolvimento web, então decidi publicar o meu primeiro pacote npm.
Embora a tecnologia que utilizo, o mql5, seja muito alheia ao Node, npm e ao Javascript, ainda é possível utilizar o gerenciador de pacotes para administrar as versões da biblioteca nos meus projetos.
Requisitos
Node e npm
Antes de tudo é preciso ter o Node e o npm instalados, ambos podem ser instalados seguindo o tutorial dinsponível no link, ou utilizando o gerenciador de pacotes preferido do seu sistema, no caso do Windows eu gosto bastante do Chocolatey:
choco install nodejs
Conta npm
Será preciso também ter uma conta no site da npm, que pode ser criada no link.
Publicando
- Primeiro será preciso iniciar o pacote npm, dentro da pasta com os arquivos executar o seguinte comando:
npm init
- Configurar o arquivo gerado
package.json
, como no exemplo, acrescente os scripts necessários, os urls do repositório, a homepage e as tags:
{
"name": "mql-simplify",
"version": "1.1.2",
"description": "MQL5 library that was born to simplify",
"main": "index.js",
"directories": {
"doc": "docs"
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"compile": "@powershell -NoProfile -ExecutionPolicy Unrestricted -Command ./compile.ps1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/HommaTech/mql-simplify.git"
},
"keywords": ["mql5", "mql", "metatrader"],
"author": "",
"license": "ISC",
"bugs": {
"url": "https://github.com/HommaTech/mql-simplify/issues"
},
"homepage": "simplify.homma.tech"
}
- Logar na conta npm que foi criada nos passos anteriores utilizando o seguinte comando:
npm login
- Logado na conta npm basta publicar:
npm publish
Agora o seu pacote já está no npm acessível e com acesso ao sistema de versionamento.
Foi uma solução simples e que resolveu perfeitamente o meu problema, vai lá dar uma olhadinha no meu pacote, o mql-simplify.
Posted on August 31, 2021
Join Our Newsletter. No Spam, Only the good stuff.
Sign up to receive the latest update from our blog.