Merge branch 'devel'

Author: kekyo

README.ja.md

@@ -204,11 +204,10 @@ namespace global
 9. 以後、コードを変更してリリースの準備が出来たら、新たにタグをつければそれがAssemblyVersionに反映されるので、ビルドしてバイナリをリリースします。
    * dotnet cliを使用してNuGetのパッケージをビルドする場合にも、`PackageVersion`と`PackageReleaseNotes`は自動的に適用されます。完成してデプロイする場合は、`dotnet pack`コマンドを使えば、NuGetのバージョンを一元管理できます。
 
-----
 
-## ヒントや参考情報
+----
 
-### プレーンテキストフォーマットの出力
+### コマンドラインインターフェイス (CLI)
 
 RelaxVersionerは、dotnet CLI toolに対応しています。
 `rv`コマンドは、 `dotnet tool install -g rv-cli` でインストールすることが出来ます。
@@ -257,9 +256,24 @@ $ echo "@@@{commitId}@@@" | rv -r .
 $ rv -i input.txt -o output.txt .
 ```
 
+置き換えるキーワードの標準ブラケットは波括弧 '{ ... }' の形式ですが、異なるブラケット文字を使用することも出来ます。
+例えば、ドキュメントに適用する場合は、波括弧では誤検出を起こす可能性があるので、カスタムブラケットを指定して置き換えます:
+
+```bash
+# カスタムブラケットで置き換える
+# 左括弧と右括弧の定義をカンマで区切る
+$ echo "ABC#{commitId}#XYZ" | rv -r --bracket "#{,}#" .
+ABC0123456789abc ... XYZ
+```
+
 このCLIを使用すれば、.NETとは異なる対象に対してRelaxVersionerを組み合わせて使用できます。
 例えば、GitHub ActionsのようなCI/CD環境で、NPMパッケージ生成にバージョンを適用したり、テキストのドキュメントにバージョンを埋め込んだりすることが出来ます。
 
+
+----
+
+## ヒントや参考情報
+
 ### ビルド後にバージョン番号を使用する方法
 
 RelaxVersionerは、ビルド後に、以下の位置にファイルを保存します:
@@ -516,6 +530,8 @@ nuspecファイルを使ってパッケージを生成する場合は、デフ
 
 ## 履歴
 
+* 3.7.0:
+  * CLIでカスタムブラケット指定に対応しました。
 * 3.6.0:
   * プレーンテキスト出力のフォーマットを指定可能にしました
   * プレーンテキストを標準出力に出力できるようにしました。

README.md

@@ -199,11 +199,10 @@ namespace global
 9. Development cycles: next codes change and ready to release, you are tagging new version and then build, output binary auto tagged in AssemblyVersion and store informations.
    * We can apply with automated version number when "dotnet cli" for generate NuGet package (`PackageVersion` and `PackageReleaseNotes` attributes). You can use only `dotnet pack` command.
 
-----
 
-## Hints and Tips
+----
 
-### Output in plain text format
+## Command line interface (CLI)
 
 RelaxVersioner supports the dotnet CLI tool.
 The `rv` command can be installed with `dotnet tool install -g rv-cli`.
@@ -252,9 +251,25 @@ $ echo "@@@{commitId}@@@" | rv -r .
 $ rv -i input.txt -o output.txt .
 ```
 
+The standard bracket for the replacement keyword is in the form of braces '{ ... }', but different bracket characters can be used.
+For example, when applied to a document, braces can cause false positives, so a custom bracket is used to replace them:
+
+```bash
+# Replace with custom brackets
+# Separate left and right bracket definitions with commas
+$ echo "ABC#{commitId}#XYZ" | rv -r --bracket "#{,}#" .
+ABC0123456789abc ... XYZ
+```
+
+Translated with DeepL.com (free version)
 With this CLI, you can use a combination of RelaxVersioner for different targets than .NET.
 For example, in a CI/CD environment like GitHub Actions, you can apply versions to NPM package generation or embed versions in your text documentation.
 
+
+----
+
+## Hints and Tips
+
 ### How to use version numbers after building process
 
 RelaxVersioner saves the files in the following location after build:
@@ -495,6 +510,13 @@ When you are using a nuspec file to generate a NuGet package, there are addition
 
 ## History
 
+* 3.7.0:
+  * CLI now supports custom bracket specification.
+* 3.6.0:
+  * Plain text output format on CLI can now be specified
+  * Plain text on CLI can now be output to standard output.
+  * Added replace mode on CLI.
+  * Simplified the CLI version options to work with fewer specifications.
 * 3.5.0:
   * Added for specify the format of plain text output.
   * Plain text can now be output to standard output.

RelaxVersioner.Core/Processor.cs

@@ -38,6 +38,8 @@ public sealed class ProcessorContext
     public string PropertiesPath;
     public string TextFormat;
     public string ReplaceInputPath;
+    public string BracketStart;
+    public string BracketEnd;
     public bool IsDryRun;
 }
 

RelaxVersioner.Core/RelaxVersioner.Core.csproj

