Configuración y uso de npm

Para usarlo npm con CodeCatalyst, debe conectarse npm al repositorio de paquetes y proporcionar un token de acceso personal (PAT) para la autenticación. Puedes ver las instrucciones para conectarte npm al repositorio de paquetes en la CodeCatalyst consola.

Contenido

• Configurar npm con CodeCatalyst
• Instalación de paquetes npm desde un repositorio de paquetes CodeCatalyst
• Instalación de paquetes npm desde npmjs mediante CodeCatalyst
• Publicar paquetes npm en su repositorio de paquetes CodeCatalyst
• soporte de comandos npm
  • Comandos compatibles que interactúan con un repositorio de paquetes
  • Comandos del lado del cliente compatibles
  • Comandos admitidos

Configurar npm con CodeCatalyst

Las siguientes instrucciones explican cómo autenticarse y conectarse npm a su repositorio de CodeCatalyst paquetes. Para obtener más información sobre npm, consulta la documentación oficial de npm.

Para conectarse npm a su repositorio de paquetes CodeCatalyst

1. Abra la CodeCatalyst consola en https://codecatalyst.aws/.

2. Vaya a su proyecto.

3. En el panel de navegación, elija Packages (Paquetes).

4. Elija su repositorio de paquetes de la lista.

5. Selecciona Conectar al repositorio.

6. En Detalles de configuración, en Package manager client, elija npm client.

7. Elija su sistema operativo para ver los pasos de configuración correspondientes.

8. Se requiere un token de acceso personal (PAT) para autenticar npm. CodeCatalyst Si ya tienes un token, puedes usarlo. Si no es así, puedes crear uno siguiendo estos pasos.

   1. (Opcional): actualice el PATnombre y la fecha de caducidad.

   2. Selecciona Crear token.

   3. Cópialo y PAT guárdalo en un lugar seguro.

      aviso

      No podrá PAT volver a verla ni copiarla después de cerrar el cuadro de diálogo. Las credenciales deben ser de corta duración para minimizar el tiempo que un atacante puede utilizarlas tras apropiarse indebidamente de ellas.

9. Ejecute los siguientes comandos desde el directorio raíz de su proyecto para configurar npm con su repositorio de paquetes. Los comandos harán lo siguiente:

   • Cree un .npmrc archivo a nivel de proyecto si su proyecto no tiene uno.

   • Añada la información de punto final del repositorio de paquetes a su archivo a nivel de proyecto.npmrc.

   • Añada sus credenciales (PAT) a su archivo a nivel de usuario.npmrc.

   Sustituya los valores siguientes.

   nota

   Si está copiando las instrucciones de la consola, los valores de los siguientes comandos se actualizan automáticamente y no es necesario cambiarlos.

   • Reemplazar username con su nombre CodeCatalyst de usuario.

   • Reemplazar PAT con tu CodeCatalyst PAT.

   • Reemplazar space_name con el nombre de tu CodeCatalyst espacio.

   • Reemplazar proj_name con el nombre de tu CodeCatalyst proyecto.

   • Reemplazar repo_name con el nombre CodeCatalyst del repositorio de paquetes.

   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 o versiones anteriores: para que npm siempre pase el token de autenticación CodeCatalyst, incluso en el caso de GET solicitudes, defina la variable de configuración always-auth de la siguiente manera. npm config set

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

Instalación de paquetes npm desde un repositorio de paquetes CodeCatalyst

Después de conectar npm a tu repositorio siguiendo los pasos que se indicanConfigurar npm con CodeCatalyst, puedes ejecutar npm comandos en tu repositorio.

Puedes instalar un paquete npm que esté en tu repositorio de CodeCatalyst paquetes o en uno de sus repositorios anteriores con el comando. npm install

npm install lodash

Instalación de paquetes npm desde npmjs mediante CodeCatalyst

Puede instalar paquetes npm desde npmjs.com a través de un repositorio configurándolo con una conexión ascendente al CodeCatalyst repositorio de puerta de enlace conectado a npmjs.com,. npm-public-registry-gateway Los paquetes instalados desde npmjs se ingieren y almacenan en el repositorio de la puerta de enlace y en el repositorio de paquetes descendente más alejado.

