tgcom

TGCOM

Переключить комментарии в исходных файлах

---

tgcom -это инструмент командной строки, предназначенный для комментирования, неуместных и переключения комментариев в файлах исходного кода. Он поддерживает несколько языков, включая JavaScript, Go и Bash, и может быть расширен, чтобы поддержать больше. Инструмент может обрабатывать отдельные линии, диапазоны линий и сочетание обоих. Он также поддерживает обработку потоков от Stdin и обрабатывает несколько файлов и диапазонов в одной команде.

функции TGCOM

• Комментарий/неуместный/переключатель Комментарии : работайте на отдельных линиях, диапазонах или смесь обоих.
• Многоязычная поддержка : поддерживает JavaScript, Go, Bash и может быть расширен на другие языки.
• Обработка файлов : работает с именами файлов или потоков от Stdin.
• Создание резервного копирования : автоматически создает резервную копию перед изменением файла.
• Производительность : быстро и эффективно, не загружает весь файл в память.
• Ярлыки для разделов : поддерживает этикетки для комментирования разделов в стиле Heredocs.

Оглавление

• ? Установить
• ? Быстрый старт
• Требования
• ? Сообщество и поддержка
• ? Докер
• ? Благодарности
• ? Внося
• Лицензия

---

? Установить

go get github.com/dyne/tgcom

? Вернуться к вершине

---

? Быстрый старт

Базовая команда

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

Примеры

Прокомментируйте одну строку

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

Неудобно

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

Переключить комментарии к нескольким файлам и линиям

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

Используя stdin

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

Использование меток для разделов

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

? Вернуться к вершине

---

Требования

1. Языковая поддержка :

   • Программное обеспечение должно поддерживать как минимум JavaScript, Go и Bash для комментирования/некомментирования/переключения линий.
   • Это должно быть расширяется для поддержки дополнительных языков программирования.

2. Обработка файлов :

   • Примите имена файлов в качестве ввода и работайте над потоками из Stdin.
   • Замените файлы на месте после внесения изменений.
   • Создайте резервную копию исходного файла, прежде чем вносить какие -либо изменения.
   • Предоставьте вариант сухого запуска, чтобы распечатать изменения в Stdout, а не изменять файлы на месте.

3. Комментирование функциональности :

   • Комментарий, неуместный и переключайте комментарии к:
     • Отдельные линии
     • Диапазоны линий
     • Смесь отдельных линий и диапазонов
   • Примите этикетки для комментирования разделов, таких как Heredocs с ключевым словом Start и ключевым словом конечного в исходных файлах.

4. Производительность :

   • Инструмент должен быть быстрым и эффективным.
   • Избегайте загрузки всего файла в память.

5. Пользовательский интерфейс :

   • Предоставьте интерфейс командной строки (CLI) для взаимодействия с пользователем.
   • Разрешите CLI обрабатывать несколько файлов и сложные входные спецификации, такие как main.js:10-20 script.sh:4 index.html:#<p>,#</p> .

6. Тестирование :

   • Включите тестовые единицы, чтобы обеспечить надежность и правильность программного обеспечения.
   • Тесты должны охватывать различные сценарии и краевые случаи.

? Вернуться к вершине

---

? Сообщество и поддержка

Документация - начало работы и многое другое.

? Экосистема - плагины, ресурсы и многое другое.

Проблемы - Ошибки ошибок, с которыми вы сталкиваетесь с использованием TGCOM.

Обсуждения - Получите помощь, задайте вопросы, запросы и обсудите TGCOM.

[] Матрица - тусоваться с сообществом.

Раздор - тусоваться с сообществом.

? Телеграмма - тусуется с сообществом.

Пример - пример репозитория, который использует TGCOM.

? Вернуться к вершине

---

? Докер

Пожалуйста, обратитесь к пакетам Docker

? Вернуться к вершине

---

? Благодарности

Copyleft? 2023 от Dyne.org Foundation, Амстердам

Разработано, написано и поддерживается Пурией Нафиси Азизи.

? Вернуться к вершине

---

? Внося

Сначала посмотрите на лицензионное соглашение Dyne.org - лицензионное соглашение о участнике

1. ? Разветвляй это
2. Создайте свою функцию филиала git checkout -b feature/branch
3. Совершить свои изменения git commit -am 'feat: New featurencloses #398'
4. Нажмите к git push origin feature/branch
5. Создайте новый запрос на тягу gh pr create -f
6. Спасибо

? Вернуться к вершине

---

Лицензия

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

? Вернуться к вершине