インストーラー同梱用のキーワードファイルをUTF-8テキストに変換する

[berryzplus]

PR の目的

.gitattributes に text 扱いとする拡張子を追加して、
インストーラー同梱用のキーワードファイルを登録しなおします。

現在バイナリ扱いで登録されているキーワードファイルを、テキストと認識できるように設定します。
同時に、キーワードファイルをテキストとして扱う上で問題が起きないように、文字コードをUTF-8BOM付きに変換します。

カテゴリ

• その他

PR の背景

これは #133 の残件対応です。

＜経緯＞

1. sf.net時代のリポジトリでは installer が別管理になっていた。
2. installer のプロジェクトでは同梱するファイル群が zip に固められていた。
3. GitHub に移行して CI環境 を組んだときに sinst_src.zip をバラで登録し直した(sinst_src.zip を展開して登録する #133)。
4. sinst_src.zip の中身は「やや問題あり」な内容だったけど、「一度は現状のままで入れよう」になって「やや問題あり」が先送りされてマージされた。
5. その後、なんもしとらんので「やや問題あり」のまま...orz

以下、関係ありそうな議論抜粋。

#133 (comment)

キーワードファイルが激しく文字化けしているが
utf8 化しても問題無いのだろうか？

ただこのファイルはユーザーもローカルで
編集できるのでその辺も考慮が必要

#133 (comment)

BOMがあったらutf-8、なければSJIS想定で読み込む仕様のようです。

#133 では keyword フォルダ以外のファイルについても話していますが、
この PR では keyword フォルダ配下のファイルを正しく扱えるように変更を行います。

PR のメリット

• インストーラー同梱用キーワードファイルがテキスト扱いされるようになります。
  • 変更を加えた場合に、差分が表示されるようになります。

PR のデメリット (トレードオフとかあれば)

• インストーラー同梱用キーワードファイルがテキスト扱いされるようになります。
  • 拡張子ごとの文字コードを統一する必要があるため変換を行います。
    • 従来はShift_JIS、一部UTF-8でした。
    • 文字コードを統一する必要があったため、Shift_JIS⇒UTF-8変換を行います。
  • gitが「ファイルをテキスト扱いする」とは、リポジトリ内の改行コードがLFに統一されることを意味します。
    • 一般的にWindowsユーザーは改行コードの違いに疎いので問題ないと考えられます。
    • 玄人な人向けに、このリポジトリの前提が autoCRLF = true であることを周知すべきです。

デメリットに色々と書きましたが、「実害はない」と思っています。

PR の影響範囲

• インストーラー同梱用キーワードファイルの文字コードがUTF-8になります。
  • GitHubがファイル差分を表示できるようになります。
• インストーラーで配布されるキーワードファイルの文字コードがUTF-8になります。
  • サポートされるキーワードファイルの文字コードは、Shift_JISまたはUTF-8BOM付きなので機能的には影響ありません。
• アプリ(=サクラエディタ)の機能に影響はありません。

関連チケット

#133 sinst_src.zip を展開して登録する
#141 keyword以下のファイルの整理

参考情報

[AppVeyorBot]

✅ Build sakura 1.0.2204 completed (commit 1fa79ac233 by @berryzplus)

[beru]

簡単に動作確認しましたが問題無さそうです。

github で文字化けせずに見れるようになって良いと思います。

[berryzplus]

レビューありがとうございます。
何か問題あれば別PRで対応します。