Como publicar pacotes na plataforma NPM

O post tem como objetivo ensinar a maneira correta de publicar os pacotes desenvolvidos no repositório global npmjs.com, mais conhecido como NPM.

Como publicar pacotes na plataforma NPM

Antes de demonstrarmos como publicar um pacote no NPM vamos primeiramente abordar alguns conceitos como, o que é NPM e como se cadastrar na plataforma.

O que é NPM

NPM (Node Package Manager) é um gerenciador de pacotes para Javascript que permite você compartilhar seu código fonte com o mundo. Com ele é possível, instalar, atualizar, controlar versões e dependências de pacotes e também publicar seus pacotes. 

Como se cadastrar na plataforma

Para publicar um pacote primeiramente é necessário que você se cadastre na plataforma.

O cadastro pode ser efetuado via linha de comando ou site. Em ambos os processo você deverá confirmar abrir sua caixa de e-mail e confirmar seu cadastro posteriormente.

Cadastrando por linha de comando

Para se cadastrar via linha de comando basta abrir o terminal e digitar (Precisa ter o Node.JS instalado no PC):

npm adduser

Após executar o comando, basta preencher as informações solicitadas e pronto.

Cadastrando pelo site

A outra forma de se cadastrar é pelo site. Basta acessar o site e preencher o formulário de cadastro.

Como publicar na plataforma NPM

Para que você possa publicar um pacote é necessário que você esteja logado em sua conta a partir de seu computador, para isso execute:

npm login

Você terá que informar o login e senha, e pronto agora você pode publicar seus pacotes nodejs.

Para publicar seus pacotes da forma correta é necessário configurar o arquivo package.json da forma correta. Veja abaixo um exemplo para este arquivo:

{
  "name": "meu-pacote",
  "description": "Descrição sobre o pacote",
  "readmeFilename": "README.md" ,
  "keywords": [
    "minhas",
    "palavras",
    "chaves"
  ],
  "tags": [
    "minhas",
    "tags"
  ],
  "version": "0.0.1",
  "author": {
    "name": "Jayr Alencar",
    "email": "jayralencarpereira@gmail.com",
    "homepage": "http://www.jayralencar.com.br"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/JayrAlencar/sqlite-cipher.js"
  },
  "dependencies":{
    "sql.js":"0.2.0",
    "crypto-js":"3.1.5"
  },
  "license": "MIT",
  "engines": {
    "node": ">=0.8.0"
  },
  "main": "index.js"
}

Para criar o arquivo de configuração basta esta na pasta do seu projeto e digitar:

npm init

Publicando

Para publicar você só precisa estar na pasta do seu projeto e executar:

npm publish

Para testar instale seu pacote usando:

npm install meu-pacote

Como excluir um pacote da plataforma

Caso você tenha publicado seu pacote em menos de 72 horas, você pode remover todo o pacote executando o comando:

npm unpublish <nome do pacote> -f

Caso você queria remover apenas uma versão do pacote, basta executar o comando:

npm unpublish <nome do pacote>@<versão do pacote>

Se o tempo de publicação do pacote tiver passado das 72 horas, apenas será possível depreciar o pacote e transferi-lo para a conta do NPM.

Como depreciar o pacote

Para depreciar o pacote execute o comando:

npm deprecate <nome do pacote> "<mensagem de alerta para quem ainda form utilizá-lo>"

Caso você queria depreciar apenas uma versão execute o comando:

npm deprecate <nome do pacote>@<versão> "<mensagem de alerta para quem ainda form utilizá-lo>"

Depois que você depreciou o pacote é possível transferi-lo para o NPM por meio do comando:

npm owner rm <usuário> <pacote>

Dica

Acesse nosso canal no YouTube para visualizar outros vídeos sobre programação, como por exemplo Python, Java e Desenvolvimento de sistemas comerciais utilizando a linguagem C#.

Participe do nosso grupo de estudos no Facebook acessando o link https://www.facebook.com/group

Parte do material foi retirado de Clube dos Geeks.