Configurando e usando o npm

Para usar npm com CodeCatalyst, você deve se conectar npm ao seu repositório de pacotes e fornecer um token de acesso pessoal (PAT) para autenticação. Você pode ver as instruções para se conectar npm ao seu repositório de pacotes no CodeCatalyst console.

Sumário

• Configurando o npm com CodeCatalyst
• Instalando pacotes npm a partir de um repositório de CodeCatalyst pacotes
• Instalando pacotes npm do npmjs por meio de CodeCatalyst
• Publicando pacotes npm em seu repositório de CodeCatalyst pacotes
• Suporte para comandos npm
  • Comandos compatíveis que interagem com um repositório de pacotes
  • Comandos do lado do cliente compatíveis
  • Comandos incompatíveis

Configurando o npm com CodeCatalyst

As instruções a seguir explicam como se autenticar e se conectar npm ao seu repositório de CodeCatalyst pacotes. Para obter mais informações sobre o npm, consulte a documentação oficial do npm.

Para se conectar npm ao seu repositório de CodeCatalyst pacotes

1. Abra o CodeCatalyst console em https://codecatalyst.aws/.

2. Navegue até o projeto.

3. No painel de navegação, selecione Packages (pacotes).

4. Escolha seu repositório de pacotes na lista.

5. Escolha Conectar ao repositório.

6. Em Detalhes da configuração, no cliente do Package Manager, escolha npm client.

7. Escolha seu sistema operacional para ver as etapas de configuração correspondentes.

8. É necessário um token de acesso pessoal (PAT) para autenticar o npm com. CodeCatalyst Se você já tem um token, pode usá-lo. Caso contrário, você pode criar um usando as etapas a seguir.

   1. (Opcional): atualize o PATnome e a data de expiração.

   2. Escolha Criar token.

   3. Copie e guarde o seu PAT em um local seguro.

      Atenção

      Você não poderá ver ou copiar o seu PAT novamente depois de fechar a caixa de diálogo. As credenciais devem ser de curta duração para minimizar o tempo que um invasor pode usar as credenciais após usá-las indevidamente.

9. Execute os comandos a seguir no diretório raiz do seu projeto para configurar o npm com seu repositório de pacotes. Os comandos farão o seguinte:

   • Crie um .npmrc arquivo no nível do projeto se o seu projeto não tiver um.

   • Adicione as informações do endpoint do repositório de pacotes ao seu arquivo no nível do projeto.npmrc.

   • Adicione suas credenciais (PAT) ao seu arquivo em nível de usuário.npmrc.

   Substitua os valores a seguir.

   nota

   Se você estiver copiando as instruções do console, os valores nos comandos a seguir serão atualizados para você e não precisarão ser alterados.

   • Substituir username com seu nome CodeCatalyst de usuário.

   • Substituir PAT com o seu CodeCatalyst PAT.

   • Substituir space_name com o nome CodeCatalyst do seu espaço.

   • Substituir proj_name com o nome CodeCatalyst do seu projeto.

   • Substituir repo_name com o nome CodeCatalyst do repositório do seu pacote.

   npm set registry=https://packages.region.codecatalyst.aws/npm/space-name/proj-name/repo-name/ --location project
   npm set //packages.region.codecatalyst.aws/npm/space-name/proj-name/repo-name/:_authToken=username:PAT

   Para npm 6 ou inferior: para fazer com que o npm sempre passe o token de autenticação para CodeCatalyst, mesmo para GET solicitações, defina a variável de configuração always-auth da seguinte forma. npm config set

   npm set //packages.region.codecatalyst.aws/npm/space-name/proj-name/repo-name/:always-auth=true --location project

Instalando pacotes npm a partir de um repositório de CodeCatalyst pacotes

Depois de conectar o npm ao seu repositório seguindo as etapas emConfigurando o npm com CodeCatalyst, você pode executar npm comandos no seu repositório.

Você pode instalar um pacote npm que esteja no seu repositório de CodeCatalyst pacotes ou em um de seus repositórios upstream com o comando. npm install

