tgcom

TGCOM

alternar comentários em arquivos de origem

---

tgcom é uma ferramenta de linha de comando projetada para comentar, descomentar e alternar comentários nos arquivos de código-fonte. Ele suporta vários idiomas, incluindo JavaScript, Go e Bash, e pode ser estendido para apoiar mais. A ferramenta pode lidar com linhas únicas, faixas de linhas e uma mistura de ambos. Ele também suporta lidar com fluxos da Stdin e processa vários arquivos e intervalos em um comando.

Recursos TGCOM

• Comentário/Uncomment/alternar Comentários : Opere em linhas únicas, intervalos ou uma mistura de ambos.
• Suporte de vários idiomas : suporta JavaScript, Go, Bash e pode ser estendido a outros idiomas.
• Manuseio de arquivos : funciona com nomes de arquivos ou fluxos da Stdin.
• Criação de backup : cria automaticamente um backup antes de modificar um arquivo.
• Desempenho : rápido e eficiente, não carrega o arquivo inteiro na memória.
• Rótulos para seções : suporta rótulos para comentar seções no estilo de heredocs.

Índice

• ? Instalar
• ? Início rápido
• Requisitos
• ? Comunidade e apoio
• ? Docker
• ? Agradecimentos
• ? Contribuindo
• Licença

---

? Instalar

go get github.com/dyne/tgcom

? de volta ao topo

---

? Início rápido

Comando básico

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

Exemplos

Comente uma única linha

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

Descomment uma variedade de linhas

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

Alternar comentários em vários arquivos e linhas

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

Usando stdin

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

Usando rótulos para seções

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

? de volta ao topo

---

Requisitos

1. Suporte ao idioma :

   • O software deve suportar pelo menos JavaScript, GO e Bash para comentar/descomportar as linhas.
   • Deve ser extensível para suportar linguagens de programação adicionais.

2. Manuseio de arquivos :

   • Aceite os nomes de arquivos como entrada e trabalho em fluxos da Stdin.
   • Substitua os arquivos no local após fazer alterações.
   • Crie um backup do arquivo original antes de fazer alterações.
   • Forneça uma opção a seco para imprimir as alterações no stdout em vez de modificar os arquivos no lugar.

3. Comentando funcionalidade :

   • Comentário, descomment e alternar comentários para:
     • Linhas únicas
     • Faixas de linhas
     • Uma mistura de linhas e intervalos
   • Aceite os rótulos para comentar seções, como heredocs com uma palavra -chave inicial e uma palavra -chave final nos arquivos de origem.

4. Desempenho :

   • A ferramenta deve ser rápida e eficiente.
   • Evite carregar o arquivo inteiro na memória.

5. Interface do usuário :

   • Forneça uma interface de linha de comando (CLI) para interação do usuário.
   • Deixe a CLI lidar com vários arquivos e especificações de entrada complexas, como main.js:10-20 script.sh:4 index.html:#<p>,#</p> .

6. Teste :

   • Inclua unidades de teste para garantir confiabilidade e correção do software.
   • Os testes devem cobrir vários cenários e casos de borda.

? de volta ao topo

---

? Comunidade e apoio

Documentação - Introdução e muito mais.

? ECOSYSTEM - Plugins, recursos e muito mais.

PROBLEMAS - ERROS ENCERTAMENTOS DE BUGS que você encontra usando o TGCOM.

Discussões - Obtenha ajuda, faça perguntas, solicite recursos e discuta o TGCOM.

[] Matrix - saindo com a comunidade.

Discord - saindo com a comunidade.

? Telegrama - saindo com a comunidade.

Exemplo - um repositório de exemplo que usa o TGCOM.

? de volta ao topo

---

? Docker

Consulte os pacotes do Docker

? de volta ao topo

---

? Agradecimentos

Copyleft? 2023 pela Fundação Dyne.org, Amsterdã

Projetado, escrito e mantido por Puria Nafisi Azizi.

? de volta ao topo

---

? Contribuindo

Por favor, primeiro dê uma olhada no contrato de licença Dyne.org - colaborador e depois

1. ? Bifurcá -lo
2. Crie seu ramo de recursos git checkout -b feature/branch
3. Comprometa suas alterações git commit -am 'feat: New featurencloses #398'
4. Empurre para o recurso git push origin feature/branch
5. Crie uma nova solicitação de tração gh pr create -f
6. Obrigado

? de volta ao topo

---

Licença

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

? de volta ao topo