This commit is contained in:
Keavon Chambers
2024-10-02 16:07:43 -07:00
parent cb5a0b4a2d
commit fc406c4f65
+9 -10
View File
@@ -282,7 +282,7 @@ function generateRustLicenses(): LicenseInfo[] | undefined {
// Call `cargo about` in the terminal to generate the license information for Rust crates. // 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. // The `about.hbs` file is written so it generates a valid JavaScript array expression which we evaluate below.
const { stdout, stderr, status } = spawnSync("cargo", ["about", "generate", "about.hbs"], { const spawnReturn = spawnSync("cargo", ["about", "generate", "about.hbs"], {
cwd: path.join(__dirname, ".."), cwd: path.join(__dirname, ".."),
encoding: "utf8", encoding: "utf8",
timeout: 60000, // One minute timeout: 60000, // One minute
@@ -290,23 +290,22 @@ function generateRustLicenses(): LicenseInfo[] | undefined {
windowsHide: true, // Hide the terminal on Windows windowsHide: true, // Hide the terminal on Windows
}); });
console.log("stdout:\n", stdout); console.log("spawnReturn:\n", spawnReturn);
console.log("stderr:\n", stderr); console.log("spawnReturn JSON:\n", JSON.stringify(spawnReturn));
console.log("status:\n", status);
// If the command failed, print the error message and exit early. // If the command failed, print the error message and exit early.
if (status !== 0) { if (spawnReturn.status !== 0) {
// Cargo returns 101 when the subcommand (`about`) wasn't found, so we skip printing the below error message in that case. // Cargo returns 101 when the subcommand (`about`) wasn't found, so we skip printing the below error message in that case.
if (status !== 101) { if (spawnReturn.status !== 101) {
console.error("cargo-about failed", status, stderr); console.error("cargo-about failed", spawnReturn.status, spawnReturn.stderr);
} }
return undefined; return undefined;
} }
// Make sure the output starts with this expected label, which lets us know the file generated with expected output. // 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. // We don't want to eval an error message or something else, so we fail early if that happens.
if (!stdout.trim().startsWith("GENERATED_BY_CARGO_ABOUT:")) { if (!spawnReturn.stdout.trim().startsWith("GENERATED_BY_CARGO_ABOUT:")) {
console.error("Unexpected output from cargo-about", stdout); console.error("Unexpected output from cargo-about", spawnReturn.stdout);
return undefined; return undefined;
} }
@@ -314,7 +313,7 @@ function generateRustLicenses(): LicenseInfo[] | undefined {
// Security-wise, eval() isn't any worse than require(), but it's able to work without a temporary file. // 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>. // We call eval indirectly to avoid a warning as explained here: <https://esbuild.github.io/content-types/#direct-eval>.
const indirectEval = eval; const indirectEval = eval;
const licensesArray = indirectEval(stdout) as LicenseInfo[]; const licensesArray = indirectEval(spawnReturn.stdout) as LicenseInfo[];
// Remove the HTML character encoding caused by Handlebars. // Remove the HTML character encoding caused by Handlebars.
const rustLicenses = (licensesArray || []).map( const rustLicenses = (licensesArray || []).map(