ライセンス通知を追加するツールを作成 #236

Takym · 2021-06-13T01:47:25Z

Issue 番号

目的

ライセンス通知をファイルの先頭に追加してくれるツールを作成しました。
~~現段階では C# ソースファイルにのみ対応しています。~~ → リポジトリ内の多くのファイルに対応しています。

破壊的変更をもたらしますか

[ ] Yes
[x] No

Pull Request の種類

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[x] Documentation content changes
[ ] Other... Please describe:

検証方法

コードの入手

git clone https://github.com/Takym/cocoa.git
cd cocoa
git checkout tools/header
dotnet restore

コードの検証

cd Tools
AddLicenseHeader

確認事項

予めC#インタラクティブ(csi.exe)へパスを通しておく必要があります。
Linux で実行する場合は dotnet-script をインストールする必要があります。
~~現在は Windows でのみ実行できます。~~ → Linux にも対応しました。

Internal IDs:

NFR 2704

Takym · 2021-06-13T01:47:50Z

C# インタラクティブではなく dotnet-script を使う形に変更します。

Takym · 2021-06-13T02:10:11Z

Linux 向けに dotnet-script を利用したシェルスクリプトを作成しました。
dotnet-script は事前にインストールしておく必要があります。

Takym · 2021-06-14T15:41:37Z

実際に AddLicenseHeader を適用したものはこちらになります。（一部のファイルは手動で修正しています。）

https://github.com/Takym/cocoa/tree/tools/header_applied
#245

Takym · 2021-06-21T13:04:56Z

非 Windows 環境では #237 を使用する事にして、こちらのPRでは Windows 限定で対応する事とします。

Takym

コードの説明を書きました。ご確認宜しくお願いします。

Tools/AddLicenseHeader.csx

Takym · 2021-06-21T13:11:35Z

Tools/AddLicenseHeader.csx

