Heim Web-Frontend js-Tutorial Erneutes Veröffentlichen von gimme_readme in npm mit GitHub Actions

Erneutes Veröffentlichen von gimme_readme in npm mit GitHub Actions

Dec 01, 2024 am 02:02 AM

Diese Woche wurden meine Klassenkameraden und ich in meinem Open-Source-Kurs damit beauftragt, jedes unserer eigenen Programme in einer Paketregistrierung zu veröffentlichen.

Wenn Sie jemanden Code-Registrierung, Paket-Registrierung oder Registrierung sagen hören, stelle ich mir diese Wörter gerne als einen Ort vor, an dem Entwickler und Unternehmen ihren Code veröffentlichen, damit andere ihn herunterladen können. Für eine genauere Beschreibung können Sie diesen Artikel von Mozilla lesen:

Re-publishing gimme_readme to npm with GitHub Actions

Grundlagen der Paketverwaltung – Webentwicklung lernen | MDN

Damit sind wir am Ende unserer Tour durch Paketmanager angelangt. Unser nächster Schritt besteht darin, eine Beispiel-Toolchain aufzubauen und damit alles, was wir bisher gelernt haben, in die Praxis umzusetzen.

Re-publishing gimme_readme to npm with GitHub Actions

gimme_readme - npm

gimme_readme ist ein auf KI basierendes Befehlszeilentool, das eine umfassende README.md-Datei für Ihr Projekt generiert. Es analysiert mehrere Quellcodedateien gleichzeitig und liefert präzise Erklärungen zum Zweck, zur Funktionalität und zu den Schlüsselkomponenten jeder Datei. Neueste Version: 1.0.0, letzte Veröffentlichung: vor 16 Stunden. Beginnen Sie mit der Verwendung von gimme_readme in Ihrem Projekt, indem Sie „npm i gimme_readme“ ausführen. Es gibt keine anderen Projekte in der npm-Registrierung, die gimme_readme verwenden.

Re-publishing gimme_readme to npm with GitHub Actions

Wie Sie oben sehen können, gibt es viele Ordner und Dateien, die für einen Benutzer (im Gegensatz zu einem Entwickler) unnötig sind. Glauben Sie beispielsweise, dass meine Benutzer möchten, dass mein Ordner „Tests“ den Code meines Programms testet? Wahrscheinlich nicht. Glauben Sie, dass meine Benutzer die Konfigurationsdateien benötigen, die zum Formatieren und Flusen meines Quellcodes erforderlich sind? Wahrscheinlich nicht. Glauben Sie, dass meine Benutzer aus einem bestimmten Grund meinen Ordner „.github“ verwenden müssten? Wahrscheinlich nicht.

Zu diesem Zweck habe ich daran gearbeitet, eine Lösung zu finden, um die Downloads eines Benutzers zu minimieren. Insbesondere möchte ich, dass sie nur über den Quellcode verfügen, der für die Ausführung meines Programms erforderlich ist.

.npmignore oder nicht .npmignore? Das ist die Frage.

Als ich darüber nachdachte, meinen Code erneut zu veröffentlichen, sprach ich auch mit meinem Freund Uday Rana über die Idee, eine .npmignore-Datei zu verwenden, um Dateien zu „ignorieren“, die ich nicht veröffentlichen wollte.

Buchstäblich direkt nachdem ich das Thema erwähnt hatte googelte Uday .npmignore und fand einen Artikel von Jeff D darüber, warum man niemals eine .npmignore-Datei verwenden sollte. Um es klarzustellen: Ich stimme Jeffs Artikel voll und ganz zu.

Im Wesentlichen besteht die Idee darin, dass wir explizit darüber sein sollten, was wir veröffentlichen wollen (Whitelisting), anstatt anzugeben, welche Dateien wir nicht veröffentlichen möchten (Blacklisting).

Mit npm ist es ganz einfach, die Dateien, die wir veröffentlichen möchten, auf die Whitelist zu setzen. Alles, was wir tun müssen, ist, unsere package.json-Datei zu bearbeiten, indem wir eine „Dateien“-Option hinzufügen, die angibt, welche Dateien wir für unser Programm veröffentlichen möchten.

