diff --git a/.github/workflows/dotnetcore3.yml b/.github/workflows/dotnetcore3.yml index e267c41..32fac62 100644 --- a/.github/workflows/dotnetcore3.yml +++ b/.github/workflows/dotnetcore3.yml @@ -1,6 +1,6 @@ name: .NET Core CI -on: [push] +on: [push, pull_request] jobs: build: diff --git a/PourOver.GlobalTool/PourOver.GlobalTool.csproj b/PourOver.GlobalTool/PourOver.GlobalTool.csproj index e36bdc0..dcef630 100644 --- a/PourOver.GlobalTool/PourOver.GlobalTool.csproj +++ b/PourOver.GlobalTool/PourOver.GlobalTool.csproj @@ -14,11 +14,7 @@ https://maroontress.github.io/PourOver/ https://github.com/maroontress/PourOver false - - PourOver is a command-line tool that diagnoses string resources stored in CSV - files expressed in multiple languages by comparing the tokens embedded in each - string between the languages. - + PourOver is a command-line tool that diagnoses string resources stored in CSV files expressed in multiple languages by comparing the tokens embedded in each string between the languages. See https://maroontress.github.io/PourOver/releasenotes.html diff --git a/README.ja_JP.md b/README.ja_JP.md index 82a012d..0f192c7 100644 --- a/README.ja_JP.md +++ b/README.ja_JP.md @@ -25,10 +25,10 @@ BYE,Bye,さようなら トークンは文字列リソースに組み込まれたプレイスホルダーで、ブレース(`{`と`}`)で囲まれた文字列です。例えば、次のような内容の文字列リソースがあるとします: -| ID | `English` | `Japanese` | -| :-- | :-- | :-- | -| `TIME` | `It's {hour} o'clock` | `{hour}時です` | -| `DEAR` | `Dear {name},` | `拝啓 {name} さん、` | +| ID | `English` | `Japanese` | +| :-- | :-- | :-- | +| `TIME` | `It's {hour} o'clock.` | `{hour}時です。` | +| `DEAR` | `Dear {name},` | `拝啓 {name} さん、`  | `TIME`の文字列リソースでは、どの言語においてもトークン`{hour}`が組み込まれ、表示する際に`{hour}`は現在の時刻の(時分秒の)時に置き換えられます。また、`DEAR`では、同様に`{name}`が組み込まれ、表示する際に`{name}`は人名に置き換えられます。 @@ -38,7 +38,11 @@ BYE,Bye,さようなら 診断メッセージは次のような形式になります: -> _ファイル名_ `:` _行番号_ `: ` _ID_ `: ` _診断メッセージ_ +> _ファイル名_ `:` _行番号_ `: ` _ID_ `: ` _メッセージ_ + +`--verbose`を指定すると次のような形式になります: + +> _ファイル名_ `:` _行番号_ `: ` _ID_ `: (` _診断ID_ `) ` _メッセージ_ ## トークンの診断 @@ -171,7 +175,7 @@ _FILE_.csvは前述した構造のCSVファイルです。 | | Option | | Description | |---:|:---|:---|:---| -| `-L`, | `--culture` | _CULTURE_ | カルチャーを指定します(例: `en_US`) | +| `-L`, | `--culture` | _CULTURE_ | カルチャーを指定します(例: `en-US`) | | `-h`, | `--help` | | ヘルプメッセージを表示して終了します | | `-b`, | `--ignore-blank` | | 空欄のフィールドを無視します | | `-v`, | `--verbose` | | 出力が冗舌になります | diff --git a/README.md b/README.md index 2daf9b8..6dd9e98 100644 --- a/README.md +++ b/README.md @@ -34,10 +34,10 @@ A token is a placeholder embedded in a string resource, which is a string enclosed in braces (`{` and `}`). For example, you have string resources as follows: -| ID | `English` | `Japanese` | -| :-- | :-- | :-- | -| `TIME` | `It's {hour} o'clock` | `{hour}時です` | -| `DEAR` | `Dear {name},` | `拝啓 {name} さん、` | +| ID | `English` | `Japanese` | +| :-- | :-- | :-- | +| `TIME` | `It's {hour} o'clock.` | `{hour}時です。` | +| `DEAR` | `Dear {name},` | `拝啓 {name} さん、` | The string resource `TIME` should include the token `{hour}` in all languages, and the token `{hour}` is assumed to be replaced with the hour of the current @@ -48,9 +48,13 @@ A string resource can contain multiple tokens. ## Diagnostic message -Each diagnostic message has the following format: +The format of each diagnostic message is as follows: -> _filename_ `:`_line_ `: ` _ID_ `: ` _diagnostic message_ +> _FILENAME_ `:`_LINE_ `: ` _ID_ `: ` _MESSAGE_ + +It is as follows when you specify the `--verbose` option: + +> _FILENAME_ `:`_LINE_ `: ` _ID_ `: (` _DIAGNOSTIC-ID_ `) ` _MESSAGE_ ## Token diagnostics @@ -204,7 +208,7 @@ Options are as follows: | | Option | | Description | |---:|:---|:---|:---| -| `-L`, | `--culture` | _CULTURE_ | Specify culture (e.g., `en_US`) | +| `-L`, | `--culture` | _CULTURE_ | Specify culture (e.g., `en-US`) | | `-h`, | `--help` | | Show help message and exit | | `-b`, | `--ignore-blank` | | Ignore blank fields | | `-v`, | `--verbose` | | Be verbose |