tgcom

tgcom

Basculer les commentaires dans les fichiers source

---

tgcom est un outil de ligne de commande conçu pour commenter, décommenter et basculer les commentaires dans les fichiers de code source. Il prend en charge plusieurs langues, notamment JavaScript, Go et Bash, et peut être étendu pour en soutenir davantage. L'outil peut gérer des lignes uniques, des gammes de lignes et un mélange des deux. Il prend également en charge la gestion des flux de STDIN et traite plusieurs fichiers et plages dans une commande.

Fonctionnalités TGCOM

• Commentaires / non-comment / Toggle Commentaires : Opérez sur des lignes uniques, des gammes ou un mélange des deux.
• Support multi-langues : prend en charge JavaScript, go, bash et peut être étendu à d'autres langues.
• Manipulation de fichiers : fonctionne avec des noms de fichiers ou des flux à partir de stdin.
• Création de sauvegarde : crée automatiquement une sauvegarde avant de modifier un fichier.
• Performances : rapide et efficace, ne charge pas le fichier entier en mémoire.
• Étiquettes pour les sections : prend en charge les étiquettes pour commenter les sections dans le style des heredocs.

Table des matières

• ? Installer
• ? Démarrage rapide
• Exigences
• ? Communauté et soutien
• ? Docker
• ? Remerciements
• ? Contributif
• Licence

---

? Installer

go get github.com/dyne/tgcom

? Retour en haut

---

? Démarrage rapide

Commande de base

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

Exemples

Commenter une seule ligne

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

Décommente une gamme de lignes

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

Basculer les commentaires sur plusieurs fichiers et lignes

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

Utilisation de stdin

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

Utilisation d'étiquettes pour sections

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

? Retour en haut

---

Exigences

1. Support linguistique :

   • Le logiciel doit prendre en charge au moins JavaScript, Go et Bash pour les lignes de commentaires / non commentaires / bascules.
   • Il devrait être extensible de prendre en charge des langages de programmation supplémentaires.

2. Manipulation des fichiers :

   • Acceptez les noms de fichiers en entrée et travaillez sur les flux de STDIN.
   • Remplacez les fichiers en place après avoir apporté des modifications.
   • Créez une sauvegarde du fichier d'origine avant d'apporter des modifications.
   • Fournissez une option à sec pour imprimer les modifications de STDOUT au lieu de modifier les fichiers en place.

3. COMMENTATION DES FONCTIONNALITÉS :

   • Commentaires, non-comment et commentaires pour:
     • Lignes uniques
     • Gammes de lignes
     • Un mélange de lignes uniques et de plages
   • Acceptez des étiquettes pour commentaire des sections, telles que Heredocs avec un mot-clé de démarrage et un mot-clé final dans les fichiers source.

4. Performance :

   • L'outil doit être rapide et efficace.
   • Évitez de charger le fichier entier en mémoire.

5. Interface utilisateur :

   • Fournissez une interface de ligne de commande (CLI) pour l'interaction utilisateur.
   • Permettez à la CLI de gérer plusieurs fichiers et des spécifications d'entrée complexes, telles que main.js:10-20 script.sh:4 index.html:#<p>,#</p> .

6. Tests :

   • Incluez les unités de test pour garantir la fiabilité et l'exactitude du logiciel.
   • Les tests doivent couvrir divers scénarios et cas de bord.

? Retour en haut

---

? Communauté et soutien

Documentation - Début et plus encore.

? Écosystème - plugins, ressources, etc.

Problèmes - Les bogues finissent les erreurs que vous rencontrez à l'aide de TGCOM.

Discussions - Obtenez de l'aide, posez des questions, demandez des fonctionnalités et discutez de TGCOM.

[] Matrix - passer du temps avec la communauté.

Discord - traîner avec la communauté.

? Télégramme - traîner avec la communauté.

Exemple - Un exemple de référentiel qui utilise TGCOM.

? Retour en haut

---

? Docker

Veuillez vous référer aux packages Docker

? Retour en haut

---

? Remerciements

Copyleft? 2023 par Dyne.org Foundation, Amsterdam

Conçu, écrit et entretenu par Puria Nafisi Azizi.

? Retour en haut

---

? Contributif

Veuillez d'abord jeter un œil au Contrat de licence Dyne.org - Contributeur puis

1. ? Le fourrer
2. Créez votre fonctionnalité git checkout -b feature/branch
3. Commissez vos modifications git commit -am 'feat: New featurencloses #398'
4. Poussez à la branche git push origin feature/branch
5. Créer une nouvelle demande de traction gh pr create -f
6. Merci

? Retour en haut

---

Licence

 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/>.

? Retour en haut