Para instalar paquetes desde npmjs

1. Si aún no lo ha hecho, configúrelo npm con su repositorio de CodeCatalyst paquetes siguiendo los pasos que se indican en. Configurar npm con CodeCatalyst

2. Comprueba que tu repositorio haya agregado el repositorio de puerta de enlace npm-public-registry-gateway,, como conexión ascendente. Puede comprobar qué fuentes ascendentes se añaden o añadir npm-public-registry-gatewaycomo fuente ascendente siguiendo las instrucciones que aparecen en el repositorio Añadir un repositorio ascendente y seleccionándolo. npm-public-registry-gateway

3. Instale los paquetes con el npm install comando.

   npm install package_name

Para obtener más información sobre la solicitud de paquetes desde los repositorios originales, consulte. Solicitar una versión de paquete con repositorios ascendentes

Publicar paquetes npm en su repositorio de paquetes CodeCatalyst

Una vez que haya terminadoConfigurar npm con CodeCatalyst, puede ejecutar npm los comandos.

Puede publicar un paquete npm en un repositorio de CodeCatalyst paquetes con el npm publish comando.

npm publish

Para obtener información sobre cómo crear paquetes npm, consulte Creación de módulos de Node.js en npm Docs.

soporte de comandos npm

Las siguientes secciones resumen los npm comandos que admiten los repositorios de CodeCatalyst paquetes, además de enumerar los comandos específicos que no son compatibles.

Temas

• Comandos compatibles que interactúan con un repositorio de paquetes
• Comandos del lado del cliente compatibles
• Comandos admitidos

Comandos compatibles que interactúan con un repositorio de paquetes

En esta sección se enumeran los npm comandos en los que el npm cliente realiza una o más solicitudes al registro para el que está configurado (por ejemplo,npm config set registry). Se ha comprobado que estos comandos funcionan correctamente cuando se invocan en un repositorio de CodeCatalyst paquetes.

Comando	Descripción
bugs	Investiga la ubicación del rastreador de errores de un paquete yURL, a continuación, intenta abrirlo.
ci	Instala un proyecto desde cero.
deprecate	Deja en desuso una versión de un paquete.
dist-tag	Modifica las etiquetas de distribución de paquetes.
docs	Investiga la ubicación de la documentación de un paquete yURL, a continuación, intenta abrirla mediante el parámetro --browser config.
doctor	Ejecuta un conjunto de comprobaciones para validar que su instalación de npm pueda administrar sus JavaScript paquetes.
install	Instala un paquete.
install-ci-test	Instala un proyecto desde cero y ejecuta pruebas. Alias: npm cit. Este comando ejecuta unnpm ci, seguido inmediatamente de unnpm test.
install-test	Instala el paquete y ejecuta las pruebas. Ejecuta unnpm install, seguido inmediatamente de unnpm test.
outdated	Comprueba el registro configurado para determinar si algún paquete instalado está desactualizado.
ping	Hace ping al registro npm configurado o dado y verifica la autenticación.
publish	Publica una versión del paquete en el registro.
update	Averigua la ubicación del repositorio de un paquete yURL, a continuación, intenta abrirlo mediante el parámetro --browser config.
view	Muestra metadatos del paquete. También se puede usar para imprimir las propiedades de los metadatos.

Comandos del lado del cliente compatibles

Estos comandos no requieren ninguna interacción directa con un repositorio de paquetes, por lo que CodeCatalyst no requieren nada que los respalde.

