Configuration et utilisation de npm

Pour l'utiliser npm avec CodeCatalyst, vous devez vous connecter npm à votre référentiel de packages et fournir un jeton d'accès personnel (PAT) pour l'authentification. Vous pouvez consulter les instructions de connexion npm à votre référentiel de packages dans la CodeCatalyst console.

Table des matières

• Configuration de npm avec CodeCatalyst
• Installation de packages npm à partir d'un référentiel CodeCatalyst de packages
• Installation de packages npm depuis npmjs via CodeCatalyst
• Publication de packages npm dans votre référentiel de CodeCatalyst packages
• support des commandes npm
  • Commandes prises en charge qui interagissent avec un référentiel de packages
  • Commandes côté client prises en charge
  • Commandes non prises en charge

Configuration de npm avec CodeCatalyst

Les instructions suivantes expliquent comment vous authentifier et vous connecter npm à votre référentiel de CodeCatalyst packages. Pour plus d'informations sur npm, consultez la documentation officielle de npm.

Pour vous connecter npm à votre référentiel de CodeCatalyst packages

1. Ouvrez la CodeCatalyst console à l'adresse https://codecatalyst.aws/.

2. Accédez à votre projet.

3. Dans le panneau de navigation, choisissez Packages.

4. Choisissez votre référentiel de packages dans la liste.

5. Choisissez Connect to repository.

6. Dans Détails de configuration, dans Package manager client, choisissez npm client.

7. Choisissez votre système d'exploitation pour afficher les étapes de configuration correspondantes.

8. Un jeton d'accès personnel (PAT) est requis pour authentifier npm avec. CodeCatalyst Si vous avez déjà un jeton, vous pouvez l'utiliser. Si ce n'est pas le cas, vous pouvez en créer un en suivant les étapes ci-dessous.

   1. (Facultatif) : Mettez à jour le PATnom et la date d'expiration.

   2. Choisissez Créer un jeton.

   3. Copiez et stockez PAT le vôtre dans un endroit sûr.

      Avertissement

      Vous ne pourrez ni voir ni copier à nouveau le vôtre PAT une fois que vous aurez fermé la boîte de dialogue. Les informations d'identification doivent être de courte durée afin de minimiser le temps pendant lequel un attaquant peut les utiliser après les avoir détournées.

9. Exécutez les commandes suivantes depuis le répertoire racine de votre projet pour configurer npm avec votre référentiel de packages. Les commandes effectueront les opérations suivantes :

   • Créez un .npmrc fichier au niveau du projet si votre projet n'en possède pas.

   • Ajoutez les informations de point de terminaison du référentiel de packages à votre fichier au niveau du projet.npmrc.

   • Ajoutez vos informations d'identification (PAT) à votre .npmrc fichier de niveau utilisateur.

   Remplacez les valeurs suivantes.

   Note

   Si vous copiez les instructions de la console, les valeurs des commandes suivantes sont mises à jour pour vous et il n'est pas nécessaire de les modifier.

   • Remplacez username avec votre nom CodeCatalyst d'utilisateur.

   • Remplacez PAT avec votre CodeCatalyst PAT.

   • Remplacez space_name avec le nom CodeCatalyst de votre espace.

   • Remplacez proj_name avec le nom CodeCatalyst de votre projet.

   • Remplacez repo_name avec le nom CodeCatalyst du dépôt de votre package.

   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

   Pour npm 6 ou inférieur : pour que npm transmette toujours le jeton d'authentification à CodeCatalyst, même pour les GET demandes, définissez la variable de configuration always-auth comme suit. npm config set

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

Installation de packages npm à partir d'un référentiel CodeCatalyst de packages

Après avoir connecté npm à votre référentiel en suivant les étapes décrites dansConfiguration de npm avec CodeCatalyst, vous pouvez exécuter des npm commandes sur votre référentiel.

Vous pouvez installer un package npm qui se trouve dans votre référentiel de CodeCatalyst packages ou dans l'un de ses référentiels en amont à l'aide de la npm install commande.

npm install lodash

Installation de packages npm depuis npmjs via CodeCatalyst

