npm - Node Package Manager, atual versionador de pacotes do M&P, é responsável por gerenciar os pacotes das bibliotecas contidas nessa organização.
Através dele é possível:
- Criar e publicar pacotes
- Realizar download dos pacotes
- Auditar pacotes já instalados (Verifica integridade)
- Versionar pacotes já publicados
- Atualizar pacotes nos scripts
⚠️ Necessita node.js instalado na máquina para o CLI do npm funcionar. Faça o download aqui.
Após realizar a instalação do node.js, crie uma conta no npm, e solicite acesso à organização libs-scripts-mep.
⚠️ Sugestão de nome visando padronização: inv-nome.sobrenome
Com sua conta já criada, abra o terminal em qualquer repositório do sistema, e execute o comando npm adduser
e siga as instruções de login.
- Instalando:
No repositório do script, abra o terminal e execute o comando npm i @libs-scripts-mep/nome-do-pacote
.
Será criado em seu projeto uma pasta chamada node_modules contendo os pacotes instalados, e os arquivos package.json para gerenciar as versões de cada pacote.
A partir daí, basta incluir o caminho da biblioteca no .html do script com a tag
<script src="node_modules/@libs-scripts-mep/nome-do-pacote/nome-do-arquivo.js"></script>
Cada pacote possui sua documentação própria
- Desinstalando:
No repositório do script, abra o terminal e execute o comando npm uninstall @libs-scripts-mep/nome-do-pacote
.
Esse comando removerá o registro do package.json, e deletará a pasta do pacote em node_modules
- Atualizando:
No repositório do script, abra o terminal e execute o comando npm update
para atualizar todos os pacotes que possuem atualização.
⚠️ Certifique-se de que no package.json os pacotes tenham a notação^x.x.x
afim de manter a compatibilidade.
Após realizar o primeiro commit/push do seu novo pacote npm, no repositório do mesmo, abra o terminal e execute o comando:
npm init --scope=libs-scripts-mep
O comando npm init
irá inicializar o processo de registro, gerando ao fim, o arquivo package.json que contém as informações necessárias para publicar o pacote.
A opção --scope
determina a organização a qual o pacote pertence, no caso, libs-scripts-mep.
Ainda no repositório do pacote criado, execute o comando npm publish --access public
para publicar no pacote.
Nesse momento, ele estará disponível em libs-scripts-mep.
- Realize um commit contendo as alterações na sua biblioteca, para que seja possível realizar o versionamento.
- Abra o terminal no repositório do pacote e execute o comando
npm version x.x.x
, sendox.x.x
sua nova versão. O comando fará duas coisas: - Finalmente, execute o comando
npm publish --access public
para publicar a nova versão no servidor npm.
A partir desse momento, qualquer script que contenha esse pacote, se utilizado o comando npm update
, receberá a nova versão, desde que sua politica de atualização permita.
Após realizar a publicação no npm, crie uma release contendo o mesmo nome da versão no respectivo repositório git, como nas imagens a seguir.