Configurar o package.json

  • 4 minutos

Bem-vindo ao mundo da Node.js gerenciamento de projetos com npm e gerenciamento de pacotes. Vamos mergulhar no essencial da embalagem e como ela pode turbinar seu processo de desenvolvimento.

Gestão de Embalagens e Embalagens

NPM, o gerenciador de pacotes padrão para Node.js, é sua arma secreta para incorporar código externo em seus projetos. É como ter um assistente pessoal para ajudá-lo a criar aplicativos com mais rapidez e eficiência.

A embalagem é como embrulhar o seu código para distribuição. Ele agrupa seu código e suas dependências em um pacote que outras pessoas podem instalar e usar facilmente. O gerenciamento de pacotes é a arte de lidar com esses pacotes e envolve:

  • O arquivo package.json , o plano do seu projeto. Ele está repleto de metadados sobre seu projeto e cuida do gerenciamento de dependências e arquivos de pacote.
  • A ferramenta npm CLI, seu faz-tudo pessoal para instalar e gerenciar pacotes do registro npm.
  • O registro npm, um tesouro de pacotes públicos prontos para serem usados em seus projetos.

Crie o seu package.json

Criar um package.json é tão simples quanto executar o npm init comando. Há duas maneiras principais de fazer isso:

  • npm init: Este comando é como um guia amigável, conduzindo-o através de um processo passo-a-passo que pede detalhes sobre o seu projeto, como nome, versão e descrição.
  • npm init -y: Este comando é a versão de trem expresso do npm init. Ele passa pelas perguntas e preenche os valores padrão para você.

Aqui está uma prévia do package.json arquivo que você irá gerar.

{
  "name": "my project",
  "version": "1.0.0",
  "description": "",
  "main": "script.js",
  "dependencies": {},
  "devDependencies": {},
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

Compreender as áreas de arquivo package.json

Pense no package.json arquivo como um baú do tesouro, cheio de pedras preciosas que dão brilho ao seu projeto. Essas gemas são as propriedades no package.json arquivo e se enquadram em três categorias principais:

  • Meta-informação: Estas propriedades são como as joias da coroa, definindo a meta-informação sobre o seu projeto. Eles incluem o nome do projeto, descrição, autor, palavras-chave e muito mais.
  • Dependências: Estas são as moedas de ouro e prata, representando os pacotes que seu projeto usa. As dependencies propriedades e devDependencies guardam esses tesouros. À medida que avançamos, você aprenderá a usar essas propriedades para instalar, atualizar e gerenciar suas dependências.
  • Scripts: Estes são os comandos do terminal que fazem as tarefas do seu projeto acontecerem. Você pode listar scripts para tarefas como iniciar, compilar, testar e fiapos.

Acelere tarefas com scripts

No arquivo package.json , você deve incluir pelo menos quatro scripts comuns:

  • start: Este roteiro dá vida ao seu projeto. Por exemplo, ele pode usar o comando node ./src/index.js.
  • build: Este roteiro prepara seu projeto para sua grande estreia. Ele pode transformar o TypeScript em JavaScript, por exemplo.
  • test: Este script verifica a integridade do seu projeto, normalmente usando um pacote de teste.
  • lint: Este script arruma seu código, verificando problemas de estilo e formatação usando uma ferramenta como ESLint.

Esses nomes de script são como palavras mágicas, universalmente reconhecidas na comunidade de desenvolvedores e essenciais para manter seu projeto organizado.

Padronizar nomes de script

No arquivo package.json, os scripts são definidos com uma ação e um comando:

"scripts" : {
  "<action>" : "<command>"
}

Eis um exemplo:

"scripts" : {
  "start" : "node ./dist/index.js",
  "test": "jest",
  "build": "tsc",
  "lint": "eslint"
}

Executar um script

Para executar um script em um terminal digitando o comando npm run <action>. Por exemplo, npm run lint.

A start ação e test são especiais na medida em que você pode omitir a palavra run no comando. Em vez de inserir o comando npm run start, você pode digitar npm start.

Usar um ambiente de desenvolvimento predefinido

Este módulo de treinamento oferece um contêiner de desenvolvimento, seja em um navegador ou para seu computador local. Este contêiner fornece todo o ambiente necessário para que você possa usar este módulo de treinamento sem ter que instalar um IDE ou Node.js. Você não precisa saber nada sobre o contêiner para concluir este módulo de treinamento.