Vous pouvez installer des packages npm depuis npmjs.com via un CodeCatalyst référentiel en configurant le référentiel avec une connexion en amont au référentiel de passerelle connecté à npmjs.com,. npm-public-registry-gateway Les packages installés à partir de npmjs sont ingérés et stockés dans le référentiel de passerelle, le référentiel de packages le plus éloigné en aval.

Pour installer des packages depuis npmjs

1. Si ce n'est pas déjà fait, configurez npm avec votre référentiel de CodeCatalyst packages en suivant les étapes décrites dansConfiguration de npm avec CodeCatalyst.

2. Vérifiez que votre référentiel a ajouté le référentiel de passerelle npm-public-registry-gateway, en tant que connexion en amont. Vous pouvez vérifier quelles sources en amont sont ajoutées ou ajoutées en npm-public-registry-gatewaytant que source en amont en suivant les instructions Ajouter un référentiel en amont et en choisissant le npm-public-registry-gatewayréférentiel.

3. Installez les packages à l'aide de la npm install commande.

   npm install package_name

Pour plus d'informations sur la demande de packages à partir de référentiels en amont, consultezDemande d'une version de package avec des référentiels en amont.

Publication de packages npm dans votre référentiel de CodeCatalyst packages

Une fois que vous avez terminéConfiguration de npm avec CodeCatalyst, vous pouvez exécuter npm des commandes.

Vous pouvez publier un package npm dans un référentiel de CodeCatalyst packages à l'aide de la npm publish commande.

npm publish

Pour plus d'informations sur la création de packages npm, voir Création de modules Node.js sur npm Docs.

support des commandes npm

Les sections suivantes résument les npm commandes prises en charge par les référentiels de CodeCatalyst packages, en plus de répertorier les commandes spécifiques qui ne sont pas prises en charge.

Rubriques

• Commandes prises en charge qui interagissent avec un référentiel de packages
• Commandes côté client prises en charge
• Commandes non prises en charge

Commandes prises en charge qui interagissent avec un référentiel de packages

Cette section répertorie npm les commandes dans lesquelles le npm client envoie une ou plusieurs requêtes au registre pour lequel il est configuré (par exemple,npm config set registry). Il a été vérifié que ces commandes fonctionnent correctement lorsqu'elles sont invoquées dans un référentiel de CodeCatalyst packages.

Command	Description
punaises	Devine l'emplacement du système de suivi des bogues d'un packageURL, puis tente de l'ouvrir.
ci	Installe un projet sur une table rase.
déprécier	Déprécie une version d'un package.
dist-tag	Modifie les balises de distribution des packages.
documents	Devine l'emplacement de la documentation d'un packageURL, puis tente de l'ouvrir à l'aide du paramètre de --browser configuration.
médecin	Exécute un ensemble de vérifications pour valider que votre installation npm peut gérer vos JavaScript packages.
installer	Installe un package.
install-ci-test	Installe un projet sur une table rase et exécute des tests. Pseudonyme :npm cit. Cette commande exécute unnpm ci, suivi immédiatement d'unnpm test.
installation-test	Installe le package et exécute des tests. Exécute unnpm install, suivi immédiatement d'unnpm test.
désuet	Vérifie le registre configuré pour déterminer si les packages installés ne sont pas à jour.
ping	Envoie un ping au registre npm configuré ou donné et vérifie l'authentification.
publier	Publie une version du package dans le registre.
update	Devine l'emplacement du dépôt d'un packageURL, puis tente de l'ouvrir à l'aide du paramètre de --browser configuration.
vue	Affiche les métadonnées du package. Peut également être utilisé pour imprimer les propriétés des métadonnées.

Commandes côté client prises en charge

Ces commandes ne nécessitent aucune interaction directe avec un dépôt de packages et CodeCatalyst ne nécessitent donc rien pour les prendre en charge.

