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

？回到顶部