npm install lodash

Instalando pacotes npm do npmjs por meio de CodeCatalyst

Você pode instalar pacotes npm do npmjs.com por meio de um repositório configurando o CodeCatalyst repositório com uma conexão upstream com o repositório do gateway conectado ao npmjs.com,. npm-public-registry-gateway Os pacotes instalados a partir do npmjs são ingeridos e armazenados no repositório do gateway e no repositório de pacotes mais distante.

Para instalar pacotes do npmjs

1. Se você ainda não tiver feito isso, configure npm com seu repositório de CodeCatalyst pacotes seguindo as etapas emConfigurando o npm com CodeCatalyst.

2. Verifique se seu repositório adicionou o repositório do gateway, npm-public-registry-gateway, como uma conexão upstream. Você pode verificar quais fontes upstream foram adicionadas ou adicionadas npm-public-registry-gatewaycomo fonte upstream seguindo as instruções Adicionar um repositório upstream e escolhendo o npm-public-registry-gatewayrepositório.

3. Instale pacotes com o npm install comando.

   npm install package_name

Para obter mais informações sobre a solicitação de pacotes de repositórios upstream, consulte. Solicitar uma versão do pacote com repositórios upstream

Publicando pacotes npm em seu repositório de CodeCatalyst pacotes

Depois de concluirConfigurando o npm com CodeCatalyst, você pode executar npm comandos.

Você pode publicar um pacote npm em um repositório de CodeCatalyst pacotes com o npm publish comando.

npm publish

Para obter informações sobre como criar pacotes npm, consulte Criação de módulos Node.js no npm Docs.

Suporte para comandos npm

As seções a seguir resumem os npm comandos que são suportados pelos repositórios de CodeCatalyst pacotes, além de listar comandos específicos que não são suportados.

Tópicos

• Comandos compatíveis que interagem com um repositório de pacotes
• Comandos do lado do cliente compatíveis
• Comandos incompatíveis

Comandos compatíveis que interagem com um repositório de pacotes

Esta seção lista npm os comandos nos quais o npm cliente faz uma ou mais solicitações ao registro no qual está configurado (por exemplo,npm config set registry). Verificou-se que esses comandos funcionam corretamente quando invocados em um repositório de CodeCatalyst pacotes.

Comando	Descrição
bugs	Adivinha a localização do rastreador de bugs de um pacote eURL, em seguida, ele tenta abri-lo.
ci	Instala um projeto do zero.
deprecate	Deprecia uma versão de um pacote.
dist-tag	Modifica as tags de distribuição do pacote.
docs	Adivinha a localização da documentação de um pacote eURL, em seguida, tenta abri-la usando o parâmetro --browser config.
doctor	Executa um conjunto de verificações para validar se sua instalação do npm pode gerenciar seus JavaScript pacotes.
install	Instala um pacote.
install-ci-test	Instala um projeto do zero e executa testes. Alias: npm cit. Esse comando executa umnpm ci, seguido imediatamente por umnpm test.
install-test	Instala o pacote e executa testes. Executa umnpm install, seguido imediatamente por umnpm test.
outdated	Verifica o registro configurado para determinar se algum pacote instalado está desatualizado.
ping	Faz ping no registro npm configurado ou fornecido e verifica a autenticação.
publish	Publica uma versão do pacote no registro.
update	Adivinha a localização do repositório de um pacote eURL, em seguida, tenta abri-lo usando o parâmetro --browser config.
view	Exibe os metadados do pacote. Também pode ser usado para imprimir propriedades de metadados.

Comandos do lado do cliente compatíveis

Esses comandos não exigem nenhuma interação direta com um repositório de pacotes, portanto, CodeCatalyst não exigem nada para suportá-los.

