tgcom

TGCOM

ソースファイルのコメントを切り替えます

---

tgcom 、ソースコードファイルのコメント、コメント、およびトグルをコメントし、コメントし、切り替えるように設計されたコマンドラインツールです。 JavaScript、Go、Bashなどの複数の言語をサポートし、さらにサポートするために拡張できます。このツールは、単一の線、範囲の線、および両方の混合を処理できます。また、Stdinからのストリームの処理をサポートし、1つのコマンドで複数のファイルと範囲を処理します。

TGCOM機能

• コメント/除外/トグルコメント：単一の行、範囲、または両方の混合物で動作します。
• 多言語サポート：JavaScript、Go、Bash、および他の言語に拡張できます。
• ファイル処理：stdinのファイル名またはストリームで動作します。
• バックアップ作成：ファイルを変更する前に、バックアップを自動的に作成します。
• パフォーマンス：高速かつ効率的で、ファイル全体をメモリにロードしません。
• セクションのラベル：ヘレドックのスタイルでセクションにコメントするラベルをサポートしています。

目次

• ？インストール
• ？クイックスタート
• 要件
• ？コミュニティとサポート
• ？ 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. コメント機能：

   • コメント、uncomment、およびトグルコメント：
     • 単一行
     • 線の範囲
     • 単一の線と範囲の混合
   • STARTキーワードとソースファイルのエンドキーワードを備えたHeredocsなどのセクションにコメントするラベルを受け入れます。

4. パフォーマンス：

   • ツールは迅速かつ効率的でなければなりません。
   • ファイル全体をメモリにロードしないでください。

5. ユーザーインターフェイス：

   • ユーザーインタラクション用のコマンドラインインターフェイス（CLI）を提供します。
   • CLIが複数のファイルとmain.js:10-20 script.sh:4 index.html:#<p>,#</p>などの複雑な入力仕様を処理できるようにします。

6. テスト：

   • ソフトウェアの信頼性と正しさを確保するために、テストユニットを含めます。
   • テストでは、さまざまなシナリオとエッジケースをカバーする必要があります。

？トップに戻ります

---

？コミュニティとサポート

ドキュメント- 始めましょう。

？エコシステム- プラグイン、リソースなど。

問題- TGCOMを使用して遭遇するバグの終了エラー。

ディスカッション- ヘルプを取得し、質問をし、機能をリクエストし、TGCOMについて話し合います。

[]マトリックス- コミュニティとの付き合い。

不一致- コミュニティとの付き合い。

？ Telegram-コミュニティとの付き合い。

例-TGCOMを使用する例リポジトリ。

？トップに戻ります

---

？ Docker

Dockerパッケージを参照してください

？トップに戻ります

---

？謝辞

copyleft？ 2023年、アムステルダムのdyne.org財団

Puria nafisi aziziによって設計、書かれ、維持されています。

？トップに戻ります

---

？貢献

最初にdyne.org-貢献者ライセンス契約をご覧ください。

1. ？フォーク
2. 機能ブランチgit checkout -b feature/branchを作成します
3. commit your your shange 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/>.

？トップに戻ります