Command	Description
poubelle (héritage)	Affiche le bin répertoire npm.
construire	Construit un package.
cache	Manipule le cache des packages.
achèvement	Permet de compléter les onglets dans toutes les commandes npm.
configuration	Met à jour le contenu des npmrc fichiers utilisateur et globaux.
dédupliquez	Effectue une recherche dans l'arborescence des packages locaux et tente de simplifier la structure en déplaçant les dépendances plus haut dans l'arborescence, où elles peuvent être partagées plus efficacement par plusieurs packages dépendants.
modifier	Modifie un package installé. Sélectionne une dépendance dans le répertoire de travail actuel et ouvre le répertoire du package dans l'éditeur par défaut.
explorez	Parcourt un package installé. Génère un sous-shell dans le répertoire du package installé spécifié. Si une commande est spécifiée, elle est exécutée dans le sous-shell, qui s'arrête alors immédiatement.
help	Obtient de l'aide sur npm.
aide-recherche	Recherche la documentation d'aide de npm.
initialisation	Crée un package.json fichier.
lien	Établit des liens symboliques vers un répertoire de packages.
ls	Répertorie les packages installés.
emballer	Crée une archive tar à partir d'un package.
prefix	Affiche un préfixe. Il s'agit du répertoire parent le plus proche à contenir un package.json fichier, sauf indication contraire-g.
pruneau	Supprime les packages qui ne figurent pas dans la liste des dépendances du package parent.
reconstruire	Exécute la npm build commande sur les dossiers correspondants.
redémarrer	Exécute les scripts d'arrêt, de redémarrage et de démarrage d'un package ainsi que les pré-scripts et post-scripts associés.
racine	Imprime le node_modules répertoire effectif en sortie standard.
exécuter un script	Exécute des scripts de package arbitraires.
shrinkwrap	Verrouille les versions de dépendance pour publication.
désinstaller	Désinstalle un package.

Commandes non prises en charge

Ces npm commandes ne sont pas prises en charge par les référentiels de CodeCatalyst packages.

Command	Description	Remarques
accès	Définit le niveau d'accès aux packages publiés.	CodeCatalyst utilise un modèle d'autorisation différent de celui du référentiel public npmjs.
ajouter un utilisateur	Ajoute un compte utilisateur au registre	CodeCatalyst utilise un modèle utilisateur différent de celui du dépôt public npmjs.
audit	Exécute un audit de sécurité.	CodeCatalyst ne vend actuellement pas de données relatives aux failles de sécurité.
crochet	Gère les hooks npm, y compris l'ajout, la suppression, la liste et la mise à jour.	CodeCatalyst ne prend actuellement en charge aucun mécanisme de notification des modifications.
login	Authentifie un utilisateur. Ceci est un alias pour npm adduser.	CodeCatalyst utilise un modèle d'authentification différent de celui du dépôt public npmjs. Pour plus d’informations, veuillez consulter Configuration de npm avec CodeCatalyst.
logout	Se déconnecte du registre.	CodeCatalyst utilise un modèle d'authentification différent de celui du dépôt public npmjs. Il n'est pas possible de se déconnecter d'un CodeCatalyst référentiel, mais les jetons d'authentification expirent après leur date d'expiration configurable. La durée du jeton par défaut est de 12 heures.
propriétaire	Gère les propriétaires de packages.	CodeCatalyst utilise un modèle d'autorisations différent de celui du référentiel public npmjs.
profile	Modifie les paramètres de votre profil de registre.	CodeCatalyst utilise un modèle utilisateur différent de celui du dépôt public npmjs.
search	Recherche dans le registre les packages correspondant aux termes de recherche.	CodeCatalyst ne prend pas en charge la search commande.
étoile	Marque vos packages préférés.	CodeCatalyst ne supporte actuellement aucun mécanisme de favoris.
étoiles	Affiche les packages marqués comme favoris.	CodeCatalyst ne supporte actuellement aucun mécanisme de favoris.
équipe	Gère les équipes et les adhésions aux équipes.	CodeCatalyst utilise un modèle d'adhésion d'utilisateurs et de groupes différent de celui du référentiel public npmjs.
https://docs.npmjs.com/cli/tokentoken	Gère vos jetons d'authentification.	CodeCatalyst utilise un modèle différent pour obtenir des jetons d'authentification. Pour plus d’informations, veuillez consulter Configuration de npm avec CodeCatalyst.
dépublier	Supprime un package du registre.	CodeCatalyst ne prend pas en charge la suppression d'une version de package d'un référentiel à l'aide du client npm. Vous pouvez supprimer un package dans la console.
whoami	Affiche le nom d'utilisateur npm.	CodeCatalyst utilise un modèle utilisateur différent de celui du dépôt public npmjs.