Maison interface Web js tutoriel Republier gimme_readme sur npm avec GitHub Actions

Republier gimme_readme sur npm avec GitHub Actions

Dec 01, 2024 am 02:02 AM

Cette semaine, dans mon cours Open Source, mes camarades de classe et moi avons été chargés de publier chacun de nos propres programmes dans un registre de packages.

Quand vous entendez quelqu'un dire registre de code, registre de packages ou registre, j'aime penser à ces mots comme représentant un endroit où les développeurs et les entreprises publient leur code pour que d'autres puissent le télécharger. Pour une description plus précise, vous pouvez lire cet article de Mozilla :

Re-publishing gimme_readme to npm with GitHub Actions

Bases de la gestion des packages - Apprendre le développement Web | MDN

Cela nous amène à la fin de notre tournée des gestionnaires de packages. Notre prochaine étape consiste à créer un exemple de chaîne d'outils, mettant en pratique tout ce que nous avons appris jusqu'à présent.

Re-publishing gimme_readme to npm with GitHub Actions

donne-moi_readme - npm

gimme_readme est un outil de ligne de commande alimenté par l'IA qui génère un fichier README.md complet pour votre projet. Il analyse plusieurs fichiers de code source à la fois, fournissant des explications concises sur l'objectif, les fonctionnalités et les composants clés de chaque fichier. Dernière version : 1.0.0, dernière publication : il y a 16 heures. Commencez à utiliser gimme_readme dans votre projet en exécutant `npm i gimme_readme`. Il n'y a aucun autre projet dans le registre npm utilisant gimme_readme.

Re-publishing gimme_readme to npm with GitHub Actions

Comme vous pouvez le voir ci-dessus, il existe de nombreux dossiers et fichiers qui ne sont pas nécessaires à un utilisateur (par opposition à un développeur). Par exemple, pensez-vous que mes utilisateurs souhaiteraient que mon dossier « tests » teste le code de mon programme ? Probablement pas. Pensez-vous que mes utilisateurs ont besoin des fichiers de configuration nécessaires pour formater et pelucher mon code source ? Probablement pas. Pensez-vous que mes utilisateurs auraient besoin d'utiliser mon dossier « .github » pour une raison particulière ? Probablement pas.

À cette fin, j'ai travaillé pour trouver une solution pour minimiser ce qui est téléchargé par un utilisateur ; plus précisément, je veux qu'ils n'aient que le code source nécessaire au fonctionnement de mon programme.

Vers .npmignore ou pas .npmignore ? C'est la question.

Alors que je pensais republier mon code, je discutais également avec mon ami Uday Rana, de l'idée d'utiliser un fichier .npmignore pour "ignorer" les fichiers que je ne voulais pas publier.

Littéralement juste après avoir mentionné le sujet, Uday a recherché .npmignore sur Google et a trouvé un article écrit par Jeff D expliquant pourquoi il ne faut jamais utiliser un fichier .npmignore. Pour être clair, je suis entièrement d’accord avec l’article de Jeff.

Essentiellement, l'idée est que nous devrions être explicites avec ce que nous voulons publier (liste blanche), au lieu d'indiquer quels fichiers nous ne voulons pas souhaitez publier (liste noire).

Mettre en liste blanche les fichiers que nous souhaitons publier est simple avec npm. Tout ce que nous avons à faire est de modifier notre fichier package.json en ajoutant une option "files", qui indique les fichiers que nous souhaitons publier pour notre programme.

Ci-dessous, j'ai pris une capture d'écran de l'option "files" de package.json, qui indique "inclure le répertoire src/ lors de la publication de ce programme". Depuis, j'ai validé ces modifications et ces modifications sont disponibles dans ma version v1.0.0 de mon code.

Re-publishing gimme_readme to npm with GitHub Actions

REMARQUE : Certains fichiers par défaut sont toujours publiés sur npm, peu importe ce que vous spécifiez ou ne spécifiez pas dans votre option "fichiers". Si vous souhaitez en savoir plus sur l'utilisation de l'option "files", consultez la documentation officielle de npm sur la façon d'utiliser l'option file.

Après avoir publié mon code sur npm avec mon package.json mis à jour, les utilisateurs qui installent/réinstallent gimme_readme auront désormais beaucoup moins de surcharge sur leurs ordinateurs ! Voyez la différence ci-dessous :

Re-publishing gimme_readme to npm with GitHub Actions

Ajout d'une action GitHub pour publier mon code sur npm lorsque j'ajoute une nouvelle version