Unten habe ich einen Screenshot der „files“-Option von package.json gemacht, in der es heißt: „Beim Veröffentlichen dieses Programms das Verzeichnis src/ einschließen“. Ich habe diese Änderungen inzwischen übernommen und diese Änderungen sind in meiner Version 1.0.0 meines Codes verfügbar.

Re-publishing gimme_readme to npm with GitHub Actions

HINWEIS: Bestimmte Dateien werden standardmäßig immer auf npm veröffentlicht, unabhängig davon, was Sie in Ihrer Option „Dateien“ angeben oder nicht. Wenn Sie mehr über die Verwendung der Option „Dateien“ erfahren möchten, lesen Sie die offizielle Dokumentation von npm zur Verwendung der Dateioption.

Nachdem ich meinen Code mit meiner aktualisierten package.json auf npm veröffentlicht habe, werden Benutzer, die gimme_readme installieren/neu installieren, jetzt viel weniger Blähungen auf ihren Computern haben! Sehen Sie sich den Unterschied unten an:

Re-publishing gimme_readme to npm with GitHub Actions

Hinzufügen einer GitHub-Aktion zum Veröffentlichen meines Codes in npm, wenn ich eine neue Version hinzufüge

Neben der Verbesserung der Erfahrung meiner Benutzer (indem ich den Aufwand reduziert habe, der durch die Installation von gimme_readme über npm entsteht), habe ich auch eine kontinuierliche Entwicklungspipeline (kurz CD-Pipeline) hinzugefügt, die meinen Veröffentlichungsprozess auf npm automatisiert, wenn ich eine neue Datei erstelle Veröffentlichung auf GitHub. Genaue Details dazu finden Sie im GitHub-Leitfaden zum Veröffentlichen von Node.js-Paketen. Das fühlt sich jetzt gut an, denn mit nur wenigen Klicks kann ich Code veröffentlichen, von dem ich weiß, dass er stabil ist (laut meiner CI-Pipeline), von GitHub.

Den Code für meine CD-Pipeline finden Sie hier.

Testen mit Uday

Wie ich bereits erwähnt habe, habe ich bezüglich der Tests mit meinem Freund Uday Rana zusammengearbeitet. Zum Zeitpunkt des Schreibens war er in der Lage, mein Tool zu installieren und wie folgt zu verwenden:

Re-publishing gimme_readme to npm with GitHub Actions

Für mich sieht alles gut aus und die meisten Optionen, die ich für mein Werkzeug habe, verhalten sich mehr oder weniger so, wie er es erwartet. Aber ich muss diesen Vorgang noch einmal wiederholen, da ich noch einige weitere Optimierungen hinzufügen möchte!

Die Reise endet nie ... aber das macht den Spaß aus!

Ich habe kürzlich auch von Möglichkeiten gehört, meinen Code weiter zu optimieren. Ich interessiere mich insbesondere dafür, zu lernen, wie ich meine CI- und CD-Pipelines verbessern kann, indem ich mehr über zusammengesetzte Aktionen und wiederverwendbare Workflows in Bezug auf GitHub-Aktionen erfahre. Ich hoffe, dass diese Techniken mir dabei helfen, die Menge an Code, die ich schreibe, zu reduzieren und eine Art Leistungssteigerung zu erzielen! Ich weiß noch nicht viel über diese Themen, aber Sie können wetten, dass ich wahrscheinlich bald darüber bloggen werde.

Und damit meine Freunde, schließe ich ab, worüber ich in diesem Blog sprechen wollte.

Bis zum nächsten Mal!

Das obige ist der detaillierte Inhalt vonErneutes Veröffentlichen von gimme_readme in npm mit GitHub Actions. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

Erklärung dieser Website
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn

Heiße KI -Werkzeuge

Undresser.AI Undress

Undresser.AI Undress

KI-gestützte App zum Erstellen realistischer Aktfotos

