snap2txt

snap2txt

SNAP2TXTは、プロジェクトディレクトリの構造と内容をキャプチャし、テキストファイルに保存するPythonユーティリティです。プロジェクトのファイルシステムをすばやくドキュメントするように設計されています。

特徴

• 完全なキャプチャ：プロジェクトのファイル構造全体と内容を記録します。
• カスタマイズ可能なフィルター：ターゲットスキャン用の無視およびホワイトリストのオプションを提供します。
• コマンドラインインターフェイス：シンプルで使いやすいコマンドラインツール。

インストール

PIPでsnap2txtをインストールします：

pip install snap2txt

注：インストールは、パッケージとともに.ilおよび.wlファイルを自動的に提供するようになりました。

使用法

プロジェクトディレクトリに移動して実行します。

snap2txt

デフォルトでは、SNAP2TXTは現在のフォルダー内のすべてのファイルとディレクトリをスキャンし、 project_contents.txtという出力ファイルを作成します。

.ilおよび.wlファイルを見つけます

SNAP2TXTの.ilおよび.wlファイルがシステムにインストールされている場所を確認する必要がある場合（たとえば、それらをカスタマイズするため）、実行してください。

snap2txt --show-locations

これにより、各ファイルへのフルパスが印刷されるため、必要に応じて開くか編集できます。

オプションフラグ

• --il ： .ilで定義されているリストを無視します。
• --wl ： .wlで定義されたホワイトリストを使用します。

例：

snap2txt --il

snap2txt --wl

構成

snap2txtは、フィルタリングのために2つのファイルを尊重します。

1. リスト（ .il ）を無視：特定のファイル/ディレクトリを除外します。
2. Whitelist（ .wl ） ：特定のファイル/ディレクトリのみを含めます。

デフォルトでは、snap2txtはパッケージディレクトリにBasic .ilと.wlインストールします。プロジェクトの動作を調整するには、それらのファイルを編集したり、独自のカスタムルールに置き換えることができます。

ヒント：これらのファイルがインストールされている場所をすばやく見つけるには、 snap2txt --show-locationsを使用します。

例.ilファイル

 node_modules/
*.log

例.wlファイル

 *.py
*.md

貢献

SNAP2TXTへの貢献は大歓迎です！リポジトリをフォークし、変更を加え、プルリクエストを送信してください。

ライセンス

SNAP2TXTは、MITライセンスに基づいてライセンスされているオープンソースソフトウェアです。

サポート

サポート、質問、またはフィードバックについては、GitHubリポジトリで問題を開いてください。