licenses.jsonの生成スクリプトを追加 (#275)

* add generateLicences.js (npm run license:generate)

* yargs

* add mergeLicenses.js (npm run license:merge)

* doc: license generation

* fix dependencies (dev)

* fix long line

* ignore file *licenses.json

.gitignore

@@ -38,3 +38,6 @@ data/
 
 # release
 electron-builder.yml
+
+# generated licenses.json
+/*licenses.json

README.md

@@ -34,6 +34,15 @@ Issue 側で取り組み始めたことを伝えるか、最初に Draft プル
 npm run electron:build
 ```
 
+## 依存ライブラリのライセンス情報の生成
+
+```bash
+# get licenses.json from voicevox_engine as engine_licenses.json
+
+npm run license:generate -- -o voicevox_licenses.json
+npm run license:merge -- -o public/licenses.json -i engine_licenses.json -i voicevox_licenses.json
+```
+
 ## コードフォーマット
 
 コードのフォーマットを整えます。プルリクエストを送る前に実行してください。

build/generateLicenses.js

@@ -0,0 +1,48 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+
+const process = require("process");
+const yargs = require("yargs/yargs");
+const { hideBin } = require("yargs/helpers");
+const argv = yargs(hideBin(process.argv))
+  .option("output_path", {
+    alias: "o",
+    demandOption: true,
+    type: "string"
+  })
+  .help()
+  .parse();
+
+const { execSync } = require("child_process");
+const fs = require("fs");
+
+const customFormat = JSON.stringify({
+  name: "",
+  version: "",
+  description: "",
+  licenses: "",
+  copyright: "",
+  licenseFile: "none",
+  licenseText: "none",
+  licenseModified: "no"
+});
+
+// https://github.com/davglass/license-checker
+// npm install -g license-checker
+const licenseJson = execSync(
+  `license-checker --production --excludePrivatePackages --json --customPath ${customFormat}`,
+  {
+    encoding: "utf-8"
+  }
+);
+
+const checkerLicenses = JSON.parse(licenseJson);
+
+const licenses = Object.entries(checkerLicenses).map(([packageName, license]) => ({
+  name: license.name,
+  version: license.version,
+  license: license.licenses,
+  text: license.licenseText,
+}));
+
+const outputPath = argv.output_path;
+fs.writeFileSync(outputPath, JSON.stringify(licenses));

build/mergeLicenses.js

@@ -0,0 +1,37 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+
+const process = require("process");
+const yargs = require("yargs/yargs");
+const { hideBin } = require("yargs/helpers");
+const argv = yargs(hideBin(process.argv))
+  .option("output_path", {
+    alias: "o",
+    demandOption: true,
+    type: "string"
+  })
+  .option("input_path", {
+    alias: "i",
+    demandOption: true,
+    type: "string"
+  })
+  .help()
+  .parse();
+
+const fs = require("fs");
+
+const inputPathList = typeof argv.input_path === 'string' ?
+  [ argv.input_path ] : argv.input_path;
+
+let mergedLicenses = [];
+
+for (const inputPath of inputPathList) {
+  const licenseJson = fs.readFileSync(inputPath, {
+    encoding: 'utf-8'
+  });
+
+  const licenses = JSON.parse(licenseJson);
+  mergedLicenses = mergedLicenses.concat(licenses);
+}
+
+outputPath = argv.output_path;
+fs.writeFileSync(outputPath, JSON.stringify(mergedLicenses));