carloshps / BRA-responsive

BRA responsive é um framework front-end para criação de projetos web responsivos e mobile-first.
http://www.braresponsive.com.br
16 stars 2 forks source link

Adicionado package.json para publicação no npm #9

Closed wagoid closed 7 years ago

wagoid commented 7 years ago

Com a configuração atual, você poderá publicar o pacote tanto no npm quanto subir a tag no git com apenas um comando 😃

Para utilizar esse processo de publicação (com apenas um comand), você precisa de alguns pré requisitos:

  1. Você precisa ter o node.js instalado na sua máquina, para poder utilizar o npm https://nodejs.org/en/download/
  2. Criar um usuário no npm: https://www.npmjs.com/signup
  3. Realizar login na sua máquina utilizando as credenciais do npm que você criou (usuário, senha e e-mail). Rodar o seguinte comando no terminal: npm login
  4. Instalar as dependências do projeto: npm install. Esse passo é necessário pois eu adicionei nas dependências do projeto um módulo que faz essas coisas chatas relacionadas a publicação (sobe a tag no git e publica no npm), chamado np

Depois de todos esses passos seguidos, agora você só precisa rodar um comando para publicar: npm run publicar Exemplo de uso do comando: image

Você só tem que escolher qual tipo de versão deseja publicar, de acordo com o semver: major para uma versão que pode quebrar a versão da sua biblioteca (alguma classe foi renomeada); minor para uma melhoria que não quebrou a versão; patch para correções de bug que não quebraram a versão

Assim que esse pull request for aceito, você já pode rodar o comando e escolher a a opção patch, colocando o pacote na versão 0.5.1 🚀

Qualquer dúvida em relação a essas alterações, e se der algum pau na publicação, pode falar que eu ajudo no que for necessário!

carloshps commented 7 years ago

@wagoid , tenho uma imensa dificuldade com tais comandos de prompt, acesso remoto e afins. Tô tentando aqui, mas não tá rolando....rsrsrs

carloshps commented 7 years ago

Show, @wagoid . Acho que deu tudo certo. Li uns tutoriais e docs do npm e "upei" a nova versão 0.5.1. Muito bom isso. Gostei demais. Obrigado mesmo pela força. Coo você acha que poderíamos melhorar o download dos arquivos que são necessários aos usuários, sem inserir os de controle de versão?

wagoid commented 7 years ago

@carloshps que bom que você conseguiu! Então, você pode adicionar o arquivo .npmignore, que funciona como o .gitignore, mas é voltado para o npm. Tudo que você colocar no .npmignore será excluído da publicação 😄 Olha esse link: https://alanhoff.com/posts/nao-jogue-lixo-no-npm.html

Podemos colocar o seguinte no arquivo:

# Ignorando todos os arquivos
*

# Permitindo somente os arquivos necessários
!package.json
!README.md
!CHANGELOG.md
!css/
!icons/
!img/

Se você quiser mais arquivos indo para a versão do npm, basta adicioná-los com uma exclamação antes ("!")

Depois me fala se funcionou 😄

carloshps commented 7 years ago

Massa demais. E como controlo a opção do download aqui no GitHub, quando o usuário clicar em clone or download? Com o gitignore também posso fazer esse controle?

carloshps commented 7 years ago

Outra dúvida: fiz uma atualização, e ao executar o npm run publicar, aparece a seção para o tipo da versão mas dá esse erro: Erro

wagoid commented 7 years ago

No github tem como controlar não :/ E no caso desse erro, é que você tem que dar um commit das suas alterações antes de rodar npm run publicar

carloshps commented 7 years ago

Entendi, valeu!