Usage: emv [-c CONFIG] [-t TARGET] VALUE1 ...

Flags
  -c, --config string   Config file path. (default "emv.json")
  -t, --target string   The base directory to search for target files. If not specified, it is the same directory as the config file.
  -h, --help            Help.

設定ファイルに埋め込みのためのルールを記載し、そのルールに従って、CLIでのコマンドライン引数として指定されたものを埋め込みます。

例として下記のような設定を用意します。ファイル名はemv.jsonとしておきます。

{
  "values" : [
    { 
      "name" : "version"
    }
  ],
  "targets" : [
    {
      "files" : [
        "example.properties"
      ],
      "embeddeds" : [
        {
          "pattern" : "version=[0-9\\.]+",
          "replacement" : "version={{.version}}"
        }
      ]
    }
  ]
}

valuesで入力値(emvの引数として指定)の定義を行っています。
nameで入力値に対して名前(上記例だとversion)を付与しています。この名前を使って、replacementで入力値を参照することができます。

targetsで対象となるファイルや埋め込み内容を定義しています。
filesはターゲットとなるファイルです。相対パスとして指定した場合、デフォルトでは設定ファイルと同じディレクトリを基準とします。-tオプションで基準とするディレクトリを変更することができます。

embeddedsで埋め込むコンテンツを定義します。
patternは正規表現になります。patternをreplacementの値で置き換えます。
replacementには、{{.name}}のように入力値を埋め込むことができます。Goのtext/templateを利用しています。

https://pkg.go.dev/text/template

filesで指定しているexample.propertiesは下記のような内容です。

version=1.1.2

emv.jsonとexample.propertiesが配置されているフォルダで実行します。
2.0.0を埋め込みます。

$ emv 2.0.0
Embedded values:
  version=2.0.0
Files: ([U] Updated, [-] None)
  [U] example.properties

example.propertiesは下記のようになりました。

version=2.0.0

入力値の一部を利用する

入力値はpatternで正規表現の名前付きキャプチャを利用すると、別の名前として切り出すことができます。

  "values" : [
    { 
      "name" : "version",
      "pattern" : "^(?P<major>[0-9]+)\\.(?P<minor>[0-9]+)\\.(?P<revision>[0-9]+)$"
    }
  ],

たとえば上記の設定で2.1.2と入力した場合、下記のような名前と値のペアになります。

version : 1.2.3
major : 1
minor : 2
revision : 3

2021-12-07

Redmine View Customize Plugin のコード例を整理しました

[programming] Redmine

Redmine Advent Calendar 2021 - Adventar の7日目の記事になります。

View customizeのコード例を雑多に置いていたプロジェクトを整理しました。

View customizeとRedmineのバージョンが上がっていくにつれ、

もっと簡潔に書けるようになっている
Redmine自体に機能として用意されたので利用する意味がなくなった

ということがあったので、2021年9月頃から少しずつ整理をはじめ、最近その整理が一通り完了しました。

やったことは下記になります。

View customizeとRedmineともに最新のバージョンを対象にコードを書き直し
既にRedmine自体に存在するものは削除
全ての例に画面キャプチャ(アニメーションの方がわかりやすい場合はアニメーションGIF)を用意
英語＋日本語で書くように(といっても文章は少なめで💦)

また、トップページに注意事項等も明記するようにしました。

「このプロジェクトはView customizeのコードの書き方やコード例に関する質問をする場所で、コード作成を依頼する場所ではありません」
- 連続して同じようなものを教えて欲しい＆作って欲しい的なのが来てしまい、どうやら自分でまったくコード試してなさそうだな、、ってのがあったので、念のためです💦
- View customizeをいろんな人に使って欲しいと思っていて、出来るだけサポートしたいので、試してわからないことは気兼ねなくお尋ねください。
「このプロジェクトではPull Requestを受け付けていません」
- 他の方に作成していただいたスクリプトを確認し、また、今後もメンテナンスしていくのは今の時点だと困難だな、、と判断したためです。
  コミニティでメンテナンスしていくような仕組みが作れたらと思ったこともありますが、今の時点では気楽にやれる方法をとりたいと思います。
  - コミニティでやるならば、コード登録は自由で、それに対して他の人が自由にコメントできるようなものが良いなぁと思っているので、やるならば別の場所を用意するなど考えたいなと。
「GitHubスポンサーとしてのプロジェクト支援を受け付けています」
- もしもこれが役立って何かしたいってときにはぜひ！