Add rollup-plugin-license to automatically pull out license banners from dependencies and write to dependencies.txt

2024-12-22 23:00:38 +01:00 · 2023-07-08 16:48:36 +02:00 · 2023-07-08 16:48:36 +02:00 · 548034da90
commit 548034da90
parent 459fcd7c4c
3 changed files with 122 additions and 2 deletions
--- a/package-lock.json
+++ b/package-lock.json
@ -1,12 +1,13 @@
 {
  "name": "Heynote",
-  "version": "1.1.0",
+  "version": "1.1.1",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "Heynote",
-      "version": "1.1.0",
+      "version": "1.1.1",
+      "license": "Commons Clause MIT",
      "dependencies": {
        "electron-log": "^4.4.8"
      },
@ -40,6 +41,7 @@
        "electron-updater": "^5.3.0",
        "fs-jetpack": "^5.1.0",
        "prettier": "^2.8.4",
+        "rollup-plugin-license": "^3.0.1",
        "sass": "^1.57.1",
        "typescript": "^4.9.4",
        "vite": "^4.0.3",
@ -1781,6 +1783,15 @@
      "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==",
      "dev": true
    },
+    "node_modules/array-find-index": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/array-find-index/-/array-find-index-1.0.2.tgz",
+      "integrity": "sha512-M1HQyIXcBGtVywBt8WVdim+lrNaK7VHp99Qt5pSNziXznKHViIBbXWtfRTpEFpF/c4FdfxNAsCCwPp5phBYJtw==",
+      "dev": true,
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
    "node_modules/asar": {
      "version": "3.2.0",
      "resolved": "https://registry.npmjs.org/asar/-/asar-3.2.0.tgz",
@ -2303,6 +2314,12 @@
        "node": ">= 6"
      }
    },
+    "node_modules/commenting": {
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/commenting/-/commenting-1.1.0.tgz",
+      "integrity": "sha512-YeNK4tavZwtH7jEgK1ZINXzLKm6DZdEMfsaaieOsCAN0S8vsY7UeuO3Q7d/M018EFgE+IeUAuBOKkFccBZsUZA==",
+      "dev": true
+    },
    "node_modules/compare-version": {
      "version": "0.1.2",
      "resolved": "https://registry.npmjs.org/compare-version/-/compare-version-0.1.2.tgz",
@ -4198,6 +4215,15 @@
        "node": ">=10"
      }
    },
+    "node_modules/moment": {
+      "version": "2.29.4",
+      "resolved": "https://registry.npmjs.org/moment/-/moment-2.29.4.tgz",
+      "integrity": "sha512-5LC9SOxjSc2HF6vO2CyuTDNivEdoz2IvyJJGj6X8DJ0eFyfszE0QiEd+iXmBvUP3WHxSjFH/vIsA0EN00cgr8w==",
+      "dev": true,
+      "engines": {
+        "node": "*"
+      }
+    },
    "node_modules/ms": {
      "version": "2.1.2",
      "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz",
@ -4365,6 +4391,18 @@
        "node": ">=6"
      }
    },
+    "node_modules/package-name-regex": {
+      "version": "2.0.6",
+      "resolved": "https://registry.npmjs.org/package-name-regex/-/package-name-regex-2.0.6.tgz",
+      "integrity": "sha512-gFL35q7kbE/zBaPA3UKhp2vSzcPYx2ecbYuwv1ucE9Il6IIgBDweBlH8D68UFGZic2MkllKa2KHCfC1IQBQUYA==",
+      "dev": true,
+      "engines": {
+        "node": ">=12"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/dword-design"
+      }
+    },
    "node_modules/parse-json": {
      "version": "5.2.0",
      "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz",
@ -4770,6 +4808,41 @@
        "fsevents": "~2.3.2"
      }
    },
+    "node_modules/rollup-plugin-license": {
+      "version": "3.0.1",
+      "resolved": "https://registry.npmjs.org/rollup-plugin-license/-/rollup-plugin-license-3.0.1.tgz",
+      "integrity": "sha512-/lec6Y94Y3wMfTDeYTO/jSXII0GQ/XkDZCiqkMKxyU5D5nGPaxr/2JNYvAgYsoCYuOLGOanKDPjCCQiTT96p7A==",
+      "dev": true,
+      "dependencies": {
+        "commenting": "~1.1.0",
+        "glob": "~7.2.0",
+        "lodash": "~4.17.21",
+        "magic-string": "~0.26.2",
+        "mkdirp": "~1.0.4",
+        "moment": "~2.29.3",
+        "package-name-regex": "~2.0.6",
+        "spdx-expression-validate": "~2.0.0",
+        "spdx-satisfies": "~5.0.1"
+      },
+      "engines": {
+        "node": ">=14.0.0"
+      },
+      "peerDependencies": {
+        "rollup": "^1.0.0 || ^2.0.0 || ^3.0.0"
+      }
+    },
+    "node_modules/rollup-plugin-license/node_modules/magic-string": {
+      "version": "0.26.7",
+      "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.26.7.tgz",
+      "integrity": "sha512-hX9XH3ziStPoPhJxLq1syWuZMxbDvGNbVchfrdCtanC7D13888bMFow61x8axrx+GfHLtVeAx2kxL7tTGRl+Ow==",
+      "dev": true,
+      "dependencies": {
+        "sourcemap-codec": "^1.4.8"
+      },
+      "engines": {
+        "node": ">=12"
+      }
+    },
    "node_modules/rxjs": {
      "version": "7.8.0",
      "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-7.8.0.tgz",
@ -4953,6 +5026,17 @@
      "deprecated": "Please use @jridgewell/sourcemap-codec instead",
      "dev": true
    },
