Git Product home page Git Product logo

npm-link-boilerplate's Introduction

Table of Contents

Exemplo rápido de uso do npm link

Estrutura de pastas e seus arquivos propostos

Estrutura de Arquivos

  • app.js: Onde está escrito o teste de uso dos nossos pacotes
  • package.json: Configuração do nosso ambiente de teste
  • /packages: É onde ficam nossos pacotes propostos para irem para o npm, onde vamos desenvolver nossas libs ou components.
  • /packages/super-happy-message/: É onde ficam todos os arquivos necessários para nossa lib ou component funcionar, incluindo sua própria configuração de package.json e seus proprio node_modules caso use dependencias.

Processo para linkar pacotes ao ambiente de teste

No pacote

Para fazer o uso dos pacotes dentro do nosso ambiente de teste, precisamos linkar esses pacotes, o processo é como se fosse instalar um pacote do próprio npm.

Para isso vamos navegar ate a pasta raiz de algum pacote e executar o comando

npm link

Através desse comando o npm cria um link simbólico global para essa pasta, dessa forma conseguimos referenciar esse pacote de qualquer pasta.

No ambiente de teste

Sendo assim, agora podemos navegar ate a raiz do nosso ambiente de teste e executar o comando

npm link super-happy-message

Através desse comando, fariamos o equivalente a instalar esse pacote do npm, uma pasta node_modules será criada mas dentro dela temos apenas pastas que são links simbolicos para dentro da própria pasta de packages onde estamos desenvolvendo.

Bonus: É possivel também usar diretamente o comando npm install /path/to/package mas essa maneira não é a mais recomendada, isso seria mais para caso você queira testar os hooks de pre/post install do ambiente de teste

Nota importante: O npm link funciona em qualquer estrutura de pastas, não precisa seguir essa estrutura. O que temo aqui é só uma proposta para facilitar o entendimento e o desenvolvimento caso seja algo pequeno.

Usar nossas libs e rodar o projeto

Feito os passos anteriores podemos importar dentro do arquivo app.js as libs que estamos desenvolvendo dentro da pasta de pacotes, usar elas e rodar nosso app através do comando node app.js. O resultado esperado é esse:

Resultado

Links úteis

Repositório criado e expirado no artigo "Creating your first npm package" do Dan Vega.

npm-link-boilerplate's People

Contributors

viniciuslagedo avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.