chore: update checkEnv.js to rename env vars for Vite if necessary

utils/checkEnv.js

@@ -9,6 +9,7 @@ const dotenv = require('dotenv');
 
 const red = '\x1b[31m%s\x1b[0m';
 const green = '\x1b[32m%s\x1b[0m';
+const vitePrefix = 'VITE_';
 
 const envPath = path.resolve(__dirname, '../.env');
 const exampleEnvPath = path.resolve(__dirname, '../.example.env');
@@ -23,7 +24,28 @@ function getEnv(fileName) {
   if (fs.existsSync(envPath)) {
     const env = getEnv(envPath);
     const exampleEnv = getEnv(exampleEnvPath);
-    const missingKeys = Object.keys(exampleEnv).filter(key => !Object.keys(env).includes(key));
+    const envKeys = Object.keys(env);
+    let missingKeys = Object.keys(exampleEnv).filter(key => !envKeys.includes(key));
+    const keysToRenameForVite = envKeys.filter(key =>
+      missingKeys.some(missingKey => missingKey === vitePrefix + key)
+    );
+
+    // for variables that client-side code needs to access, ensure their names begin with `VITE_`
+    // https://vitejs.dev/guide/env-and-mode.html#env-files
+    if (keysToRenameForVite.length > 0) {
+      console.log('These keys in your .env file are not compatible with Vite:', keysToRenameForVite, '\n');
+      console.log('Renaming incompatible keys...');
+      let envText = fs.readFileSync(envPath, 'utf8');
+      keysToRenameForVite.forEach(key => envText = envText.replace(key, vitePrefix + key));
+      fs.writeFileSync(envPath, envText)
+      console.log(green, `File updated: ${envPath}\n`);
+    }
+
+    missingKeys = missingKeys.filter(key =>
+      !keysToRenameForVite
+        .map(missingViteKey => vitePrefix + missingViteKey)
+        .includes(key)
+    );
 
     if (missingKeys.length > 0) {
       console.log('You are missing these keys in your .env file:', missingKeys, '\n');