Comando	Descripción
bin (heredado)	Muestra el bin directorio npm.
build	Crea un paquete.
cache	Manipula la caché de paquetes.
completion	Permite completar tabulaciones en todos los comandos de npm.
config	Actualiza el contenido de los archivos npmrc globales y de usuario.
dedupe	Busca en el árbol de paquetes local e intenta simplificar la estructura moviendo las dependencias más arriba en el árbol, de forma que puedan compartirse más eficazmente entre varios paquetes dependientes.
edit	Edita un paquete instalado. Selecciona una dependencia en el directorio de trabajo actual y abre el directorio del paquete en el editor predeterminado.
explore	Busca un paquete instalado. Genera un subshell en el directorio del paquete instalado especificado. Si se especifica un comando, se ejecuta en la subshell, que se cierra inmediatamente.
help	Obtiene ayuda sobre npm.
help-search	Busca en la documentación de ayuda de npm.
init	Crea un archivo package.json.
link	Enlaza simbólicamente un directorio de paquetes.
ls	Muestra los paquetes instalados.
pack	Crea un tarball a partir de un paquete.
prefix	Muestra un prefijo. Este es el directorio principal más cercano que contiene un package.json archivo, a menos que también -g se especifique.
prune	Elimina los paquetes que no figuran en la lista de dependencias del paquete principal.
rebuild	Ejecuta el comando npm build en las carpetas coincidentes.
restart	Ejecuta los scripts de parada, reinicio e inicio de un paquete y los scripts previos y posteriores asociados.
root	Imprime el node_modules directorio efectivo para que quede estándar.
run-script	Ejecuta scripts de paquetes arbitrarios.
shrinkwrap	Bloquea las versiones dependientes para su publicación.
uninstall	Desinsta un paquete.

Comandos admitidos

Los repositorios de CodeCatalyst paquetes no admiten estos npm comandos.

Comando	Descripción	Notas
access	Establece el nivel de acceso de los paquetes publicados.	CodeCatalyst usa un modelo de permisos diferente al del repositorio público de npmjs.
adduser	Añade una cuenta de usuario de registro	CodeCatalyst utiliza un modelo de usuario diferente del repositorio público de npmjs.
audit	Realiza una auditoría de seguridad.	CodeCatalyst actualmente no vende datos sobre vulnerabilidades de seguridad.
hook	Administra los enlaces npm, lo que incluye agregar, eliminar, enumerar y actualizar.	CodeCatalyst actualmente no admite ningún mecanismo de notificación de cambios.
login	Autentica a un usuario. Este es un alias para npm adduser.	CodeCatalyst utiliza un modelo de autenticación diferente del repositorio público de npmjs. Para obtener más información, consulte Configurar npm con CodeCatalyst.
logout	Cierra la sesión del registro.	CodeCatalyst utiliza un modelo de autenticación diferente del repositorio público de npmjs. No hay forma de cerrar sesión en un CodeCatalyst repositorio, pero los tokens de autenticación caducan una vez transcurrido el tiempo de caducidad configurable. La duración predeterminada del token es de 12 horas.
owner	Administra a los propietarios de los paquetes.	CodeCatalyst utiliza un modelo de permisos diferente al del repositorio público de npmjs.
profile	Cambia la configuración de su perfil de registro.	CodeCatalyst utiliza un modelo de usuario diferente del repositorio público de npmjs.
search	Busca en el registro paquetes que coincidan con los términos de búsqueda.	CodeCatalyst no admite el search comando.
star	Marca sus paquetes favoritos.	CodeCatalyst actualmente no admite ningún mecanismo de favoritos.
stars	Visualiza los paquetes marcados como favoritos.	CodeCatalyst actualmente no admite ningún mecanismo de favoritos.
team	Administra los equipos y las membresías de los equipos.	CodeCatalyst utiliza un modelo de membresía de usuarios y grupos que es diferente del repositorio público de npmjs.
token	Administra sus tokens de autenticación.	CodeCatalyst utiliza un modelo diferente para obtener los tokens de autenticación. Para obtener más información, consulte Configurar npm con CodeCatalyst.
unpublish	Elimina un paquete del registro.	CodeCatalyst no admite la eliminación de una versión de paquete de un repositorio mediante el cliente npm. Puede eliminar un paquete en la consola.
whoami	Muestra el nombre de usuario de npm.	CodeCatalyst utiliza un modelo de usuario diferente del repositorio público de npmjs.