Configuração do npm com o CodeCatalyst Instalação de pacotes do npm de um repositório de pacotes do CodeCatalyst Instalação de pacotes do npm do npmjs por meio do CodeCatalyst Publicação de pacotes do npm no repositório de pacotes do CodeCatalyst Suporte para comandos npm

Configuração e uso de npm

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

Sumário

Configuração do npm com o CodeCatalyst

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

Como conectar o `npm` ao repositório de pacotes do CodeCatalyst

Abra o console do CodeCatalyst em https://codecatalyst.aws/.
Navegue até o projeto.
No painel de navegação, selecione Packages (pacotes).
Escolha o repositório de pacotes na lista.
Selecione Conectar ao repositório.
Em Detalhes da configuração, no Cliente do Package Manager, selecione Cliente do npm.
Escolha o sistema operacional para ver as etapas de configuração correspondentes.
É necessário um token de acesso pessoal (PAT) para autenticar o npm com o CodeCatalyst. Se você já possui um token, poderá usá-lo. Caso contrário, você pode criar um usando as etapas a seguir.
1. (Opcional): atualize o Nome do PAT e a Data de expiração.
2. Selecione Criar token.
3. Copie e guarde o PAT em um local seguro.
  
  Atenção
  Você não poderá ver ou copiar 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.
Execute os comandos a seguir no diretório raiz do projeto para configurar o npm com seu repositório de pacotes. Os comandos farão o seguinte:
- Crie um arquivo .npmrc 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 arquivo .npmrc no nível do projeto.
- Adicione suas credenciais (PAT) ao arquivo .npmrc no nível do usuário.
Substitua os valores a seguir.

nota
Se você estiver copiando as instruções do console, os valores nos comandos a seguir serão atualizados e não precisarão ser alterados.
- Substitua nome de usuário pelo seu nome de usuário do CodeCatalyst.
- Substitua o PAT pelo seu PAT do CodeCatalyst.
- Substitua space_name pelo nome do espaço do CodeCatalyst.
- Substitua proj_name pelo nome do projeto do CodeCatalyst.
- Substitua repo_name pelo nome do seu repositório de pacotes do CodeCatalyst.
```
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 ao CodeCatalyst, mesmo para solicitações de GET, defina a variável da configuração always-auth com npm config set da seguinte maneira.
```
npm set //packages.region.codecatalyst.aws/npm/space-name/proj-name/repo-name/:always-auth=true --location project
```

Instalação de pacotes do npm de um repositório de pacotes do CodeCatalyst

Depois de conectar o npm ao seu repositório seguindo as etapas em Configuração do npm com o CodeCatalyst, você pode executar comandos npm no seu repositório.

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


npm install lodash

Instalação de pacotes do npm do npmjs por meio do CodeCatalyst

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

Para instalar pacotes do npmjs

Se você ainda não tiver feito isso, configure o npm com seu repositório de pacotes do CodeCatalyst seguindo as etapas em Configuração do npm com o CodeCatalyst.
Confira se seu repositório adicionou o repositório de gateway, npm-public-registry-gateway, como uma conexão upstream. Você pode conferir quais fontes upstream foram adicionadas ou adicionar npm-public-registry-gateway como uma fonte upstream seguindo as instruções em Adição de um repositório upstream e escolhendo o repositório npm-public-registry-gateway.
Instale pacotes com o comando npm install.
```
npm install package_name
```

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

Publicação de pacotes do npm no repositório de pacotes do CodeCatalyst

Depois de concluir Configuração do npm com o CodeCatalyst, você pode executar comandos npm.

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


npm publish

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

Suporte para comandos npm

As seções a seguir resumem os comandos npm compatíveis com os repositórios de pacotes do CodeCatalyst, além dos comandos específicos de listagem que não são compatíveis.

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 os comandos npm em que o cliente npm faz uma ou mais solicitações ao registro no qual foi configurado (por exemplo, npm config set registry). Verificou-se que esses comandos funcionam corretamente quando invocados em um repositório de pacotes do CodeCatalyst.

Comando	Descrição
bugs	Adivinha a localização do URL do rastreador de bugs de um pacote e, depois, 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 do URL de documentação de um pacote e, depois, tenta abri-lo usando o parâmetro de configuração `--browser`.
doctor	Executa um conjunto de verificações para validar que sua instalação do npm possa gerenciar seus pacotes de JavaScript.
install	Instala um pacote.
install-ci-test	Instala um projeto do zero e executa testes. Alias: `npm cit`. Esse comando executa um `npm ci`, seguido imediatamente por um `npm test`.
install-test	Instala o pacote e executa testes. Executa um `npm install`, seguido imediatamente por um `npm 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 URL do repositório de um pacote e, depois, tenta abri-lo usando o parâmetro de configuração `--browser`.
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 e, portanto, o CodeCatalyst não precisa de nada para oferecer suporte a eles.

Comando	Descrição
bin (legado)	Exibe o diretório npm `bin`.
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 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 arquivo `package.json`, a menos que `-g` também 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 scripts anteriores e posteriores associados.
raiz	Imprime o diretório `node_modules` efetivo na 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 comandos npm não são compatíveis com os repositórios de pacotes do CodeCatalyst.

Comando	Descrição	Observações
access	Define o nível de acesso nos pacotes publicados.	O CodeCatalyst usa um modelo de permissão diferente do repositório público npmjs.
adduser	Adiciona uma conta de usuário de registro	O CodeCatalyst usa um modelo de usuário diferente do repositório público npmjs.
audit	Executa uma auditoria de segurança.	Atualmente, o CodeCatalyst não vende dados de vulnerabilidade de segurança.
hook	Gerencia hooks do npm, incluindo adição, remoção, listagem e atualização.	No momento, o CodeCatalyst não é compatível com nenhum mecanismo de notificação de alterações.
login	Autentica um usuário. Este é um alias para `npm adduser`.	O CodeCatalyst usa um modelo de autenticação diferente do repositório público npmjs. Para ter mais informações, consulte Configuração do npm com o CodeCatalyst.
logout	Sai do registro.	O CodeCatalyst usa um modelo de autenticação diferente do repositório público npmjs. Não há como sair de um repositório do CodeCatalyst, 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.	O CodeCatalyst usa um modelo de permissões diferente do repositório público npmjs.
profile	Altera as configurações no seu perfil de registro.	O 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.	O CodeCatalyst não comporta o comando `search`.
star	Marca seus pacotes favoritos.	No momento, o CodeCatalyst não é compatível com nenhum mecanismo de favoritos.
stars	Exibe pacotes marcados como favoritos.	No momento, o CodeCatalyst não é compatível com nenhum mecanismo de favoritos.
team	Gerencia equipes e associações de equipes.	O CodeCatalyst usa um modelo de associação de usuários e grupos diferente do repositório público npmjs.
token	Gerencia seus tokens de autenticação.	O CodeCatalyst usa um modelo diferente para receber tokens de autenticação. Para ter mais informações, consulte Configuração do npm com o CodeCatalyst.
unpublish	Remove um pacote do registro.	O CodeCatalyst não permite a remoção de uma versão de pacote de um repositório usando o cliente npm. É possível excluir um pacote no console.
whoami	Exibe o nome do usuário npm.	O CodeCatalyst usa um modelo de usuário diferente do repositório público npmjs.

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Uso de npm

Tratamento de tags npm