O que é package.json?

O arquivo package.json é o coração de qualquer projeto Node.js, servindo como um manifesto que define metadados do projeto, dependências, scripts e configuração. Este arquivo JSON informa ao npm (Node Package Manager) e outras ferramentas como lidar com o projeto, quais pacotes instalar e como executar várias tarefas. É obrigatório para publicar pacotes no npm e é o primeiro arquivo que os desenvolvedores examinam ao explorar um projeto Node.js.

Além de listar dependências, package.json controla versionamento semântico, define pontos de entrada, especifica versões compatíveis do Node e pode incluir scripts personalizados para construir, testar e implantar aplicações. Um package.json válido e bem estruturado é essencial para a manutenibilidade e colaboração do projeto.

Descrição da ferramenta

Este validador online de package.json verifica seu arquivo package.json quanto à correção, conformidade com especificações npm e melhores práticas. Cole o conteúdo do seu package.json para receber feedback imediato sobre erros, avisos e recomendações de melhoria.

Exemplos

Sintaxe JSON inválida:

{
  "name": "my-package",
  "version": "1.0.0" // Comentários não permitidos
}

Erro: JSON não suporta comentários; Resulta em erro de análise.

Campos obrigatórios ausentes:

{
  "description": "Um pacote sem nome ou versão"
}

Erro: Campos obrigatórios ausentes "name" e "version".

Formato de versão inválido:

{
  "name": "my-package",
  "version": "1.0"
}

Aviso: A versão deve seguir versionamento semântico (por exemplo, "1.0.0").

Recursos

  • Validação em tempo real da sintaxe e estrutura do package.json
  • Identificação de erros críticos que impedem o funcionamento do npm
  • Avisos para campos obsoletos ou práticas não padrão
  • Recomendações para melhorar a qualidade do package.json
  • Suporte para configurações de pacotes públicos e privados

Casos de uso

Validação pré-publicação: Verifique se seu package.json está sem erros antes de publicar no npm para evitar rejeição ou problemas de instalação.

Auditoria de dependências: Verifique arquivos package.json de outros projetos para entender sua estrutura e identificar possíveis problemas de configuração.

Aprendizado e depuração: Solucione erros de instalação do npm validando a estrutura do package.json quando as mensagens de erro não forem claras.