mirror of
https://github.com/arsvendg/Stirling-PDF.git
synced 2026-07-14 10:34:06 +02:00
James BruntonandGitHub
a3e45bc182
# Description of Changes Changes the strategy for autoformatting to reject PRs if they are not formatted correctly instead of allowing them to merge and then spawning a new PR to fix the formatting. The old strategy just caused more work for us because we'd have to manually approve the followup PR and get it merged, which required 2 reviewers so in practice it rarely got done and just meant everyone's PRs ended up containing reformatting for unrelated files, which makes code review unnecessarily difficult. If the PR's code is not formatted correctly after this PR, a comment will be added automatically to tell the author how to run the formatter script to fix their code so it can go in. This also enables autoformatting for the frontend code, using Prettier. I've enabled it for pretty much everything in the frontend folder, other than 3rd party files and files it doesn't make sense for. I also excluded Markdown because it sounds likely to be more annoying to have to autoformat the Markdown in the frontend folder but nowhere else. Open to changing this though if people disagree. > [!note] > > Advice to reviewers: The first commit contains all of the actual logic I've introduced (CI changes, Prettier config, etc.) > The second commit is just the reformatting of the entire frontend folder. > The first commit needs proper review, the second one just give it a spot-check that it's doing what you'd expect.
88 lines
2.9 KiB
TypeScript
88 lines
2.9 KiB
TypeScript
/**
|
|
* Copies missing env files from their .example templates, and warns about
|
|
* any keys present in the example but not set in the environment.
|
|
* Also warns about any VITE_ vars set in the environment that aren't listed
|
|
* in any example file.
|
|
*
|
|
* Usage:
|
|
* tsx scripts/setup-env.ts # checks .env
|
|
* tsx scripts/setup-env.ts --desktop # also checks .env.desktop
|
|
* tsx scripts/setup-env.ts --saas # also checks .env.saas
|
|
*/
|
|
|
|
import { existsSync, copyFileSync, readFileSync } from "fs";
|
|
import { join } from "path";
|
|
import { config, parse } from "dotenv";
|
|
|
|
// npm scripts run from the directory containing package.json (frontend/)
|
|
const root = process.cwd();
|
|
const args = process.argv.slice(2);
|
|
const isDesktop = args.includes("--desktop");
|
|
const isSaas = args.includes("--saas");
|
|
|
|
console.log("setup-env: see frontend/README.md#environment-variables for documentation");
|
|
|
|
function getExampleKeys(exampleFile: string): string[] {
|
|
const examplePath = join(root, exampleFile);
|
|
if (!existsSync(examplePath)) return [];
|
|
return Object.keys(parse(readFileSync(examplePath, "utf-8")));
|
|
}
|
|
|
|
function ensureEnvFile(envFile: string, exampleFile: string): boolean {
|
|
const envPath = join(root, envFile);
|
|
const examplePath = join(root, exampleFile);
|
|
|
|
if (!existsSync(examplePath)) {
|
|
console.warn(`setup-env: ${exampleFile} not found, skipping ${envFile}`);
|
|
return false;
|
|
}
|
|
|
|
if (!existsSync(envPath)) {
|
|
copyFileSync(examplePath, envPath);
|
|
console.log(`setup-env: created ${envFile} from ${exampleFile}`);
|
|
}
|
|
|
|
config({ path: envPath });
|
|
|
|
const missing = getExampleKeys(exampleFile).filter((k) => !(k in process.env));
|
|
|
|
if (missing.length > 0) {
|
|
console.error(
|
|
`setup-env: ${envFile} is missing keys from ${exampleFile}:\n` +
|
|
missing.map((k) => ` ${k}`).join("\n") +
|
|
"\n Add them manually or delete your local file to re-copy from the example.",
|
|
);
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
let failed = false;
|
|
failed = ensureEnvFile(".env", "config/.env.example") || failed;
|
|
|
|
if (isDesktop) {
|
|
failed = ensureEnvFile(".env.desktop", "config/.env.desktop.example") || failed;
|
|
}
|
|
|
|
if (isSaas) {
|
|
failed = ensureEnvFile(".env.saas", "config/.env.saas.example") || failed;
|
|
}
|
|
|
|
// Warn about any VITE_ vars set in the environment that aren't listed in any example file.
|
|
const allExampleKeys = new Set([
|
|
...getExampleKeys("config/.env.example"),
|
|
...getExampleKeys("config/.env.desktop.example"),
|
|
...getExampleKeys("config/.env.saas.example"),
|
|
]);
|
|
const unknownViteVars = Object.keys(process.env).filter((k) => k.startsWith("VITE_") && !allExampleKeys.has(k));
|
|
if (unknownViteVars.length > 0) {
|
|
console.warn(
|
|
"setup-env: the following VITE_ vars are set but not listed in any example file:\n" +
|
|
unknownViteVars.map((k) => ` ${k}`).join("\n") +
|
|
"\n Add them to the appropriate config/.env.*.example file if they are required.",
|
|
);
|
|
}
|
|
|
|
if (failed) process.exit(1);
|