@@ -13,10 +13,10 @@
 
   <ItemGroup>
     <PackageReference Include="GitReader" Version="1.8.0" />
-    <PackageReference Include="NamingFormatter" Version="2.3.0" />
+    <PackageReference Include="NamingFormatter" Version="2.4.0" />
     <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.3" PrivateAssets="All" />
     <PackageReference Condition="'$(RV_BOOTSTRAP)' != 'True'"
-                      Include="RelaxVersioner" Version="3.5.0" PrivateAssets="all" />
+                      Include="RelaxVersioner" Version="3.6.0" PrivateAssets="all" />
   </ItemGroup>
 
   <ItemGroup>

RelaxVersioner.Core/Writers/SourceCodeWriteProviderBase.cs

@@ -56,7 +56,8 @@ private void Write(
                         CultureInfo.InvariantCulture,
                         rule.Format,
                         keyValues,
-                        key => string.Empty);
+                        key => string.Empty,
+                        new(context.BracketStart, context.BracketEnd));
                     if (!string.IsNullOrWhiteSpace(rule.Key))
                     {
                         this.WriteAttributeWithArguments(tw, rule.Name, rule.Key, formattedValue);
@@ -87,7 +88,8 @@ private void Write(
                                 CultureInfo.InvariantCulture,
                                 rule.Format,
                                 keyValues,
-                                key => string.Empty);
+                                key => string.Empty,
+                                new(context.BracketStart, context.BracketEnd));
                             if (!string.IsNullOrWhiteSpace(rule.Key))
                             {
                                 this.WriteLiteralWithArgument(tw, rule.Key, formattedValue);

RelaxVersioner.Core/Writers/TextReplaceProvider.cs

@@ -42,7 +42,8 @@ void Replace(TextReader tr, TextWriter tw)
                     CultureInfo.InvariantCulture,
                     line,
                     keyValues,
-                    key => string.Empty);
+                    key => string.Empty,
+                    new(context.BracketStart, context.BracketEnd));
 
                 tw.WriteLine(formattedLine);
             }

RelaxVersioner.Core/Writers/TextWriteProvider.cs

@@ -36,7 +36,8 @@ void Write(TextWriter tw, bool emitEol)
                 CultureInfo.InvariantCulture,
                 context.TextFormat,
                 keyValues,
-                key => string.Empty);
+                key => string.Empty,
+                new(context.BracketStart, context.BracketEnd));
 
             if (emitEol)
             {

RelaxVersioner.Tasks/RelaxVersioner.Tasks.csproj

@@ -29,7 +29,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.3" PrivateAssets="All" />
     <PackageReference Condition="'$(RV_BOOTSTRAP)' != 'True'"
-                      Include="RelaxVersioner" Version="3.5.0" PrivateAssets="all" />
+                      Include="RelaxVersioner" Version="3.6.0" PrivateAssets="all" />
   </ItemGroup>
 
 </Project>

RelaxVersioner/Program.cs

@@ -69,7 +69,16 @@ public static async Task<int> Main(string[] args)
                         context.ReplaceInputPath = v;
                         context.Language = "Replace";
                     }
-                }, 
+                },
+                { "bracket=", "enable custom bracket", v =>
+                    {
+                        if (v.Split(',') is { Length: 2 } splitted)
+                        {
+                            context.BracketStart = splitted[0];
+                            context.BracketEnd = splitted[1];
+                        }
+                    }
+                },
                 { "dryrun", "dryrun mode", _ => context.IsDryRun = true },
                 { "launchDebugger", "Launch debugger", _ => launchDebugger = true },
                 { "help", "help", v => help = v != null },

RelaxVersioner/RelaxVersioner.csproj

@@ -37,7 +37,7 @@
     <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.3" PrivateAssets="All" />
     <PackageReference Include="Mono.Options" Version="6.12.0.148" />
     <PackageReference Condition="'$(RV_BOOTSTRAP)' != 'True'"
-                      Include="RelaxVersioner" Version="3.5.0" PrivateAssets="all" />
+                      Include="RelaxVersioner" Version="3.6.0" PrivateAssets="all" />
   </ItemGroup>
 
   <ItemGroup>

rv-cli/rv-cli.csproj

@@ -27,13 +27,17 @@
   <ItemGroup>
     <PackageReference Include="Mono.Options" Version="6.12.0.148" />
     <PackageReference Condition="'$(RV_BOOTSTRAP)' != 'True'"
-                      Include="RelaxVersioner" Version="3.5.0" PrivateAssets="all" />
+                      Include="RelaxVersioner" Version="3.6.0" PrivateAssets="all" />
   </ItemGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\RelaxVersioner.Core\RelaxVersioner.Core.csproj" />
   </ItemGroup>
-  
+
+  <ItemGroup>
+    <None Include="..\Images\RelaxVersioner.100.png" Link="Images\RelaxVersioner.100.png" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
   <ItemGroup>
     <Compile Include="..\RelaxVersioner\*.cs" />
     <Compile Include="..\RelaxVersioner\Properties\*.cs" LinkBase="Properties\" />