Comando	Descrição
bin (legado)	Exibe o bin diretório npm.
build	Cria um pacote.
cache	Manipula o cache de pacotes.
completion	Ativa o preenchimento de guias em todos os comandos npm.
config	Atualiza o conteúdo do usuário e dos arquivos npmrc globais.
dedupe	Pesquisa a árvore de pacotes local e tenta simplificar a estrutura movendo as dependências mais para cima na árvore, onde elas podem ser compartilhadas com mais eficiência por vários pacotes dependentes.
edit	Edita um pacote instalado. Seleciona uma dependência no diretório de trabalho atual e abre o diretório do pacote no editor padrão.
explore	Navega por um pacote instalado. Gera um subshell no diretório do pacote instalado especificado. Se um comando for especificado, ele será executado no subshell, que será encerrado imediatamente.
help	Recebe ajuda no npm.
help-search	Pesquisa a documentação de ajuda do npm.
init	Cria um arquivo package.json.
link	Vincula simbolicamente um diretório de pacotes.
ls	Lista pacotes instalados.
pack	Cria um tarball a partir de um pacote.
prefix	Exibe um prefixo. Esse é o diretório pai mais próximo que contém um package.json arquivo, a menos que também -g seja especificado.
prune	Remove pacotes que não estão listados na lista de dependências do pacote pai.
rebuild	Executa o comando npm build nas pastas correspondentes.
restart	Executa os scripts de parada, reinicialização e inicialização de um pacote e os pré-scripts e pós-scripts associados.
raiz	Imprime o node_modules diretório efetivo para saída padrão.
run-script	Executa scripts de pacotes arbitrários.
shrinkwrap	Bloqueia as versões de dependência para publicação.
uninstall	Desinstala um pacote.

Comandos incompatíveis

Esses npm comandos não são compatíveis com repositórios de CodeCatalyst pacotes.

Comando	Descrição	Observações
access	Define o nível de acesso nos pacotes publicados.	CodeCatalyst usa um modelo de permissão diferente do repositório público npmjs.
adduser	Adiciona uma conta de usuário de registro	CodeCatalyst usa um modelo de usuário diferente do repositório público npmjs.
audit	Executa uma auditoria de segurança.	CodeCatalyst atualmente não vende dados de vulnerabilidade de segurança.
hook	Gerencia hooks do npm, incluindo adição, remoção, listagem e atualização.	CodeCatalyst atualmente não oferece suporte a nenhum mecanismo de notificação de alterações.
login	Autentica um usuário. Este é um alias para npm adduser.	CodeCatalyst usa um modelo de autenticação diferente do repositório público npmjs. Para obter mais informações, consulte Configurando o npm com CodeCatalyst.
logout	Sai do registro.	CodeCatalyst usa um modelo de autenticação diferente do repositório público npmjs. Não há como sair de um CodeCatalyst repositório, mas os tokens de autenticação expiram após o tempo de expiração configurável. A duração padrão do token é de 12 horas.
owner	Gerencia proprietários de pacotes.	CodeCatalyst usa um modelo de permissões diferente do repositório público npmjs.
profile	Altera as configurações no seu perfil de registro.	CodeCatalyst usa um modelo de usuário diferente do repositório público npmjs.
pesquisa	Pesquisa no registro por pacotes que correspondam aos termos de pesquisa.	CodeCatalyst não suporta o search comando.
star	Marca seus pacotes favoritos.	CodeCatalyst atualmente não suporta nenhum mecanismo de favoritos.
stars	Exibe pacotes marcados como favoritos.	CodeCatalyst atualmente não suporta nenhum mecanismo de favoritos.
team	Gerencia equipes e membros de equipes.	CodeCatalyst usa um modelo de associação de usuário e grupo diferente do repositório público npmjs.
token	Gerencia seus tokens de autenticação.	CodeCatalyst usa um modelo diferente para obter tokens de autenticação. Para obter mais informações, consulte Configurando o npm com CodeCatalyst.
unpublish	Remove um pacote do registro.	CodeCatalyst não suporta a remoção de uma versão de pacote de um repositório usando o cliente npm. Você pode excluir um pacote no console.
whoami	Exibe o nome do usuário npm.	CodeCatalyst usa um modelo de usuário diferente do repositório público npmjs.