Add envalid to improve script feedback when env vars are missing

[kachkaev]

We were having issues with Algolia indexing recently and it was unclear whether it was because of missing or incorrect env vars. This PR introduces envalid, which improves script feedback. We can add this library to other scripts as needed.

Before 🤔

After 💡

Feature summary

const env = envalid.cleanEnv({
  EMAIL: envalid.email({ default: "hello@example.com" }),
  EMAIL_TRANSPORT: envalid.str({ choices: ["aws", "none"], default: "aws", devDefault: "none" }),
  PORT: envalid.port({ default: 3000 }),
});

console.log(env.PORT === 3000); // true

// with PORT=-42 → 💥

console.log(env.EMAIL); // always a valid email

console.log(env.EMAIL_TRANSPORT); // "none"
console.log(env.isProduction); // false

// with NODE_ENV=production
console.log(env.EMAIL_TRANSPORT); // "aws"
console.log(env.isProduction); // true

// with EMAIL_TRANSPORT=oops → 💥

Caveats

• By default, envalid calls process.exit instead of throwing. This makes script output cleaner because it does not contain the call stack. We can’t use try / catch though. If we do want to use try / catch, we can implement a custom reporter, which would throw. This may be useful in server-side code, but I doubt about scripts.

• We need to use import * as envalid from "envalid". Writing import envalid from "envalid" does not produce a TS error but crashes. This may change if we switch to native ESM modules.

• Specifying choices does not narrow the return type (i.e. env.EMAIL_TRANSPORT is string, not "aws" | "none"). This might be fixed via Ensure default values don't go through validation, fix type narrowing from defaults af/envalid#176

---

Asana task (internal link)

[kachkaev]

@CiaranMn I also fixed paths, which broke when I moved this script:
https://github.com/blockprotocol/blockprotocol/runs/5064081770?check_suite_focus=true