From 38888061698f230f2288cf520daf86d781c395bd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bartek=20Iwa=C5=84czuk?= <biwanczuk@gmail.com>
Date: Tue, 15 Oct 2024 17:59:28 +0100
Subject: refactor: always apply hint when formatting JsError (#26252)

Moves code for generating suggestions and hint to `cli/fmt_errors.rs`.

This effectively applies suggestion to any place that format JS errors
in terminal,
like `deno test`.

Addresses
https://github.com/denoland/deno/pull/26218#issuecomment-2409139055
---
 runtime/fmt_errors.rs | 105 +++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 91 insertions(+), 14 deletions(-)

(limited to 'runtime/fmt_errors.rs')

diff --git a/runtime/fmt_errors.rs b/runtime/fmt_errors.rs
index 44a947732..0d4274e8a 100644
--- a/runtime/fmt_errors.rs
+++ b/runtime/fmt_errors.rs
@@ -282,28 +282,105 @@ fn format_js_error_inner(
   s
 }
 
-/// Format a [`JsError`] for terminal output.
-pub fn format_js_error(js_error: &JsError) -> String {
-  let circular =
-    find_recursive_cause(js_error).map(|reference| IndexedErrorReference {
-      reference,
-      index: 1,
-    });
+fn get_suggestions_for_terminal_errors(e: &JsError) -> Vec<FixSuggestion> {
+  if let Some(msg) = &e.message {
+    if msg.contains("module is not defined")
+      || msg.contains("exports is not defined")
+    {
+      return vec![
+        FixSuggestion::info(
+          "Deno does not support CommonJS modules without `.cjs` extension.",
+        ),
+        FixSuggestion::hint(
+          "Rewrite this module to ESM or change the file extension to `.cjs`.",
+        ),
+      ];
+    } else if msg.contains("openKv is not a function") {
+      return vec![
+        FixSuggestion::info("Deno.openKv() is an unstable API."),
+        FixSuggestion::hint(
+          "Run again with `--unstable-kv` flag to enable this API.",
+        ),
+      ];
+    } else if msg.contains("cron is not a function") {
+      return vec![
+        FixSuggestion::info("Deno.cron() is an unstable API."),
+        FixSuggestion::hint(
+          "Run again with `--unstable-cron` flag to enable this API.",
+        ),
+      ];
+    } else if msg.contains("WebSocketStream is not defined") {
+      return vec![
+        FixSuggestion::info("new WebSocketStream() is an unstable API."),
+        FixSuggestion::hint(
+          "Run again with `--unstable-net` flag to enable this API.",
+        ),
+      ];
+    } else if msg.contains("Temporal is not defined") {
+      return vec![
+        FixSuggestion::info("Temporal is an unstable API."),
+        FixSuggestion::hint(
+          "Run again with `--unstable-temporal` flag to enable this API.",
+        ),
+      ];
+    } else if msg.contains("BroadcastChannel is not defined") {
+      return vec![
+        FixSuggestion::info("BroadcastChannel is an unstable API."),
+        FixSuggestion::hint(
+          "Run again with `--unstable-broadcast-channel` flag to enable this API.",
+        ),
+      ];
+    } else if msg.contains("window is not defined") {
+      return vec![
+        FixSuggestion::info("window global is not available in Deno 2."),
+        FixSuggestion::hint("Replace `window` with `globalThis`."),
+      ];
+    } else if msg.contains("UnsafeWindowSurface is not a constructor") {
+      return vec![
+        FixSuggestion::info("Deno.UnsafeWindowSurface is an unstable API."),
+        FixSuggestion::hint(
+          "Run again with `--unstable-webgpu` flag to enable this API.",
+        ),
+      ];
+    // Try to capture errors like:
+    // ```
+    // Uncaught Error: Cannot find module '../build/Release/canvas.node'
+    // Require stack:
+    // - /.../deno/npm/registry.npmjs.org/canvas/2.11.2/lib/bindings.js
+    // - /.../.cache/deno/npm/registry.npmjs.org/canvas/2.11.2/lib/canvas.js
+    // ```
+    } else if msg.contains("Cannot find module")
+      && msg.contains("Require stack")
+      && msg.contains(".node'")
+    {
+      return vec![
+        FixSuggestion::info_multiline(
+          &[
+            "Trying to execute an npm package using Node-API addons,",
+            "these packages require local `node_modules` directory to be present."
+          ]
+        ),
+        FixSuggestion::hint_multiline(
+          &[
+            "Add `\"nodeModulesDir\": \"auto\" option to `deno.json`, and then run",
+            "`deno install --allow-scripts=npm:<package> --entrypoint <script>` to setup `node_modules` directory."
+          ]
+        )
+      ];
+    }
+  }
 
-  format_js_error_inner(js_error, circular, true, vec![])
+  vec![]
 }
 
-/// Format a [`JsError`] for terminal output, printing additional suggestions.
-pub fn format_js_error_with_suggestions(
-  js_error: &JsError,
-  suggestions: Vec<FixSuggestion>,
-) -> String {
+/// Format a [`JsError`] for terminal output.
+pub fn format_js_error(js_error: &JsError) -> String {
   let circular =
     find_recursive_cause(js_error).map(|reference| IndexedErrorReference {
       reference,
       index: 1,
     });
-
+  let suggestions = get_suggestions_for_terminal_errors(js_error);
   format_js_error_inner(js_error, circular, true, suggestions)
 }
 
-- 
cgit v1.2.3


From ee904ec06c1a3b3d4e4a87898e777e2f9b587b07 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bartek=20Iwa=C5=84czuk?= <biwanczuk@gmail.com>
Date: Tue, 15 Oct 2024 22:51:39 +0100
Subject: fix: add hint for missing `document` global in terminal error
 (#26218)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This came up on Discord as a question so I thought it's worth adding a
hint for this as it might be a common pitfall.

---------

Signed-off-by: Bartek Iwańczuk <biwanczuk@gmail.com>
Co-authored-by: David Sherret <dsherret@users.noreply.github.com>
---
 runtime/fmt_errors.rs | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'runtime/fmt_errors.rs')

diff --git a/runtime/fmt_errors.rs b/runtime/fmt_errors.rs
index 0d4274e8a..2d9d09a29 100644
--- a/runtime/fmt_errors.rs
+++ b/runtime/fmt_errors.rs
@@ -1,5 +1,6 @@
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
 //! This mod provides DenoError to unify errors across Deno.
+use color_print::cstr;
 use deno_core::error::format_frame;
 use deno_core::error::JsError;
 use deno_terminal::colors::cyan;
@@ -367,6 +368,16 @@ fn get_suggestions_for_terminal_errors(e: &JsError) -> Vec<FixSuggestion> {
           ]
         )
       ];
+    } else if msg.contains("document is not defined") {
+      return vec![
+        FixSuggestion::info(cstr!(
+          "<u>document</> global is not available in Deno."
+        )),
+        FixSuggestion::hint_multiline(&[
+          cstr!("Use a library like <u>happy-dom</>, <u>deno_dom</>, <u>linkedom</> or <u>JSDom</>"),
+          cstr!("and setup the <u>document</> global according to the library documentation."),
+        ]),
+      ];
     }
   }
 
