Resumo : neste tutorial, você aprenderá como criar um novo pacote e publicá-lo no registro npm.
Publicando seu pacote no npm
Primeiro, você precisa criar uma nova conta visitando a página de inscrição do npmjs.com . As informações importantes são o nome de usuário, senha e e-mail público. Você precisará dessas informações ao publicar seu pacote.
Então, você cria um novo pacote, por exemplo, galaxy-lib
. No galaxy-lib
diretório, você executa o npm init --yes
comando para criar o package.json
arquivo:
npm init --yes
Linguagem de código: Sessão Shell ( shell )
Depois de ter o package.json
arquivo, você pode criar um novo módulo chamado index.js
que possui uma função simples que retorna o número de galáxias:
module.exports.count = function () {
return 1000000;
}
Linguagem de código: JavaScript ( javascript )
Terceiro, para publicar o pacote no npm, no terminal, você usa o npm login
comando:
npm login
Linguagem de código: Sessão Shell ( shell )
Ele solicitará que você insira as seguintes informações: username
, password
e email
.
Finalmente, você executa o npm publish
comando para publicar o galaxy-lib
pacote no registro npm.
npm publish
Linguagem de código: Sessão Shell ( shell )
Se você recebeu um erro após executar o npm publish
comando, é provável que o pacote que você estava publicando já tenha um nome existente. Nesse caso, você precisa alterar o nome do pacote no package.json
arquivo para algo exclusivo.
Usando o pacote publicado
Para usar o galaxy-lib
pacote, você cria um novo projeto Node chamado galaxy-demo
e executa o npm init
comando:
npm init --yes
Linguagem de código: Sessão Shell ( shell )
Para instalar o galaxy-lib
pacote que você publicou, execute o npm install
comando:
npm install galaxy-lib
Linguagem de código: Sessão Shell ( shell )
O seguinte cria app.js
e usa o galaxy-lib
pacote:
const galaxy = require('galaxy-lib');
console.log(galaxy.count());
Linguagem de código: JavaScript ( javascript )
Por fim, execute o app.js
programa usando o seguinte comando:
node app.js
Linguagem de código: Sessão Shell ( shell )
Saída:
1000000
Linguagem de código: Sessão Shell ( shell )
Cancelando a publicação de seu pacote
Depois de publicar um pacote no registro npm, outras pessoas já podem estar usando-o. Portanto, cancelar a publicação de um pacote do registro npm geralmente é considerado um mau comportamento.
Se tiver certeza do que está fazendo, você pode executar o npm unpublish
comando para cancelar a publicação de um pacote:
npm unpublish [<@scope>/]<package_name>[@<version>]
Linguagem de código: HTML, XML ( xml )
O npm unpublish
comando remove a versão do pacote do registro npm, exclui sua entrada e remove o tarball.
Para encorajar outros desenvolvedores a não usarem um pacote ou atualizarem as versões, você deve usar o npm deprecate
comando:
npm deprecate <package_name>[@<version>] <deprecation_message>
Linguagem de código: HTML, XML ( xml )
Este npm deprecate
comando atualiza o registro npm de um pacote e emite um aviso de descontinuação para qualquer pessoa que tentar instalá-lo
Resumo
- Use
npm publish
o comando para publicar seu pacote no registro npm. - Evite usar o comando npm unpublish para remover o pacote publicado do registro npm.
- Use
npm deprecate
o comando para descontinuar um pacote publicado.