+			var result = AddHeader(data, ext switch {
+				// 拡張子毎にライセンス通知の書式を設定する。
+				".cs"         => CreateCStyleHeader,
+				".csx"        => CreateCStyleHeader,


ここでファイル毎の書式を設定しています。

Tools/AddLicenseHeader.csx

Takym · 2021-06-21T13:15:46Z

Tools/AddLicenseHeader.csx

+public const string XML_HEADER_1 = "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>";
+public const string XML_HEADER_2 = "<?xml version=\"1.0\" encoding=\"utf-8\"?>";
+public const string SH_HEADER    = "#!/bin/bash";


ライセンス通知より前に記述する必要のあるヘッダーの定義です。

Takym · 2021-06-21T13:16:24Z

Tools/AddLicenseHeader.csx

+const string HEADER_LINE_1 = "This Source Code Form is subject to the terms of the Mozilla Public";
+const string HEADER_LINE_2 = "License, v. 2.0. If a copy of the MPL was not distributed with this";
+const string HEADER_LINE_3 = "file, You can obtain one at https://mozilla.org/MPL/2.0/.";


ライセンス通知の定義です。

Takym · 2021-06-21T13:18:55Z

Tools/AddLicenseHeader.csx

+/// <summary>C言語のブロックコメントと同じ書式で記述できる言語用のライセンス通知を作成する</summary>
+public static string CreateCStyleHeader(string line1, string line2, string line3)
+{
+	return "/* " + line1 + "\n * " + line2 + "\n * " + line3 + " */\n";
+}
+
+/// <summary>XMLのコメントと同じ書式で記述できる言語用のライセンス通知を作成する</summary>
+public static string CreateXMLStyleHeader(string line1, string line2, string line3)
+{
+	return XML_HEADER_1 + "\n<!-- " + line1 + "\n   - " + line2 + "\n   - " + line3 + " -->\n";
+}
+
+/// <summary>XMLのコメントと同じ書式で記述できる言語用のライセンス通知を作成する</summary>
+/// <remarks>XML宣言とライセンス通知の間に空行を挿入する</remarks>
+public static string CreateXMLStyleHeaderWithAlign(string line1, string line2, string line3)
+{
+	return XML_HEADER_2 + "\n\n\n<!-- " + line1 + "\n   - " + line2 + "\n   - " + line3 + " -->\n";
+}
+
+/// <summary>バッチファイル用のライセンス通知を作成する</summary>
+public static string CreateBatchFileStyleHeader(string line1, string line2, string line3)
+{
+	return "@REM " + line1 + "\n@REM " + line2 + "\n@REM " + line3 + "\n";
+}
+
+/// <summary>シェルスクリプト用のライセンス通知を作成する</summary>
+/// <remarks><c>Shebang</c> を挿入する</remarks>
+public static string CreateShellScriptStyleHeaderWithShebang(string line1, string line2, string line3)
+{
+	return SH_HEADER + "\n" + CreateShellScriptStyleHeader(line1, line2, line3);
+}
+
+/// <summary>シェルスクリプトのコメントと同じ書式で記述できる言語用のライセンス通知を作成する</summary>
+public static string CreateShellScriptStyleHeader(string line1, string line2, string line3)
+{
+	return "# " + line1 + "\n# " + line2 + "\n# " + line3 + "\n";
+}


ファイル毎に合わせたライセンス通知を生成しています。

40〜53行目から参照されています。

Takym · 2021-06-21T13:20:55Z

Tools/AddLicenseHeader.csx

+/// <summary>除外設定</summary>
+public static bool Ignore(string file)
+{
+	return file.EndsWith(".designer.cs")
+		|| file.EndsWith(".Designer.cs")
+		|| file.EndsWith(".feature.cs")
+		|| file.Contains("Xamarin.ExposureNotification")
+		|| file.Contains("bin")
+		|| file.Contains("Bin")
+		|| file.Contains("obj")
+		|| file.Contains("Obj")
+		|| file.Contains(".github");
+}


除外するファイルを指定しています。

…ols/header

…ader/AddLicenseHeader.csx

Takym added 2 commits June 11, 2021 18:28

ツール「AddLicenseHeader」作成

fd63d56

AddLicenseHeader を修正

b8393a8

Linux 向けの AddLicenseHeader を作成

8cc12d2

keiji assigned Takym Jun 13, 2021

Meiryo7743 mentioned this pull request Jun 13, 2021

Add scripts to insert the MPL notification #237

Open

4 tasks

AddLicenseHeader、対応する書式を追加

3830ad2

Takym commented Jun 21, 2021

View reviewed changes

Takym added 5 commits June 22, 2021 00:46

Update AddLicenseHeader.csx

e520363

ディレクトリ構造変更

5bc29b9

.feature の書式に対応

8f77414

.feature ファイル向けのライセンス通知の書式を設定

24c7c0d

Merge branch 'tools/header' of https://github.com/Takym/cocoa into to…

da62514

…ols/header

This was referenced Jun 22, 2021

[DO NOT MERGE] Tools/header applied 【#236 の実行結果の参考】 #245

Draft

ライセンス通知の自動付与ツールを作成する #255

Open

ライセンス通知存否の判定方法を変更

97547d7

cocoa-dev added the confirmed 開発内部管理用 label Jun 28, 2021

Rename Tools/AddLicenseHeader/AddLicenseHeader.csx to Tools/LicenseHe…

90d072d

…ader/AddLicenseHeader.csx

keiji changed the base branch from develop to feature/license_tools July 6, 2021 07:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ライセンス通知を追加するツールを作成 #236

ライセンス通知を追加するツールを作成 #236

Takym commented Jun 13, 2021 •

edited by cocoa-dev

Loading

Takym commented Jun 13, 2021

Takym commented Jun 13, 2021

Takym commented Jun 14, 2021 •

edited

Loading

Takym commented Jun 21, 2021

Takym left a comment

Takym Jun 21, 2021

Takym Jun 21, 2021

Takym Jun 21, 2021

Takym Jun 21, 2021

Takym Jun 21, 2021

Takym Jun 21, 2021

ライセンス通知を追加するツールを作成 #236

Are you sure you want to change the base?

ライセンス通知を追加するツールを作成 #236

Conversation

Takym commented Jun 13, 2021 • edited by cocoa-dev Loading

Issue 番号

目的

破壊的変更をもたらしますか

Pull Request の種類

検証方法

コードの入手

コードの検証

確認事項

Takym commented Jun 13, 2021

Takym commented Jun 13, 2021

Takym commented Jun 14, 2021 • edited Loading

Takym commented Jun 21, 2021

Takym left a comment

Choose a reason for hiding this comment

Takym Jun 21, 2021

Choose a reason for hiding this comment

Takym Jun 21, 2021

Choose a reason for hiding this comment

Takym Jun 21, 2021

Choose a reason for hiding this comment

Takym Jun 21, 2021

Choose a reason for hiding this comment

Takym Jun 21, 2021

Choose a reason for hiding this comment

Takym Jun 21, 2021

Choose a reason for hiding this comment

Takym commented Jun 13, 2021 •

edited by cocoa-dev

Loading

Takym commented Jun 14, 2021 •

edited

Loading