-- 
cgit v1.2.3


From 40b1c42138c47e89eefa859cd36a9e3d62541e7b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bartek=20Iwa=C5=84czuk?= <biwanczuk@gmail.com>
Date: Wed, 16 Oct 2024 00:25:24 +0100
Subject: fix: improve suggestions and hints when using CommonJS modules
 (#26287)

Ref https://github.com/denoland/deno/issues/26225
---
 runtime/fmt_errors.rs | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

(limited to 'runtime/fmt_errors.rs')

diff --git a/runtime/fmt_errors.rs b/runtime/fmt_errors.rs
index 2d9d09a29..8476aab28 100644
--- a/runtime/fmt_errors.rs
+++ b/runtime/fmt_errors.rs
@@ -287,14 +287,20 @@ fn get_suggestions_for_terminal_errors(e: &JsError) -> Vec<FixSuggestion> {
   if let Some(msg) = &e.message {
     if msg.contains("module is not defined")
       || msg.contains("exports is not defined")
+      || msg.contains("require is not defined")
     {
       return vec![
-        FixSuggestion::info(
-          "Deno does not support CommonJS modules without `.cjs` extension.",
-        ),
-        FixSuggestion::hint(
-          "Rewrite this module to ESM or change the file extension to `.cjs`.",
-        ),
+        FixSuggestion::info_multiline(&[
+          cstr!("Deno supports CommonJS modules in <u>.cjs</> files, or when there's a <u>package.json</>"),
+          cstr!("with <i>\"type\": \"commonjs\"</> option and <i>--unstable-detect-cjs</> flag is used.")
+        ]),
+        FixSuggestion::hint_multiline(&[
+          "Rewrite this module to ESM,",
+          cstr!("or change the file extension to <u>.cjs</u>,"),
+          cstr!("or add <u>package.json</> next to the file with <i>\"type\": \"commonjs\"</> option"),
+          cstr!("and pass <i>--unstable-detect-cjs</> flag."),
+        ]),
+        FixSuggestion::hint("See https://docs.deno.com/go/commonjs for details"),
       ];
     } else if msg.contains("openKv is not a function") {
       return vec![
-- 
cgit v1.2.3


From 28b5640657ce875a73eb3a1ffed287a61de164b4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bartek=20Iwa=C5=84czuk?= <biwanczuk@gmail.com>
Date: Tue, 22 Oct 2024 21:22:26 +0100
Subject: refactor: add 'docs' suggestion (#26463)

Adds another kind to `FixSuggestionKind` specifically for links
documentation pages.
---
 runtime/fmt_errors.rs | 51 +++++++++++++++++++++++++++++++++++----------------
 1 file changed, 35 insertions(+), 16 deletions(-)

(limited to 'runtime/fmt_errors.rs')

diff --git a/runtime/fmt_errors.rs b/runtime/fmt_errors.rs
index 8476aab28..7c6cf6d39 100644
--- a/runtime/fmt_errors.rs
+++ b/runtime/fmt_errors.rs
@@ -1,12 +1,10 @@
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
 //! This mod provides DenoError to unify errors across Deno.
+use color_print::cformat;
 use color_print::cstr;
 use deno_core::error::format_frame;
 use deno_core::error::JsError;
-use deno_terminal::colors::cyan;
-use deno_terminal::colors::italic_bold;
-use deno_terminal::colors::red;
-use deno_terminal::colors::yellow;
+use deno_terminal::colors;
 use std::fmt::Write as _;
 
 #[derive(Debug, Clone)]
@@ -25,6 +23,7 @@ struct IndexedErrorReference<'a> {
 enum FixSuggestionKind {
   Info,
   Hint,
+  Docs,
 }
 
 #[derive(Debug)]
@@ -67,6 +66,13 @@ impl<'a> FixSuggestion<'a> {
       message: FixSuggestionMessage::Multiline(messages),
     }
   }
+
+  pub fn docs(url: &'a str) -> Self {
+    Self {
+      kind: FixSuggestionKind::Docs,
+      message: FixSuggestionMessage::Single(url),
+    }
+  }
 }
 
 struct AnsiColors;
@@ -79,10 +85,10 @@ impl deno_core::error::ErrorFormat for AnsiColors {
     use deno_core::error::ErrorElement::*;
     match element {
       Anonymous | NativeFrame | FileName | EvalOrigin => {
-        cyan(s).to_string().into()
+        colors::cyan(s).to_string().into()
       }
-      LineNumber | ColumnNumber => yellow(s).to_string().into(),
-      FunctionName | PromiseAll => italic_bold(s).to_string().into(),
+      LineNumber | ColumnNumber => colors::yellow(s).to_string().into(),
+      FunctionName | PromiseAll => colors::italic_bold(s).to_string().into(),
     }
   }
 }
@@ -115,7 +121,7 @@ fn format_maybe_source_line(
   if column_number as usize > source_line.len() {
     return format!(
       "\n{} Couldn't format source line: Column {} is out of bounds (source may have changed at runtime)",
-      yellow("Warning"), column_number,
+      colors::yellow("Warning"), column_number,
     );
   }
 
@@ -128,9 +134,9 @@ fn format_maybe_source_line(
   }
   s.push('^');
   let color_underline = if is_error {
-    red(&s).to_string()
+    colors::red(&s).to_string()
   } else {
-    cyan(&s).to_string()
+    colors::cyan(&s).to_string()
   };
 
   let indent = format!("{:indent$}", "", indent = level);
@@ -201,7 +207,8 @@ fn format_js_error_inner(
 
   if let Some(circular) = &circular {
     if js_error.is_same_error(circular.reference.to) {
-      write!(s, " {}", cyan(format!("<ref *{}>", circular.index))).unwrap();
+      write!(s, " {}", colors::cyan(format!("<ref *{}>", circular.index)))
+        .unwrap();
     }
   }
 
@@ -239,7 +246,8 @@ fn format_js_error_inner(
       .unwrap_or(false);
 
     let error_string = if is_caused_by_circular {
-      cyan(format!("[Circular *{}]", circular.unwrap().index)).to_string()
+      colors::cyan(format!("[Circular *{}]", circular.unwrap().index))
+        .to_string()
     } else {
       format_js_error_inner(cause, circular, false, vec![])
     };
@@ -256,12 +264,23 @@ fn format_js_error_inner(
     for (index, suggestion) in suggestions.iter().enumerate() {
       write!(s, "    ").unwrap();
       match suggestion.kind {
-        FixSuggestionKind::Hint => write!(s, "{} ", cyan("hint:")).unwrap(),
-        FixSuggestionKind::Info => write!(s, "{} ", yellow("info:")).unwrap(),
+        FixSuggestionKind::Hint => {
+          write!(s, "{} ", colors::cyan("hint:")).unwrap()
+        }
+        FixSuggestionKind::Info => {
+          write!(s, "{} ", colors::yellow("info:")).unwrap()
+        }
+        FixSuggestionKind::Docs => {
+          write!(s, "{} ", colors::green("docs:")).unwrap()
+        }
       };
       match suggestion.message {
         FixSuggestionMessage::Single(msg) => {
-          write!(s, "{}", msg).unwrap();
+          if matches!(suggestion.kind, FixSuggestionKind::Docs) {
+            write!(s, "{}", cformat!("<u>{}</>", msg)).unwrap();
+          } else {
+            write!(s, "{}", msg).unwrap();
+          }
         }
         FixSuggestionMessage::Multiline(messages) => {
           for (idx, message) in messages.iter().enumerate() {
@@ -300,7 +319,7 @@ fn get_suggestions_for_terminal_errors(e: &JsError) -> Vec<FixSuggestion> {
           cstr!("or add <u>package.json</> next to the file with <i>\"type\": \"commonjs\"</> option"),
           cstr!("and pass <i>--unstable-detect-cjs</> flag."),
         ]),
-        FixSuggestion::hint("See https://docs.deno.com/go/commonjs for details"),
+        FixSuggestion::docs("https://docs.deno.com/go/commonjs"),
       ];
     } else if msg.contains("openKv is not a function") {
       return vec![
-- 
cgit v1.2.3


From 484f8ca9c30909914eb3348b2df10d44e2753248 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bartek=20Iwa=C5=84czuk?= <biwanczuk@gmail.com>
Date: Mon, 28 Oct 2024 23:55:51 +0000
Subject: fix: provide hints in terminal errors for Node.js globals (#26610)

Add info/hint for terminal errors related to Node.js globals:
- __filename
- __dirname
- Buffer
- global
- setImmediate
- clearImmediate

Closes https://github.com/denoland/deno/issues/17494
---
 runtime/fmt_errors.rs | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

(limited to 'runtime/fmt_errors.rs')

diff --git a/runtime/fmt_errors.rs b/runtime/fmt_errors.rs
index 7c6cf6d39..4cd8a0634 100644
--- a/runtime/fmt_errors.rs
+++ b/runtime/fmt_errors.rs
@@ -321,6 +321,48 @@ fn get_suggestions_for_terminal_errors(e: &JsError) -> Vec<FixSuggestion> {
         ]),
         FixSuggestion::docs("https://docs.deno.com/go/commonjs"),
       ];
+    } else if msg.contains("__filename is not defined") {
+      return vec![
+        FixSuggestion::info(cstr!(
+          "<u>__filename</> global is not available in ES modules."
+        )),
+        FixSuggestion::hint(cstr!("Use <u>import.meta.filename</> instead.")),
+      ];
+    } else if msg.contains("__dirname is not defined") {
+      return vec![
+        FixSuggestion::info(cstr!(
+          "<u>__dirname</> global is not available in ES modules."
+        )),
+        FixSuggestion::hint(cstr!("Use <u>import.meta.dirname</> instead.")),
+      ];
+    } else if msg.contains("Buffer is not defined") {
+      return vec![
+        FixSuggestion::info(cstr!(
+          "<u>Buffer</> is not available in the global scope in Deno."
+        )),
+        FixSuggestion::hint(cstr!("Import it explicitly with <u>import { Buffer } from \"node:buffer\";</>.")),
+      ];
+    } else if msg.contains("clearImmediate is not defined") {
+      return vec![
+        FixSuggestion::info(cstr!(
+          "<u>clearImmediate</> is not available in the global scope in Deno."
+        )),
+        FixSuggestion::hint(cstr!("Import it explicitly with <u>import { clearImmediate } from \"node:timers\";</>.")),
+      ];
+    } else if msg.contains("setImmediate is not defined") {
+      return vec![
+        FixSuggestion::info(cstr!(
+          "<u>setImmediate</> is not available in the global scope in Deno."
+        )),
+        FixSuggestion::hint(cstr!("Import it explicitly with <u>import { setImmediate } from \"node:timers\";</>.")),
+      ];
+    } else if msg.contains("global is not defined") {
+      return vec![
+        FixSuggestion::info(cstr!(
+          "<u>global</> is not available in the global scope in Deno."
+        )),
+        FixSuggestion::hint(cstr!("Use <u>globalThis</> instead, or assign <u>globalThis.global = globalThis</>.")),
+      ];
     } else if msg.contains("openKv is not a function") {
       return vec![
         FixSuggestion::info("Deno.openKv() is an unstable API."),
-- 
cgit v1.2.3


From f091d1ad69b4e5217ae3272b641171781a372c4f Mon Sep 17 00:00:00 2001
From: David Sherret <dsherret@users.noreply.github.com>
Date: Wed, 13 Nov 2024 10:10:09 -0500
Subject: feat(node): stabilize detecting if CJS via `"type": "commonjs"` in a
 package.json (#26439)

This will respect `"type": "commonjs"` in a package.json to determine if
`.js`/`.jsx`/`.ts`/.tsx` files are CJS or ESM. If the file is found to
be ESM it will be loaded as ESM though.
---
 runtime/fmt_errors.rs | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

(limited to 'runtime/fmt_errors.rs')

diff --git a/runtime/fmt_errors.rs b/runtime/fmt_errors.rs
index 4cd8a0634..28cd70296 100644
--- a/runtime/fmt_errors.rs
+++ b/runtime/fmt_errors.rs
@@ -310,14 +310,13 @@ fn get_suggestions_for_terminal_errors(e: &JsError) -> Vec<FixSuggestion> {
     {
       return vec![
         FixSuggestion::info_multiline(&[
-          cstr!("Deno supports CommonJS modules in <u>.cjs</> files, or when there's a <u>package.json</>"),
-          cstr!("with <i>\"type\": \"commonjs\"</> option and <i>--unstable-detect-cjs</> flag is used.")
+          cstr!("Deno supports CommonJS modules in <u>.cjs</> files, or when the closest"),
+          cstr!("<u>package.json</> has a <i>\"type\": \"commonjs\"</> option.")
         ]),
         FixSuggestion::hint_multiline(&[
           "Rewrite this module to ESM,",
           cstr!("or change the file extension to <u>.cjs</u>,"),
-          cstr!("or add <u>package.json</> next to the file with <i>\"type\": \"commonjs\"</> option"),
-          cstr!("and pass <i>--unstable-detect-cjs</> flag."),
+          cstr!("or add <u>package.json</> next to the file with <i>\"type\": \"commonjs\"</> option."),
         ]),
         FixSuggestion::docs("https://docs.deno.com/go/commonjs"),
       ];
-- 
cgit v1.2.3


From de34c7ed29bcce8b46a65f5effe45090b8493ba5 Mon Sep 17 00:00:00 2001
From: Marvin Hagemeister <marvin@deno.com>
Date: Thu, 14 Nov 2024 14:11:29 +0100
Subject: feat(cli): add `--unstable-node-globals` flag (#26617)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This PR adds a new `--unstable-node-globals` flag to expose Node globals
by default.

Fixes https://github.com/denoland/deno/issues/26611

---------

Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
---
 runtime/fmt_errors.rs | 20 ++++++++++++++++----
 1 file changed, 16 insertions(+), 4 deletions(-)

(limited to 'runtime/fmt_errors.rs')

diff --git a/runtime/fmt_errors.rs b/runtime/fmt_errors.rs
index 28cd70296..6c05fbc63 100644
--- a/runtime/fmt_errors.rs
+++ b/runtime/fmt_errors.rs
@@ -339,28 +339,40 @@ fn get_suggestions_for_terminal_errors(e: &JsError) -> Vec<FixSuggestion> {
         FixSuggestion::info(cstr!(
           "<u>Buffer</> is not available in the global scope in Deno."
         )),
-        FixSuggestion::hint(cstr!("Import it explicitly with <u>import { Buffer } from \"node:buffer\";</>.")),
+        FixSuggestion::hint_multiline(&[
+          cstr!("Import it explicitly with <u>import { Buffer } from \"node:buffer\";</>,"),
+          cstr!("or run again with <u>--unstable-node-globals</> flag to add this global."),
+        ]),
       ];
     } else if msg.contains("clearImmediate is not defined") {
       return vec![
         FixSuggestion::info(cstr!(
           "<u>clearImmediate</> is not available in the global scope in Deno."
         )),
-        FixSuggestion::hint(cstr!("Import it explicitly with <u>import { clearImmediate } from \"node:timers\";</>.")),
+        FixSuggestion::hint_multiline(&[
+          cstr!("Import it explicitly with <u>import { clearImmediate } from \"node:timers\";</>,"),
+          cstr!("or run again with <u>--unstable-node-globals</> flag to add this global."),
+        ]),
       ];
     } else if msg.contains("setImmediate is not defined") {
       return vec![
         FixSuggestion::info(cstr!(
           "<u>setImmediate</> is not available in the global scope in Deno."
         )),
-        FixSuggestion::hint(cstr!("Import it explicitly with <u>import { setImmediate } from \"node:timers\";</>.")),
+        FixSuggestion::hint_multiline(
+          &[cstr!("Import it explicitly with <u>import { setImmediate } from \"node:timers\";</>,"),
+          cstr!("or run again with <u>--unstable-node-globals</> flag to add this global."),
+        ]),
       ];
     } else if msg.contains("global is not defined") {
       return vec![
         FixSuggestion::info(cstr!(
           "<u>global</> is not available in the global scope in Deno."
         )),
-        FixSuggestion::hint(cstr!("Use <u>globalThis</> instead, or assign <u>globalThis.global = globalThis</>.")),
+        FixSuggestion::hint_multiline(&[
+          cstr!("Use <u>globalThis</> instead, or assign <u>globalThis.global = globalThis</>,"),
+          cstr!("or run again with <u>--unstable-node-globals</> flag to add this global."),
+        ]),
       ];
     } else if msg.contains("openKv is not a function") {
       return vec![
-- 
cgit v1.2.3