+    "node_modules/spdx-compare": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/spdx-compare/-/spdx-compare-1.0.0.tgz",
+      "integrity": "sha512-C1mDZOX0hnu0ep9dfmuoi03+eOdDoz2yvK79RxbcrVEG1NO1Ph35yW102DHWKN4pk80nwCgeMmSY5L25VE4D9A==",
+      "dev": true,
+      "dependencies": {
+        "array-find-index": "^1.0.2",
+        "spdx-expression-parse": "^3.0.0",
+        "spdx-ranges": "^2.0.0"
+      }
+    },
    "node_modules/spdx-correct": {
      "version": "3.1.1",
      "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.1.tgz",
@ -4979,12 +5063,38 @@
        "spdx-license-ids": "^3.0.0"
      }
    },
+    "node_modules/spdx-expression-validate": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/spdx-expression-validate/-/spdx-expression-validate-2.0.0.tgz",
+      "integrity": "sha512-b3wydZLM+Tc6CFvaRDBOF9d76oGIHNCLYFeHbftFXUWjnfZWganmDmvtM5sm1cRwJc/VDBMLyGGrsLFd1vOxbg==",
+      "dev": true,
+      "dependencies": {
+        "spdx-expression-parse": "^3.0.0"
+      }
+    },
    "node_modules/spdx-license-ids": {
      "version": "3.0.12",
      "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.12.tgz",
      "integrity": "sha512-rr+VVSXtRhO4OHbXUiAF7xW3Bo9DuuF6C5jH+q/x15j2jniycgKbxU09Hr0WqlSLUs4i4ltHGXqTe7VHclYWyA==",
      "dev": true
    },
+    "node_modules/spdx-ranges": {
+      "version": "2.1.1",
+      "resolved": "https://registry.npmjs.org/spdx-ranges/-/spdx-ranges-2.1.1.tgz",
+      "integrity": "sha512-mcdpQFV7UDAgLpXEE/jOMqvK4LBoO0uTQg0uvXUewmEFhpiZx5yJSZITHB8w1ZahKdhfZqP5GPEOKLyEq5p8XA==",
+      "dev": true
+    },
+    "node_modules/spdx-satisfies": {
+      "version": "5.0.1",
+      "resolved": "https://registry.npmjs.org/spdx-satisfies/-/spdx-satisfies-5.0.1.tgz",
+      "integrity": "sha512-Nwor6W6gzFp8XX4neaKQ7ChV4wmpSh2sSDemMFSzHxpTw460jxFYeOn+jq4ybnSSw/5sc3pjka9MQPouksQNpw==",
+      "dev": true,
+      "dependencies": {
+        "spdx-compare": "^1.0.0",
+        "spdx-expression-parse": "^3.0.0",
+        "spdx-ranges": "^2.0.0"
+      }
+    },
    "node_modules/sprintf-js": {
      "version": "1.1.2",
      "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.1.2.tgz",
--- a/package.json
+++ b/package.json
@ -55,6 +55,7 @@
    "electron-updater": "^5.3.0",
    "fs-jetpack": "^5.1.0",
    "prettier": "^2.8.4",
+    "rollup-plugin-license": "^3.0.1",
    "sass": "^1.57.1",
    "typescript": "^4.9.4",
    "vite": "^4.0.3",
--- a/vite.config.ts
+++ b/vite.config.ts
@ -1,8 +1,10 @@
 import { rmSync } from 'node:fs'
+import { join } from 'node:path'
 import { defineConfig } from 'vite'
 import vue from '@vitejs/plugin-vue'
 import electron from 'vite-plugin-electron'
 import renderer from 'vite-plugin-electron-renderer'
+import license from 'rollup-plugin-license'
 import pkg from './package.json'

 rmSync('dist-electron', { recursive: true, force: true })
@ -77,6 +79,13 @@ export default defineConfig({
 		renderer({
 			nodeIntegration: false, // turning this on will break Math.js
 		}),
+
+		// Add license header to the built files
+		license({thirdParty: {
+			output: join(__dirname, 'dist', 'dependencies.txt'),
+			includePrivate: true, // Default is false.
+		  },
+		})
 	],
 	server: !!process.env.VSCODE_DEBUG ? (() => {
 		const url = new URL(pkg.debug.env.VITE_DEV_SERVER_URL)