Updated KITA_PROJECT_ROOT error message

kitajs · Apr 1, 2024 · c42f222 · c42f222
1 parent a6b78ab
commit c42f222
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/.changeset/funny-bobcats-repeat.md b/.changeset/funny-bobcats-repeat.md
@@ -0,0 +1,6 @@
+---
+'@kitajs/generator': patch
+'@kitajs/runtime': patch
+---
+
+Updated KITA_PROJECT_ROOT error message
diff --git a/packages/generator/src/templates/index.ts b/packages/generator/src/templates/index.ts
@@ -1,20 +1,23 @@
 import { Route, kKitaGlobalRoot, kKitaRoot } from '@kitajs/common';
 import { ts } from 'ts-writer';
 
-// TODO: FIx the globalRoot documentation link
 export function generateIndex(routes: Route[]) {
   return ts`${'index'}
   'use strict';
 
   const tslib = require("tslib");
 
   // If you are seeing this error, you probably forgot to define the ${kKitaGlobalRoot} variable.
-  // Read more at https://kita.js.org/docs/runtime
+  // Read more at https://kita.js.org/concepts/routing#kita-project-root
   if (!${kKitaGlobalRoot}) {
     ${kKitaGlobalRoot} = process.env.${kKitaRoot};
 
     if (!${kKitaGlobalRoot}) {
-      throw new Error('Please define ${kKitaGlobalRoot} before importing any routes.');
+      throw new Error(
+        process.stdout.isTTY
+          ? '\x1b[31mPlease define globalThis.KITA_PROJECT_ROOT before importing any routes.\x1b[0m\nhttps://kita.js.org/concepts/routing#kita-project-root\x1b[0m\n'
+          : 'Please define globalThis.KITA_PROJECT_ROOT before importing any routes.\nhttps://kita.js.org/concepts/routing#kita-project-root'
+      );
     }
   }
 

diff --git a/packages/runtime/test/index.test.js b/packages/runtime/test/index.test.js
@@ -14,6 +14,7 @@ describe('Runtime tests', () => {
       runtime.Kita();
       assert.fail('Kita function should throw error');
     } catch (error) {
+      console.log(error);
       assert.equal(error.message, 'You must run `kita build` before using @kitajs/runtime.');
     }
   });