En plus d'améliorer l'expérience de mes utilisateurs (en réduisant la surcharge liée à l'installation de gimme_readme via npm), j'ai également ajouté un pipeline de développement continu (pipeline cd en abrégé) qui automatisait mon processus de publication sur npm lorsque je crée un nouveau sortie sur GitHub. Pour plus de détails sur la façon de procéder, vous pouvez vous référer au guide des packages Publishing Node.js de GitHub. Cela fait du bien maintenant, car en un clic de quelques boutons, je suis capable de publier du code que je sais stable (selon mon pipeline CI), à partir de GitHub.

Vous pouvez trouver le code de mon pipeline de cd ici.

Tester avec Uday

Comme je l'ai mentionné plus tôt, je travaillais avec mon ami Uday Rana en ce qui concerne les tests. Au moment de la rédaction de cet article, il a pu installer mon outil, et l'utiliser comme ceci :

Re-publishing gimme_readme to npm with GitHub Actions

Les choses me semblent bonnes, et la plupart des options dont je dispose pour mon outil se comportent plus ou moins comme il l'attend. Mais je vais devoir répéter ce processus à nouveau, car j'ai d'autres optimisations que je souhaite ajouter !

Le voyage ne se termine jamais... mais c'est ce qui le rend amusant !

J'ai également récemment entendu parler de moyens d'optimiser davantage mon code. En particulier, je m'investis dans l'apprentissage de la façon d'améliorer mes pipelines CI et CD en découvrant les actions composites et les flux de travail réutilisables en ce qui concerne les actions GitHub. J'espère que ces techniques m'aideront à réduire la quantité de code que j'écris et offriront une sorte d'amélioration des performances ! Je ne connais pas encore grand chose sur ces sujets, mais vous pouvez être sûr que je bloguerai probablement bientôt sur ce sujet.

Et ça mes amis, conclut ce dont je voulais parler dans ce blog.

À la prochaine fois !

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!

Déclaration de ce site Web
Le contenu de cet article est volontairement contribué par les internautes et les droits d'auteur appartiennent à l'auteur original. Ce site n'assume aucune responsabilité légale correspondante. Si vous trouvez un contenu suspecté de plagiat ou de contrefaçon, veuillez contacter admin@php.cn

Outils d'IA chauds

Undresser.AI Undress

Undresser.AI Undress

Application basée sur l'IA pour créer des photos de nu réalistes

AI Clothes Remover

AI Clothes Remover

Outil d'IA en ligne pour supprimer les vêtements des photos.

Undress AI Tool

Undress AI Tool

Images de déshabillage gratuites

Clothoff.io

Clothoff.io

Dissolvant de vêtements AI

Video Face Swap

Video Face Swap

Échangez les visages dans n'importe quelle vidéo sans effort grâce à notre outil d'échange de visage AI entièrement gratuit !

Article chaud

<🎜>: Grow A Garden - Guide de mutation complet
3 Il y a quelques semaines By DDD
<🎜>: Bubble Gum Simulator Infinity - Comment obtenir et utiliser les clés royales
3 Il y a quelques semaines By 尊渡假赌尊渡假赌尊渡假赌
Mandragora: Whispers of the Witch Tree - Comment déverrouiller le grappin
3 Il y a quelques semaines By 尊渡假赌尊渡假赌尊渡假赌
Nordhold: Système de fusion, expliqué
3 Il y a quelques semaines By 尊渡假赌尊渡假赌尊渡假赌

Outils chauds

Bloc-notes++7.3.1

Bloc-notes++7.3.1

Éditeur de code facile à utiliser et gratuit

SublimeText3 version chinoise

SublimeText3 version chinoise

Version chinoise, très simple à utiliser

Envoyer Studio 13.0.1

Envoyer Studio 13.0.1

Puissant environnement de développement intégré PHP

Dreamweaver CS6

Dreamweaver CS6

Outils de développement Web visuel

SublimeText3 version Mac

SublimeText3 version Mac

Logiciel d'édition de code au niveau de Dieu (SublimeText3)

Sujets chauds

Tutoriel Java
1667
14
Tutoriel PHP
1273
29
Tutoriel C#
1255
24
Moteurs JavaScript: comparaison des implémentations Moteurs JavaScript: comparaison des implémentations Apr 13, 2025 am 12:05 AM

Différents moteurs JavaScript ont des effets différents lors de l'analyse et de l'exécution du code JavaScript, car les principes d'implémentation et les stratégies d'optimisation de chaque moteur diffèrent. 1. Analyse lexicale: convertir le code source en unité lexicale. 2. Analyse de la grammaire: générer un arbre de syntaxe abstrait. 3. Optimisation et compilation: générer du code machine via le compilateur JIT. 4. Exécuter: Exécutez le code machine. Le moteur V8 optimise grâce à une compilation instantanée et à une classe cachée, SpiderMonkey utilise un système d'inférence de type, résultant en différentes performances de performances sur le même code.

Python vs JavaScript: la courbe d'apprentissage et la facilité d'utilisation Python vs JavaScript: la courbe d'apprentissage et la facilité d'utilisation Apr 16, 2025 am 12:12 AM

Python convient plus aux débutants, avec une courbe d'apprentissage en douceur et une syntaxe concise; JavaScript convient au développement frontal, avec une courbe d'apprentissage abrupte et une syntaxe flexible. 1. La syntaxe Python est intuitive et adaptée à la science des données et au développement back-end. 2. JavaScript est flexible et largement utilisé dans la programmation frontale et côté serveur.

De C / C à JavaScript: comment tout cela fonctionne De C / C à JavaScript: comment tout cela fonctionne Apr 14, 2025 am 12:05 AM

Le passage de C / C à JavaScript nécessite de s'adapter à la frappe dynamique, à la collecte des ordures et à la programmation asynchrone. 1) C / C est un langage dactylographié statiquement qui nécessite une gestion manuelle de la mémoire, tandis que JavaScript est dynamiquement typé et que la collecte des déchets est automatiquement traitée. 2) C / C doit être compilé en code machine, tandis que JavaScript est une langue interprétée. 3) JavaScript introduit des concepts tels que les fermetures, les chaînes de prototypes et la promesse, ce qui améliore la flexibilité et les capacités de programmation asynchrones.

Javascript et le web: fonctionnalité de base et cas d'utilisation Javascript et le web: fonctionnalité de base et cas d'utilisation Apr 18, 2025 am 12:19 AM

Les principales utilisations de JavaScript dans le développement Web incluent l'interaction client, la vérification du formulaire et la communication asynchrone. 1) Mise à jour du contenu dynamique et interaction utilisateur via les opérations DOM; 2) La vérification du client est effectuée avant que l'utilisateur ne soumette les données pour améliorer l'expérience utilisateur; 3) La communication de rafraîchissement avec le serveur est réalisée via la technologie AJAX.

JavaScript en action: Exemples et projets du monde réel JavaScript en action: Exemples et projets du monde réel Apr 19, 2025 am 12:13 AM

L'application de JavaScript dans le monde réel comprend un développement frontal et back-end. 1) Afficher les applications frontales en créant une application de liste TODO, impliquant les opérations DOM et le traitement des événements. 2) Construisez RestulAPI via Node.js et Express pour démontrer les applications back-end.

Comprendre le moteur JavaScript: détails de l'implémentation Comprendre le moteur JavaScript: détails de l'implémentation Apr 17, 2025 am 12:05 AM

Comprendre le fonctionnement du moteur JavaScript en interne est important pour les développeurs car il aide à écrire du code plus efficace et à comprendre les goulots d'étranglement des performances et les stratégies d'optimisation. 1) Le flux de travail du moteur comprend trois étapes: analyse, compilation et exécution; 2) Pendant le processus d'exécution, le moteur effectuera une optimisation dynamique, comme le cache en ligne et les classes cachées; 3) Les meilleures pratiques comprennent l'évitement des variables globales, l'optimisation des boucles, l'utilisation de const et de locations et d'éviter une utilisation excessive des fermetures.

