programs2single_md プログラム仕様
指定されたディレクトリ以下のファイルを検索し、コンテンツをMarkdown形式で結合するスクリプトです。
複数のファイルを一つの、または複数のMarkdownファイルに結合し、
各ファイルのコンテンツをMarkdownのセクションとして追加します。
指定されたバイト数を超えると、新しいMarkdownファイルが自動的に作成されます。
関連リンク: programs2single_md.py テクニカルドキュメント
-
converter.programs2single_md.create_markdown_from_files(root_dir, filemasks, max_bytes, prefix)[ソース]
指定された条件でファイルを検索し、その内容をMarkdownファイルに保存します。
検索は指定されたルートディレクトリから開始され、指定されたファイルマスクに一致するファイルのみが対象となります。
各ファイルのコンテンツはMarkdown形式で整形され、指定された最大バイト数を超えないように複数の出力ファイルに分割されることがあります。
- パラメータ:
root_dir (str) -- 検索を開始するルートディレクトリのパス。
filemasks (str) -- ファイルマスクのセミコロン区切りリスト (例: ".py;.js")。
これらのマスクのいずれかに一致するファイルが処理対象となります。
max_bytes (int) -- 各Markdownファイルの最大バイト数。この値を超えると新しいMarkdownファイルが作成されます。
prefix (str) -- 出力ファイルのベース名。出力ファイルは "{prefix}_{0001}.md" のようになります。
- 戻り値:
None
- 戻り値の型:
None
-
converter.programs2single_md.find_output_filename(template, idx)[ソース]
指定されたテンプレートとインデックスに基づき、未使用の出力ファイルパスを生成します。
生成されたファイルパスが既に存在する場合は、インデックスを増やして新しいパスを生成し直します。
ファイルが存在しないパスが見つかるまでこの処理を繰り返します。
- パラメータ:
-
- 戻り値:
未使用の出力ファイルパスと、次に使用すべきインデックス。
- 戻り値の型:
tuple[str, int]
-
converter.programs2single_md.main()[ソース]
コマンドライン引数を解析し、ファイルからMarkdownを生成するメイン処理を実行します。
この関数は、`argparse`モジュールを使用してコマンドライン引数を定義および解析し、
`create_markdown_from_files`関数を適切な引数で呼び出します。
- 戻り値:
None
- 戻り値の型:
None