Snipper ist ein kleiner Assistent des Programmierers

Snipper ist eine einfache, in PHP geschriebene Konsolenanwendung zum bequemen Importieren von Code-Snippets aus dem beliebten GitHub Gist- Dienst .

Hintergrund


Eines schönen Tages wurde mir klar, dass ich es leid war, kleine Konfigurationsdateien von Projekt zu Projekt zu kopieren, und ich suchte nach der Antwort auf die Frage: Wie kann ich mich vor Leiden retten und keine neuen hinzufügen?

Nachdem ich eine ausreichende Anzahl von Lösungen in Betracht gezogen hatte, begann ich, meine eigene „Konsolenanwendung“ zum Herunterladen häufig verwendeter Dateien mit Code zu schreiben (es geht um Dateien und nicht um das Arbeiten mit der Zwischenablage). Ich habe den Dienst von GitHub für die Speicherung ausgewählt , da es keine Möglichkeit gibt, ohne ihn zu arbeiten (es gibt viele vorgefertigte Bibliotheken für die Arbeit mit der API), und für das sarkastische Erscheinungsbild ist die Konsolenkomponente aus dem Symfony-Arsenal jedem vertraut .

Was gefiel den vorhandenen Lösungen nicht?

Die gefundenen Anwendungen sind hauptsächlich zum Kopieren von Code in die Zwischenablage gedacht und verfügen über eine grafische Oberfläche, die ich absolut nicht für nötig halte. Von Zeit zu Zeit war es erforderlich, Dateien mit Standardeinstellungen auf einen Remote-Server hochzuladen, was auch bei Verwendung "großer" Dienstprogramme recht schwierig ist. Die Besonderheiten meiner Arbeit legen die Anwesenheit von PHP und Composer auf allen Maschinen nahe, auf denen ich lebe. Die Schlussfolgerung lag also auf der Hand - Ihr eigenes Fahrrad zu bauen.

Wer braucht das?


Jeder kann Snipper verwenden, aber aufgrund der Tatsache, dass es in PHP geschrieben ist, sind die PHP-Benutzer die Hauptbenutzer. Er wurde als angenehme Ergänzung zu Composer konzipiert , um schnell ein Start-up-Projekt zusammenzustellen und loszulegen.

Ich verwende es hauptsächlich zum Importieren von Konfigurationen von Texteditoren und IDEs, die EditorConfig unterstützen , für .envDateien, Einstellungen von selbstgeschriebenen Bibliotheken und sogar für die Standard-Assemblierung von Client-Komponenten mit Gulp .

Was kann Snipper?


Momentan ist nur eine grundlegende Funktionalität implementiert, nämlich das Empfangen einer Datei (oder von Dateien, wenn viele vorhanden sind) mit dem Namen des Snippets. Dies ist jedoch im Moment mehr als genug, um Snipper im Kampf einzusetzen .

Wie funktioniert es


Installation und Einrichtung

Sie können Snipper mit Composer installieren :

composer g require snipper/snipper:@stable

Danach müssen Sie ein persönliches Zugriffstoken für die komfortable Arbeit mit der GitHub-API angeben :

snipper init 

Ich stelle fest, dass im Moment keine Rechte erforderlich sind, obwohl in späteren Versionen möglicherweise die Erlaubnis zum Erstellen von Listen erforderlich ist.

Snippet-Suche

Die Suche wird für alle gist'am durchgeführt, die Ihnen gehören und mit einem Sternchen markiert sind. In der Beschreibung für das Wesentliche müssen Sie den Namen des Snippets mit dem Hash-Symbol "Jedermanns Liebling" voranstellen . Sie müssen suchen, indem Sie das Hash-Symbol weglassen und nur den Namen angeben.

Wenn Sie eine Zusammenfassung mit der Beschreibung "EditorConfig # .editorconfig" haben, führen Sie einfach den folgenden Befehl aus, um das Snippet abzurufen:

snipper get .editorconfig

Wenn mehrere gleichnamige Snippets gefunden werden, fordert Snipper Sie auf, das gewünschte Snippet aus der Liste auszuwählen.

Standardmäßig überschreibt Snipper keine Dateien mit demselben Namen und meldet auch solche Fälle. Sie können jedoch die Anwendung explizit anweisen, die Datei (en) zu überschreiben, wenn Sie den Befehl getmit der Taste ausführen -f.

Abschließend

Ich hoffe Snipper kommt nicht nur mir zugute. Gerne berücksichtige ich Ihre Anregungen und Kommentare bei der Beschreibung von Problemen im Repository auf GitHub . Vielen Dank für Ihre Aufmerksamkeit!

Referenzen:

Jetzt auch beliebt: