mirror of
https://github.com/GraphiteEditor/Graphite.git
synced 2026-09-15 22:28:10 +08:00
Reimplement notice file generation for third-party licenses through Rust, now with CEF credits (#3808)
This commit is contained in:
Timon
620
frontend/package-lock.json
generated
620
frontend/package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -21,8 +21,8 @@
|
||||
"lint-fix": "eslint . --fix && tsc --noEmit",
|
||||
"---------- INTERNAL ----------": "",
|
||||
"setup": "node package-installer.js && node branding-installer.js",
|
||||
"native:build-dev": "wasm-pack build ./wasm --dev --target=web --no-default-features --features native && vite build --mode dev",
|
||||
"native:build-production": "wasm-pack build ./wasm --release --target=web --no-default-features --features native && vite build",
|
||||
"native:build-dev": "wasm-pack build ./wasm --dev --target=web --no-default-features --features native && vite build --mode native",
|
||||
"native:build-production": "wasm-pack build ./wasm --release --target=web --no-default-features --features native && vite build --mode native",
|
||||
"wasm:build-dev": "wasm-pack build ./wasm --dev --target=web",
|
||||
"wasm:build-profiling": "wasm-pack build ./wasm --profiling --target=web",
|
||||
"wasm:build-production": "wasm-pack build ./wasm --release --target=web",
|
||||
@@ -51,20 +51,20 @@
|
||||
"eslint-plugin-prettier": "^5.5.5",
|
||||
"eslint-plugin-svelte": "^3.14.0",
|
||||
"globals": "^17.0.0",
|
||||
"license-checker-rseidelsohn": "^4.4.2",
|
||||
"postcss": "^8.5.6",
|
||||
"prettier": "^3.8.0",
|
||||
"prettier-plugin-svelte": "^3.4.1",
|
||||
"prettier": "^3.8.0",
|
||||
"process": "^0.11.10",
|
||||
"rollup-plugin-license": "^3.6.0",
|
||||
"sass": "^1.97.2",
|
||||
"svelte": "5.47.1",
|
||||
"svelte-preprocess": "^6.0.3",
|
||||
"svelte": "5.47.1",
|
||||
"tar": "^7.5.4",
|
||||
"ts-node": "^10.9.2",
|
||||
"typescript": "^5.9.3",
|
||||
"typescript-eslint": "^8.53.1",
|
||||
"vite": "^7.3.1",
|
||||
"vite-multiple-assets": "2.2.6"
|
||||
"typescript": "^5.9.3",
|
||||
"vite-multiple-assets": "2.2.6",
|
||||
"vite": "^7.3.1"
|
||||
},
|
||||
"homepage": "https://graphite.art",
|
||||
"license": "Apache-2.0",
|
||||
|
||||
@@ -81,7 +81,6 @@ export function createDialogState(editor: Editor) {
|
||||
editor.subscriptions.subscribeJsMessage(TriggerDisplayThirdPartyLicensesDialog, async () => {
|
||||
const BACKUP_URL = "https://editor.graphite.art/third-party-licenses.txt";
|
||||
let licenseText = `Content was not able to load. Please check your network connection and try again.\n\nOr visit ${BACKUP_URL} for the license notices.`;
|
||||
if (editor.handle.inDevelopmentMode()) licenseText = `Third-party licenses are not available in development builds.\n\nVisit ${BACKUP_URL} for the license notices.`;
|
||||
|
||||
const response = await fetch("/third-party-licenses.txt");
|
||||
if (response.ok && response.headers.get("Content-Type")?.includes("text/plain")) licenseText = await response.text();
|
||||
|
||||
@@ -1,14 +1,10 @@
|
||||
/* eslint-disable no-console */
|
||||
|
||||
import { spawnSync } from "child_process";
|
||||
import fs from "fs";
|
||||
import os from "os";
|
||||
import { execSync } from "child_process";
|
||||
import { readFileSync } from "fs";
|
||||
import path from "path";
|
||||
|
||||
import { svelte } from "@sveltejs/vite-plugin-svelte";
|
||||
import rollupPluginLicense, { type Dependency } from "rollup-plugin-license";
|
||||
import { sveltePreprocess } from "svelte-preprocess";
|
||||
import { defineConfig } from "vite";
|
||||
import { defineConfig, type PluginOption } from "vite";
|
||||
import { DynamicPublicDirectory as viteMultipleAssets } from "vite-multiple-assets";
|
||||
|
||||
const projectRootDir = path.resolve(__dirname);
|
||||
@@ -16,36 +12,7 @@ const projectRootDir = path.resolve(__dirname);
|
||||
// https://vitejs.dev/config/
|
||||
export default defineConfig(({ mode }) => {
|
||||
return {
|
||||
plugins: [
|
||||
svelte({
|
||||
preprocess: [sveltePreprocess()],
|
||||
onwarn(warning, defaultHandler) {
|
||||
const suppressed = [
|
||||
"css-unused-selector", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
"vite-plugin-svelte-css-no-scopable-elements", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
"a11y-no-static-element-interactions", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
"a11y-no-noninteractive-element-interactions", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
"a11y-click-events-have-key-events", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
"a11y_consider_explicit_label", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
"a11y_click_events_have_key_events", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
"a11y_no_noninteractive_element_interactions", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
"a11y_no_static_element_interactions", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
];
|
||||
if (suppressed.includes(warning.code)) return;
|
||||
|
||||
defaultHandler?.(warning);
|
||||
},
|
||||
}),
|
||||
viteMultipleAssets(
|
||||
// Additional static asset directories besides `public/`
|
||||
[
|
||||
{ input: "../demo-artwork/**", output: "demo-artwork" },
|
||||
{ input: "../branding/favicons/**", output: "" },
|
||||
],
|
||||
// Options where we set custom MIME types
|
||||
{ mimeTypes: { ".graphite": "application/json" } },
|
||||
),
|
||||
],
|
||||
plugins: plugins(mode),
|
||||
resolve: {
|
||||
alias: [
|
||||
{ find: /@branding\/(.*\.svg)/, replacement: path.resolve(projectRootDir, "../branding", "$1?raw") },
|
||||
@@ -58,374 +25,63 @@ export default defineConfig(({ mode }) => {
|
||||
port: 8080,
|
||||
host: "0.0.0.0",
|
||||
},
|
||||
build: {
|
||||
rollupOptions: {
|
||||
plugins:
|
||||
mode !== "dev"
|
||||
? [
|
||||
rollupPluginLicense({
|
||||
thirdParty: {
|
||||
includePrivate: false,
|
||||
multipleVersions: true,
|
||||
allow: {
|
||||
test: `(${getAcceptedLicenses()})`,
|
||||
failOnUnlicensed: true,
|
||||
failOnViolation: true,
|
||||
},
|
||||
output: {
|
||||
file: path.resolve(__dirname, "./dist/third-party-licenses.txt"),
|
||||
template: formatThirdPartyLicenses,
|
||||
},
|
||||
},
|
||||
}),
|
||||
]
|
||||
: [],
|
||||
},
|
||||
},
|
||||
};
|
||||
});
|
||||
|
||||
type LicenseInfo = {
|
||||
licenseName: string;
|
||||
licenseText: string;
|
||||
noticeText?: string;
|
||||
packages: PackageInfo[];
|
||||
};
|
||||
function plugins(mode: string): PluginOption[] {
|
||||
const plugins = [
|
||||
svelte({
|
||||
preprocess: [sveltePreprocess()],
|
||||
onwarn(warning, defaultHandler) {
|
||||
const suppressed = [
|
||||
"css-unused-selector", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
"vite-plugin-svelte-css-no-scopable-elements", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
"a11y-no-static-element-interactions", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
"a11y-no-noninteractive-element-interactions", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
"a11y-click-events-have-key-events", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
"a11y_consider_explicit_label", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
"a11y_click_events_have_key_events", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
"a11y_no_noninteractive_element_interactions", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
"a11y_no_static_element_interactions", // NOTICE: Keep this list in sync with the list in `.vscode/settings.json`
|
||||
];
|
||||
if (suppressed.includes(warning.code)) return;
|
||||
|
||||
type PackageInfo = {
|
||||
name: string;
|
||||
version: string;
|
||||
author: string;
|
||||
repository: string;
|
||||
};
|
||||
|
||||
function formatThirdPartyLicenses(jsLicenses: Dependency[]): string {
|
||||
// Generate the Rust license information.
|
||||
const rustLicenses = generateRustLicenses();
|
||||
const additionalLicenses = generateAdditionalLicenses();
|
||||
|
||||
// Ensure we have the required license information to work with before proceeding.
|
||||
if (rustLicenses.length === 0) {
|
||||
// This is probably caused by `cargo about` not being installed.
|
||||
console.error("Could not run `cargo about`, which is required to generate license information.");
|
||||
console.error("To install cargo-about on your system, you can run `cargo install cargo-about`.");
|
||||
console.error("License information is required in production builds. Aborting.");
|
||||
|
||||
process.exit(1);
|
||||
}
|
||||
if (jsLicenses.length === 0) {
|
||||
console.error("No JavaScript package licenses were found by `rollup-plugin-license`. Please investigate.");
|
||||
console.error("License information is required in production builds. Aborting.");
|
||||
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
let licenses = rustLicenses.concat(additionalLicenses);
|
||||
|
||||
// SPECIAL CASE: Find then duplicate this license if one of its packages is `path-bool`, adding its notice text.
|
||||
let foundLicensesIndex: number | undefined = undefined;
|
||||
let foundPackagesIndex: number | undefined = undefined;
|
||||
licenses.forEach((license, licenseIndex) => {
|
||||
license.packages.forEach((pkg, pkgIndex) => {
|
||||
if (pkg.name === "path-bool") {
|
||||
foundLicensesIndex = licenseIndex;
|
||||
foundPackagesIndex = pkgIndex;
|
||||
}
|
||||
});
|
||||
});
|
||||
if (foundLicensesIndex !== undefined && foundPackagesIndex !== undefined) {
|
||||
const license = licenses[foundLicensesIndex];
|
||||
const pkg = license.packages[foundPackagesIndex];
|
||||
|
||||
license.packages = license.packages.filter((pkg) => pkg.name !== "path-bool");
|
||||
const noticeText = fs.readFileSync(path.resolve(__dirname, "../libraries/path-bool/NOTICE"), "utf8");
|
||||
|
||||
licenses.push({
|
||||
licenseName: license.licenseName,
|
||||
licenseText: license.licenseText,
|
||||
noticeText,
|
||||
packages: [pkg],
|
||||
});
|
||||
}
|
||||
|
||||
// Extend the license list with the provided JS licenses.
|
||||
jsLicenses.forEach((jsLicense) => {
|
||||
const name = jsLicense.name || "";
|
||||
const version = jsLicense.version || "";
|
||||
const author = jsLicense.author?.text() || "";
|
||||
const licenseName = jsLicense.license || "";
|
||||
const licenseText = trimBlankLines(jsLicense.licenseText || "");
|
||||
const noticeText = trimBlankLines(jsLicense.noticeText || "");
|
||||
|
||||
let repository = jsLicense.repository || "";
|
||||
if (repository && typeof repository === "object") repository = repository.url;
|
||||
|
||||
const matchedLicense = licenses.find(
|
||||
(license) => license.licenseName === licenseName && trimBlankLines(license.licenseText || "") === licenseText && trimBlankLines(license.noticeText || "") === noticeText,
|
||||
);
|
||||
|
||||
const pkg: PackageInfo = { name, version, author, repository };
|
||||
if (matchedLicense) matchedLicense.packages.push(pkg);
|
||||
else licenses.push({ licenseName, licenseText, noticeText, packages: [pkg] });
|
||||
});
|
||||
|
||||
// Combine any license notices into the license text.
|
||||
licenses.forEach((license, index) => {
|
||||
if (license.noticeText) {
|
||||
licenses[index].licenseText += "\n\n";
|
||||
licenses[index].licenseText += " _______________________________________\n";
|
||||
licenses[index].licenseText += "│ │\n";
|
||||
licenses[index].licenseText += "│ THE FOLLOWING NOTICE FILE IS INCLUDED │\n";
|
||||
licenses[index].licenseText += "│ │\n";
|
||||
licenses[index].licenseText += " ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾\n\n";
|
||||
licenses[index].licenseText += `${license.noticeText}\n`;
|
||||
licenses[index].noticeText = undefined;
|
||||
}
|
||||
});
|
||||
|
||||
// De-duplicate any licenses with the same text by merging their lists of packages.
|
||||
const licensesNormalizedWhitespace = licenses.map((license) => license.licenseText.replace(/[\n\s]+/g, " ").trim());
|
||||
licenses.forEach((currentLicense, currentLicenseIndex) => {
|
||||
licenses.slice(0, currentLicenseIndex).forEach((comparisonLicense, comparisonLicenseIndex) => {
|
||||
if (licensesNormalizedWhitespace[currentLicenseIndex] === licensesNormalizedWhitespace[comparisonLicenseIndex]) {
|
||||
currentLicense.packages.push(...comparisonLicense.packages);
|
||||
comparisonLicense.packages = [];
|
||||
// After emptying the packages, the redundant license with no packages will be removed in the next step's `filter()`.
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// Filter out first-party internal Graphite crates.
|
||||
licenses = licenses.filter((license) => {
|
||||
license.packages = license.packages.filter(
|
||||
(packageInfo) =>
|
||||
!(packageInfo.repository && packageInfo.repository.toLowerCase().includes("github.com/GraphiteEditor/Graphite".toLowerCase())) &&
|
||||
!(
|
||||
packageInfo.author &&
|
||||
packageInfo.author.toLowerCase().includes("contact@graphite.art") &&
|
||||
// Exclude a comma which indicates multiple authors, which we need to not filter out
|
||||
!packageInfo.author.toLowerCase().includes(",")
|
||||
),
|
||||
);
|
||||
return license.packages.length > 0;
|
||||
});
|
||||
|
||||
// Sort the licenses by the number of packages using the same license, and then alphabetically by license name.
|
||||
licenses.sort((a, b) => a.licenseText.localeCompare(b.licenseText));
|
||||
licenses.sort((a, b) => a.licenseName.localeCompare(b.licenseName));
|
||||
licenses.sort((a, b) => b.packages.length - a.packages.length);
|
||||
// Sort the individual packages using each license alphabetically.
|
||||
licenses.forEach((license) => {
|
||||
license.packages.sort((a, b) => a.name.localeCompare(b.name));
|
||||
});
|
||||
|
||||
// Prepare a header for the license notice.
|
||||
let formattedLicenseNotice = "";
|
||||
formattedLicenseNotice += "▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐\n";
|
||||
formattedLicenseNotice += "▐▐ ▐▐\n";
|
||||
formattedLicenseNotice += "▐▐ GRAPHITE THIRD-PARTY SOFTWARE LICENSE NOTICES ▐▐\n";
|
||||
formattedLicenseNotice += "▐▐ ▐▐\n";
|
||||
formattedLicenseNotice += "▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐▐\n";
|
||||
|
||||
// Append a block for each license shared by multiple packages with identical license text.
|
||||
licenses.forEach((license) => {
|
||||
let packagesWithSameLicense = license.packages.map((packageInfo) => {
|
||||
const { name, version, author, repository } = packageInfo;
|
||||
|
||||
// Remove the `git+` or `git://` prefix and `.git` suffix.
|
||||
let repo = repository;
|
||||
if (repo.startsWith("git+")) repo = repo.slice("git+".length);
|
||||
if (repo.startsWith("git://")) repo = repo.slice("git://".length);
|
||||
if (repo.endsWith(".git")) repo = repo.slice(0, -".git".length);
|
||||
if (repo.endsWith(".git#release")) repo = repo.slice(0, -".git#release".length);
|
||||
|
||||
return `${name} ${version}${author ? ` - ${author}` : ""}${repo ? ` - ${repo}` : ""}`;
|
||||
});
|
||||
const multi = packagesWithSameLicense.length !== 1;
|
||||
const saysLicense = license.licenseName.toLowerCase().includes("license");
|
||||
const header = `The package${multi ? "s" : ""} listed here ${multi ? "are" : "is"} licensed under the terms of the ${license.licenseName}${saysLicense ? "" : " license"} printed beneath`;
|
||||
const packagesLineLength = Math.max(header.length, ...packagesWithSameLicense.map((line) => line.length));
|
||||
packagesWithSameLicense = packagesWithSameLicense.map((line) => `│ ${line}${" ".repeat(packagesLineLength - line.length)} │`);
|
||||
|
||||
formattedLicenseNotice += "\n";
|
||||
formattedLicenseNotice += ` ${"_".repeat(packagesLineLength + 2)}\n`;
|
||||
formattedLicenseNotice += `│ ${" ".repeat(packagesLineLength)} │\n`;
|
||||
formattedLicenseNotice += `│ ${header}${" ".repeat(packagesLineLength - header.length)} │\n`;
|
||||
formattedLicenseNotice += `│${"_".repeat(packagesLineLength + 2)}│\n`;
|
||||
formattedLicenseNotice += `${packagesWithSameLicense.join("\n")}\n`;
|
||||
formattedLicenseNotice += ` ${"‾".repeat(packagesLineLength + 2)}\n`;
|
||||
formattedLicenseNotice += `${license.licenseText}\n`;
|
||||
});
|
||||
|
||||
formattedLicenseNotice += "\n";
|
||||
return formattedLicenseNotice;
|
||||
}
|
||||
|
||||
// Include additional licenses that aren't automatically generated by `cargo about` or `rollup-plugin-license`.
|
||||
function generateAdditionalLicenses(): LicenseInfo[] {
|
||||
const ADDITIONAL_LICENSES = [
|
||||
{
|
||||
licenseName: "SIL Open Font License 1.1",
|
||||
licenseTextPath: "node_modules/source-sans-pro/LICENSE.txt",
|
||||
manifestPath: "node_modules/source-sans-pro/package.json",
|
||||
},
|
||||
{
|
||||
licenseName: "SIL Open Font License 1.1",
|
||||
licenseTextPath: "node_modules/source-code-pro/LICENSE.md",
|
||||
manifestPath: "node_modules/source-code-pro/package.json",
|
||||
},
|
||||
defaultHandler?.(warning);
|
||||
},
|
||||
}),
|
||||
viteMultipleAssets(
|
||||
// Additional static asset directories besides `public/`
|
||||
[
|
||||
{ input: "../demo-artwork/**", output: "demo-artwork" },
|
||||
{ input: "../branding/favicons/**", output: "" },
|
||||
],
|
||||
// Options where we set custom MIME types
|
||||
{ mimeTypes: { ".graphite": "application/json" } },
|
||||
),
|
||||
];
|
||||
|
||||
return ADDITIONAL_LICENSES.map(({ licenseName, licenseTextPath, manifestPath }) => {
|
||||
const licenseText = (fs.existsSync(licenseTextPath) && fs.readFileSync(licenseTextPath, "utf8")) || "";
|
||||
|
||||
const manifestJSON = (fs.existsSync(manifestPath) && JSON.parse(fs.readFileSync(manifestPath, "utf8"))) || {};
|
||||
const name = manifestJSON.name || "";
|
||||
const version = manifestJSON.version || "";
|
||||
const author = manifestJSON.author.name || manifestJSON.author || "";
|
||||
const repository = manifestJSON.repository?.url || "";
|
||||
|
||||
return {
|
||||
licenseName,
|
||||
licenseText: trimBlankLines(licenseText),
|
||||
packages: [{ name, version, author, repository }],
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
function generateRustLicenses(): LicenseInfo[] {
|
||||
// Log the starting status to the build output.
|
||||
console.info("\n\nGenerating license information for Rust code\n");
|
||||
|
||||
try {
|
||||
// Call `cargo about` in the terminal to generate the license information for Rust crates.
|
||||
// The `about.hbs` file is written so it generates a valid JavaScript array expression which we evaluate below.
|
||||
const { licenses, status, stderr } = (() => {
|
||||
// On Windows, we have to write the output to a temporary file because of powershell's handling of stdout.
|
||||
if (os.platform() === "win32") {
|
||||
const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "graphite-licenses-"));
|
||||
const licensesFile = path.join(tmpDir, "licenses.js");
|
||||
|
||||
const { status, stderr } = spawnSync("cargo", ["about", "generate", "about.hbs", "-o", licensesFile], {
|
||||
cwd: path.join(__dirname, ".."),
|
||||
encoding: "utf8",
|
||||
shell: true,
|
||||
windowsHide: true, // Hide the terminal on Windows
|
||||
if (mode !== "native") {
|
||||
plugins.push({
|
||||
name: "third-party-licenses",
|
||||
buildStart() {
|
||||
try {
|
||||
execSync("cargo run -p third-party-licenses", {
|
||||
stdio: "inherit",
|
||||
});
|
||||
} catch (_e) {
|
||||
this.error("Failed to generate third-party licenses");
|
||||
}
|
||||
},
|
||||
generateBundle() {
|
||||
const source = readFileSync(path.resolve(projectRootDir, "third-party-licenses.txt"), "utf-8");
|
||||
this.emitFile({
|
||||
type: "asset",
|
||||
fileName: "third-party-licenses.txt",
|
||||
source,
|
||||
});
|
||||
|
||||
const licenses = fs.existsSync(licensesFile) ? fs.readFileSync(licensesFile, "utf8") : "";
|
||||
|
||||
return { licenses, status, stderr };
|
||||
} else {
|
||||
const { stdout, status, stderr } = spawnSync("cargo", ["about", "generate", "about.hbs"], {
|
||||
cwd: path.join(__dirname, ".."),
|
||||
encoding: "utf8",
|
||||
shell: true,
|
||||
});
|
||||
|
||||
return { licenses: stdout, status, stderr };
|
||||
}
|
||||
})();
|
||||
|
||||
// If the command failed, print the error message and exit early.
|
||||
if (status !== 0) {
|
||||
// Cargo returns 101 when the subcommand (`about`) wasn't found, so we skip printing the below error message in that case.
|
||||
if (status !== 101) {
|
||||
console.error("cargo-about failed", status, stderr);
|
||||
}
|
||||
return [];
|
||||
}
|
||||
|
||||
// Make sure the output starts with this expected label, which lets us know the file generated with expected output.
|
||||
// We don't want to eval an error message or something else, so we fail early if that happens.
|
||||
if (!licenses.trim().startsWith("GENERATED_BY_CARGO_ABOUT:")) {
|
||||
console.error("Unexpected output from cargo-about", licenses);
|
||||
return [];
|
||||
}
|
||||
|
||||
// Convert the array JS syntax string into an actual JS array in memory.
|
||||
// Security-wise, eval() isn't any worse than require(), but it's able to work without a temporary file.
|
||||
// We call eval indirectly to avoid a warning as explained here: <https://esbuild.github.io/content-types/#direct-eval>.
|
||||
const indirectEval = eval;
|
||||
const licensesArray = indirectEval(licenses) as LicenseInfo[];
|
||||
|
||||
// Remove the HTML character encoding caused by Handlebars.
|
||||
const rustLicenses = (licensesArray || []).map(
|
||||
(rustLicense): LicenseInfo => ({
|
||||
licenseName: htmlDecode(rustLicense.licenseName),
|
||||
licenseText: trimBlankLines(htmlDecode(rustLicense.licenseText)),
|
||||
packages: rustLicense.packages.map(
|
||||
(packageInfo): PackageInfo => ({
|
||||
name: htmlDecode(packageInfo.name),
|
||||
version: htmlDecode(packageInfo.version),
|
||||
author: htmlDecode(packageInfo.author)
|
||||
.replace(/\[(.*), \]/, "$1")
|
||||
.replace("[]", ""),
|
||||
repository: htmlDecode(packageInfo.repository),
|
||||
}),
|
||||
),
|
||||
}),
|
||||
);
|
||||
|
||||
return rustLicenses;
|
||||
} catch (_) {
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
function htmlDecode(input: string): string {
|
||||
if (!input) return input;
|
||||
|
||||
const htmlEntities = {
|
||||
nbsp: " ",
|
||||
copy: "©",
|
||||
reg: "®",
|
||||
lt: "<",
|
||||
gt: ">",
|
||||
amp: "&",
|
||||
apos: "'",
|
||||
quot: `"`,
|
||||
};
|
||||
|
||||
return input.replace(/&([^;]+);/g, (entity: string, entityCode: string) => {
|
||||
const maybeEntity = Object.entries(htmlEntities).find(([key, _]) => key === entityCode);
|
||||
if (maybeEntity) return maybeEntity[1];
|
||||
|
||||
let match;
|
||||
if ((match = entityCode.match(/^#x([\da-fA-F]+)$/))) {
|
||||
return String.fromCharCode(parseInt(match[1], 16));
|
||||
}
|
||||
if ((match = entityCode.match(/^#(\d+)$/))) {
|
||||
return String.fromCharCode(~~match[1]);
|
||||
}
|
||||
return entity;
|
||||
});
|
||||
}
|
||||
|
||||
function trimBlankLines(input: string): string {
|
||||
let result = input.replace(/\r/g, "");
|
||||
|
||||
while (result.charAt(0) === "\r" || result.charAt(0) === "\n") {
|
||||
result = result.slice(1);
|
||||
}
|
||||
while (result.slice(-1) === "\r" || result.slice(-1) === "\n") {
|
||||
result = result.slice(0, -1);
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
function getAcceptedLicenses() {
|
||||
const tomlContent = fs.readFileSync(path.resolve(__dirname, "../about.toml"), "utf8");
|
||||
|
||||
const licensesBlock = tomlContent?.match(/accepted\s*=\s*\[([^\]]*)\]/)?.[1] || "";
|
||||
|
||||
return licensesBlock
|
||||
.split("\n")
|
||||
.map((line) => line.replace(/#.*$/, "")) // Remove comments
|
||||
.join("\n")
|
||||
.split(",")
|
||||
.map((license) => license.trim().replace(/"/g, ""))
|
||||
.filter((license) => license.length > 0)
|
||||
.join(" OR ");
|
||||
return plugins;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user