tgcom

tgcom

Karten Sie die Kommentare in Quelldateien um

---

tgcom ist ein Befehlszeilen-Tool, das Kommentare in Quellcodedateien kommentieren, in der Lage versetzt und umschaltet. Es unterstützt mehrere Sprachen, einschließlich JavaScript, Go und Bash, und kann erweitert werden, um mehr zu unterstützen. Das Werkzeug kann einzelne Linien, Linienbereiche und eine Mischung aus beiden verarbeiten. Es unterstützt auch die Handhabung von Streams von Stdin und verarbeitet mehrere Dateien und Bereiche in einem Befehl.

TGCOM -Funktionen

• Kommentar/Überzeugungs-/Umschalten Kommentare : Betätigen Sie in einzelnen Zeilen, Bereichen oder einer Mischung aus beiden.
• Multisprachiger Unterstützung : Unterstützt JavaScript, Go, Bash und kann auf andere Sprachen ausgedehnt werden.
• Dateibehandlung : Funktioniert mit Dateinamen oder Streams von Stdin.
• Sicherungserstellung : Erstellt automatisch eine Sicherung, bevor eine Datei geändert wird.
• Leistung : Schnell und effizient, lädt die gesamte Datei nicht in den Speicher.
• Etiketten für Abschnitte : Unterstützt Etiketten für das Kommentieren von Abschnitten im Stil von Heredocs.

Inhaltsverzeichnis

• ? Installieren
• ? Schneller Start
• Anforderungen
• ? Community & Support
• ? Docker
• ? Anerkennung
• ? Beitragen
• Lizenz

---

? Installieren

go get github.com/dyne/tgcom

? Zurück nach oben

---

? Schneller Start

Grundbefehl

tgcom --file < filename > --line < line_number > --action < comment | uncomment | toggle >

Beispiele

Kommentieren Sie eine einzige Zeile

tgcom --file main.go --line 10 --action comment

Eine Reihe von Linien

tgcom --file main.go --lines 10-20 --action uncomment

Schalten Sie die Kommentare zu mehreren Dateien und Zeilen um

tgcom --files main.go:10-20,script.sh:4,index.html: # <p>,#</p> --action toggle

Verwenden von Stdin

cat main.go | tgcom --line 10 --action comment

Verwenden von Etiketten für Abschnitte

tgcom --file main.go --start-label START --end-label END --action comment

? Zurück nach oben

---

Anforderungen

1. Sprachunterstützung :

   • Die Software muss zumindest JavaScript, Go und Bash unterstützen, um Zeilen zu kommentieren/zu überzeugen/umzuschalten.
   • Es sollte erweiterbar sein, zusätzliche Programmiersprachen zu unterstützen.

2. Dateibehandlung :

   • Akzeptieren Sie Dateinamen als Eingabe und arbeiten Sie an Streams von Stdin.
   • Ersetzen Sie die vorgenommenen Dateien nach Änderungen.
   • Erstellen Sie eine Sicherung der Originaldatei, bevor Sie Änderungen vornehmen.
   • Geben Sie eine trockene Option zur Drucken der Änderungen an STDOut an, anstatt die vorhandenen Dateien zu ändern.

3. Kommentarfunktionalität :

   • Kommentar, Unterkunft und Umschalten von Kommentaren für:
     • Einzelne Linien
     • Zeilenbereiche
     • Eine Mischung aus einzelnen Linien und Bereichen
   • Akzeptieren Sie Etiketten für Kommentare von Abschnitten wie Heredocs mit einem Start -Keyword und einem End -Keyword in Quelldateien.

4. Leistung :

   • Das Tool muss schnell und effizient sein.
   • Vermeiden Sie es, die gesamte Datei in den Speicher zu laden.

5. Benutzeroberfläche :

   • Geben Sie eine Befehlszeilenschnittstelle (CLI) für die Benutzerinteraktion an.
   • Erlauben Sie der CLI, mehrere Dateien und komplexe Eingabespezifikationen wie main.js:10-20 script.sh:4 index.html:#<p>,#</p> zu verarbeiten.

6. Tests :

   • Fügen Sie Testeinheiten hinzu, um die Zuverlässigkeit und Korrektheit der Software sicherzustellen.
   • Tests sollten verschiedene Szenarien und Randfälle abdecken.

? Zurück nach oben

---

? Community & Support

Dokumentation - Erste Schritte und mehr.

? Ökosystem - Plugins, Ressourcen und mehr.

Probleme - Fehler beenden Fehler mit TGCOM.

Diskussionen - Holen Sie sich Hilfe, stellen Sie Fragen, Anfragen von Funktionen und besprechen Sie TGCOM.

[] Matrix - mit der Community rumhängen.

Zwietracht - mit der Gemeinschaft rumhängen.

? Telegramm - mit der Community rumhängen.

Beispiel - Ein Beispiel -Repository, das TGCOM verwendet.

? Zurück nach oben

---

? Docker

Bitte beachten Sie Docker -Pakete

? Zurück nach oben

---

? Anerkennung

Copyleft? 2023 von Dyne.org Foundation, Amsterdam

Entworfen, geschrieben und gepflegt von Puria Nafisi Azizi.

? Zurück nach oben

---

? Beitragen

Bitte werfen Sie dann zuerst einen Blick auf die LIZENTUREL -Vertrag von dyne.org - Mitwirkenden

1. ? Gib es
2. Erstellen Sie Ihre Feature Branch git checkout -b feature/branch
3. Bestimmen Sie Ihre Änderungen git commit -am 'feat: New featurencloses #398'
4. Drücken Sie zum Zweig git push origin feature/branch
5. Erstellen Sie eine neue Pull Request gh pr create -f
6. Danke

? Zurück nach oben

---

Lizenz

 tgcom - toggle comments in source files
Copyleft ? 2023 Dyne.org foundation, Amsterdam

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

? Zurück nach oben