AI Clothes Remover

AI Clothes Remover

Online-KI-Tool zum Entfernen von Kleidung aus Fotos.

Undress AI Tool

Undress AI Tool

Ausziehbilder kostenlos

Clothoff.io

Clothoff.io

KI-Kleiderentferner

Video Face Swap

Video Face Swap

Tauschen Sie Gesichter in jedem Video mühelos mit unserem völlig kostenlosen KI-Gesichtstausch-Tool aus!

Heißer Artikel

<🎜>: Bubble Gum Simulator Infinity - So erhalten und verwenden Sie Royal Keys
4 Wochen vor By 尊渡假赌尊渡假赌尊渡假赌
Nordhold: Fusionssystem, erklärt
4 Wochen vor By 尊渡假赌尊渡假赌尊渡假赌
Mandragora: Flüstern des Hexenbaum
3 Wochen vor By 尊渡假赌尊渡假赌尊渡假赌

Heiße Werkzeuge

Notepad++7.3.1

Notepad++7.3.1

Einfach zu bedienender und kostenloser Code-Editor

SublimeText3 chinesische Version

SublimeText3 chinesische Version

Chinesische Version, sehr einfach zu bedienen

Senden Sie Studio 13.0.1

Senden Sie Studio 13.0.1

Leistungsstarke integrierte PHP-Entwicklungsumgebung

Dreamweaver CS6

Dreamweaver CS6

Visuelle Webentwicklungstools

SublimeText3 Mac-Version

SublimeText3 Mac-Version

Codebearbeitungssoftware auf Gottesniveau (SublimeText3)

Heiße Themen

Java-Tutorial
1672
14
PHP-Tutorial
1277
29
C#-Tutorial
1257
24
Python vs. JavaScript: Die Lernkurve und Benutzerfreundlichkeit Python vs. JavaScript: Die Lernkurve und Benutzerfreundlichkeit Apr 16, 2025 am 12:12 AM

Python eignet sich besser für Anfänger mit einer reibungslosen Lernkurve und einer kurzen Syntax. JavaScript ist für die Front-End-Entwicklung mit einer steilen Lernkurve und einer flexiblen Syntax geeignet. 1. Python-Syntax ist intuitiv und für die Entwicklung von Datenwissenschaften und Back-End-Entwicklung geeignet. 2. JavaScript ist flexibel und in Front-End- und serverseitiger Programmierung weit verbreitet.

JavaScript und das Web: Kernfunktionalität und Anwendungsfälle JavaScript und das Web: Kernfunktionalität und Anwendungsfälle Apr 18, 2025 am 12:19 AM

Zu den Hauptanwendungen von JavaScript in der Webentwicklung gehören die Interaktion der Clients, die Formüberprüfung und die asynchrone Kommunikation. 1) Dynamisches Inhaltsaktualisierung und Benutzerinteraktion durch DOM -Operationen; 2) Die Kundenüberprüfung erfolgt vor dem Einreichung von Daten, um die Benutzererfahrung zu verbessern. 3) Die Aktualisierung der Kommunikation mit dem Server wird durch AJAX -Technologie erreicht.

JavaScript in Aktion: Beispiele und Projekte in realer Welt JavaScript in Aktion: Beispiele und Projekte in realer Welt Apr 19, 2025 am 12:13 AM

Die Anwendung von JavaScript in der realen Welt umfasst Front-End- und Back-End-Entwicklung. 1) Zeigen Sie Front-End-Anwendungen an, indem Sie eine TODO-Listanwendung erstellen, die DOM-Operationen und Ereignisverarbeitung umfasst. 2) Erstellen Sie RESTFUFFUPI über Node.js und express, um Back-End-Anwendungen zu demonstrieren.

Verständnis der JavaScript -Engine: Implementierungsdetails Verständnis der JavaScript -Engine: Implementierungsdetails Apr 17, 2025 am 12:05 AM

Es ist für Entwickler wichtig, zu verstehen, wie die JavaScript -Engine intern funktioniert, da sie effizientere Code schreibt und Leistungs Engpässe und Optimierungsstrategien verstehen kann. 1) Der Workflow der Engine umfasst drei Phasen: Parsen, Kompilieren und Ausführung; 2) Während des Ausführungsprozesses führt die Engine dynamische Optimierung durch, wie z. B. Inline -Cache und versteckte Klassen. 3) Zu Best Practices gehören die Vermeidung globaler Variablen, die Optimierung von Schleifen, die Verwendung von const und lass und die Vermeidung übermäßiger Verwendung von Schließungen.

Python gegen JavaScript: Community, Bibliotheken und Ressourcen Python gegen JavaScript: Community, Bibliotheken und Ressourcen Apr 15, 2025 am 12:16 AM

Python und JavaScript haben ihre eigenen Vor- und Nachteile in Bezug auf Gemeinschaft, Bibliotheken und Ressourcen. 1) Die Python-Community ist freundlich und für Anfänger geeignet, aber die Front-End-Entwicklungsressourcen sind nicht so reich wie JavaScript. 2) Python ist leistungsstark in Bibliotheken für Datenwissenschaft und maschinelles Lernen, während JavaScript in Bibliotheken und Front-End-Entwicklungsbibliotheken und Frameworks besser ist. 3) Beide haben reichhaltige Lernressourcen, aber Python eignet sich zum Beginn der offiziellen Dokumente, während JavaScript mit Mdnwebdocs besser ist. Die Wahl sollte auf Projektbedürfnissen und persönlichen Interessen beruhen.

Python vs. JavaScript: Entwicklungsumgebungen und Tools Python vs. JavaScript: Entwicklungsumgebungen und Tools Apr 26, 2025 am 12:09 AM

Sowohl Python als auch JavaScripts Entscheidungen in Entwicklungsumgebungen sind wichtig. 1) Die Entwicklungsumgebung von Python umfasst Pycharm, Jupyternotebook und Anaconda, die für Datenwissenschaft und schnelles Prototyping geeignet sind. 2) Die Entwicklungsumgebung von JavaScript umfasst Node.JS, VSCODE und WebPack, die für die Entwicklung von Front-End- und Back-End-Entwicklung geeignet sind. Durch die Auswahl der richtigen Tools nach den Projektbedürfnissen kann die Entwicklung der Entwicklung und die Erfolgsquote der Projekte verbessert werden.

Die Rolle von C/C bei JavaScript -Dolmetschern und Compilern Die Rolle von C/C bei JavaScript -Dolmetschern und Compilern Apr 20, 2025 am 12:01 AM

C und C spielen eine wichtige Rolle in der JavaScript -Engine, die hauptsächlich zur Implementierung von Dolmetschern und JIT -Compilern verwendet wird. 1) C wird verwendet, um JavaScript -Quellcode zu analysieren und einen abstrakten Syntaxbaum zu generieren. 2) C ist für die Generierung und Ausführung von Bytecode verantwortlich. 3) C implementiert den JIT-Compiler, optimiert und kompiliert Hot-Spot-Code zur Laufzeit und verbessert die Ausführungseffizienz von JavaScript erheblich.

Von Websites zu Apps: Die verschiedenen Anwendungen von JavaScript Von Websites zu Apps: Die verschiedenen Anwendungen von JavaScript Apr 22, 2025 am 12:02 AM

JavaScript wird in Websites, mobilen Anwendungen, Desktop-Anwendungen und serverseitigen Programmierungen häufig verwendet. 1) In der Website -Entwicklung betreibt JavaScript DOM zusammen mit HTML und CSS, um dynamische Effekte zu erzielen und Frameworks wie JQuery und React zu unterstützen. 2) Durch reaktnatives und ionisches JavaScript wird ein plattformübergreifendes mobile Anwendungen entwickelt. 3) Mit dem Elektronenframework können JavaScript Desktop -Anwendungen erstellen. 4) Node.js ermöglicht es JavaScript, auf der Serverseite auszuführen und unterstützt hohe gleichzeitige Anforderungen.

See all articles