README_Ja.md

VersioningUtils

バージョン管理下にあるファイルの一覧を取得します。Git と SVN 環境で利用できます。

単体テストで、リポジトリ内のファイルを全チェックするときに便利です。

使い方

1. NuGet パッケージを追加する

dotnet add package Versioning.Utils

2. ファイル一覧を取得する

string[] paths = await VersioningUtils.GetVersionedFiles();
Console.WriteLine(String.Join("\n", paths));
/*
C:/projects/VersioningUtils/.editorconfig
C:/projects/VersioningUtils/.github/workflows/ci.yml
C:/projects/VersioningUtils/.gitignore
C:/projects/VersioningUtils/LICENSE.txt
...
*/

動作環境

• .NET Core 3.0 以降 (.NET Standard 2.1)
  • 動作確認済み
    • Windows 10 + Visual Studio 2019
    • Windows 10 + VS Code
    • GitHub actions (Ubuntu-latest)
• 対応バージョン管理システム
  • git
    • git コマンドが利用可能な環境
    • GitHub Desktop がインストールされた環境
  • svn
    • svn コマンドが利用可能な環境
      • TortoiseSVN では、インストールオプションで "command line client tools" が選択されているときに相当
• 制限
  • svn
    • 非ASCII文字を含むパスは無視されます
    • 作業コピーのファイルが存在しない場合は無視されます

おまけ関数

• VersioningUtils.FindTrojanLetters(...)

  • この関数は Unicodeの制御文字を利用した悪意のあるソースコード を検出します.

  // 以下は、単体テストの実装例です
  var exts = new string[]{".cs"};
  var list = await VersioningUtils.FindTrojanLetters(exts);
  Assert.True(0 == list.Count(), $"不自然な制御文字を含むソースコードが見つかりました。\n{String.Join("\n----\n", list)}");