tgcom

TGCOM

切換源文件中的註釋

---

tgcom是一種命令行工具，旨在在源代碼文件中註釋，不輸入和切換註釋。它支持多種語言，包括JavaScript，GO和Bash，並且可以擴展以支持更多語言。該工具可以處理單線，線範圍以及兩者的混合。它還支持從STDIN處理流的處理流，並在一個命令中處理多個文件和範圍。

TGCOM功能

• 註釋/不點菜/切換註釋：以單線，範圍或兩者的混合物進行操作。
• 多語言支持：支持JavaScript，GO，Bash，可以擴展到其他語言。
• 文件處理：與Stdin的文件名或流一起工作。
• 備份創建：在修改文件之前，會自動創建備份。
• 性能：快速有效，不會將整個文件加載到內存中。
• 部分的標籤：支持標籤以Heredocs風格評論部分。

目錄

• ？安裝
• ？快速開始
• 要求
• ？社區和支持
• ？ Docker
• ？致謝
• ？貢獻
• 執照

---

？安裝

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和源文件中的終點關鍵字。

4. 表現：

   • 該工具必須快速有效。
   • 避免將整個文件加載到內存中。

5. 使用者介面:

   • 為用戶交互提供命令行接口（CLI）。
   • 允許CLI處理多個文件和復雜的輸入規格，例如main.js:10-20 script.sh:4 index.html:#<p>,#</p> 。

6. 測試：

   • 包括測試單元以確保軟件的可靠性和正確性。
   • 測試應涵蓋各種情況和邊緣案例。

？回到頂部

---

？社區和支持

文檔- 入門甚至更多。

？生態系統- 插件，資源等。

問題- 錯誤結束使用TGCOM遇到的錯誤。

討論- 獲得幫助，提出問題，請求功能並討論TGCOM。

[]矩陣- 與社區閒逛。

不和諧- 與社區閒逛。

？電報- 與社區閒逛。

示例- 使用TGCOM的示例存儲庫。

？回到頂部

---

？ Docker

請參考Docker軟件包

？回到頂部

---

？致謝

copyleft？ 2023年，阿姆斯特丹Dyne.org基金會

由Puria Nafisi Azizi設計，編寫和維護。

？回到頂部

---

？貢獻

請首先查看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/>.

？回到頂部