Python vs JavaScript: communauté, bibliothèques et ressources Python vs JavaScript: communauté, bibliothèques et ressources Apr 15, 2025 am 12:16 AM

Python et JavaScript ont leurs propres avantages et inconvénients en termes de communauté, de bibliothèques et de ressources. 1) La communauté Python est amicale et adaptée aux débutants, mais les ressources de développement frontal ne sont pas aussi riches que JavaScript. 2) Python est puissant dans les bibliothèques de science des données et d'apprentissage automatique, tandis que JavaScript est meilleur dans les bibliothèques et les cadres de développement frontaux. 3) Les deux ont des ressources d'apprentissage riches, mais Python convient pour commencer par des documents officiels, tandis que JavaScript est meilleur avec MDNWEBDOCS. Le choix doit être basé sur les besoins du projet et les intérêts personnels.

Python vs JavaScript: environnements et outils de développement Python vs JavaScript: environnements et outils de développement Apr 26, 2025 am 12:09 AM

Les choix de Python et JavaScript dans les environnements de développement sont importants. 1) L'environnement de développement de Python comprend Pycharm, Jupyternotebook et Anaconda, qui conviennent à la science des données et au prototypage rapide. 2) L'environnement de développement de JavaScript comprend Node.js, VScode et WebPack, qui conviennent au développement frontal et back-end. Le choix des bons outils en fonction des besoins du projet peut améliorer l'efficacité du développement et le taux de réussite du projet.

See all articles