tweaks

denoland · Jan 19, 2024 · 91cd789 · 91cd789
1 parent 425294f
commit 91cd789
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 9 deletions.
diff --git a/deno.json b/deno.json
@@ -12,7 +12,7 @@
     "automation/": "https://raw.githubusercontent.com/denoland/automation/0.10.0/"
   },
   "tasks": {
-    "test": "NO_DEPRECATION_WARNINGS=1 deno test --doc --unstable --allow-all --parallel --coverage --trace-ops",
+    "test": "DENO_NO_DEPRECATION_WARNINGS=1 deno test --doc --unstable --allow-all --parallel --coverage --trace-ops",
     "test:browser": "git grep --name-only \"This module is browser compatible.\" | grep -v deno.json | grep -v .github/workflows | grep -v _tools | xargs deno check --config browser-compat.tsconfig.json",
     "fmt:licence-headers": "deno run --allow-read --allow-write ./_tools/check_licence.ts",
     "lint:deprecations": "deno run --allow-read --allow-net --allow-env=HOME ./_tools/check_deprecation.ts",

diff --git a/internal/warn_on_deprecated_api.ts b/internal/warn_on_deprecated_api.ts
@@ -5,6 +5,10 @@
 const { Deno } = globalThis as any;
 
 const ALREADY_WARNED_DEPRECATED = new Set<string>();
+const ENV_VAR_KEY = "DENO_NO_DEPRECATION_WARNINGS";
+const shouldDisableDeprecatedApiWarning =
+  Deno?.permissions.querySync({ name: "env", variable: ENV_VAR_KEY })
+      .state === "granted" && Deno?.env.get(ENV_VAR_KEY) === "1";
 
 interface WarnDeprecatedApiConfig {
   /** The name of the deprecated API. */
@@ -20,15 +24,14 @@ interface WarnDeprecatedApiConfig {
 /**
  * Prints a warning message to the console for the given deprecated API.
  *
- * These warnings can be disabled by setting `NO_DEPRECATION_WARNINGS=1`
+ * These warnings can be disabled by setting `DENO_NO_DEPRECATION_WARNINGS=1`
  * in the current process.
+ *
+ * Mostly copied from
+ * {@link https://github.com/denoland/deno/blob/c62615bfe5a070c2517f3af3208d4308c72eb054/runtime/js/99_main.js#L101}.
  */
 export function warnOnDeprecatedApi(config: WarnDeprecatedApiConfig) {
-  const variable = "NO_DEPRECATION_WARNINGS";
-  if (
-    Deno?.permissions.querySync({ name: "env", variable }).state ===
-      "granted" && Deno?.env.get(variable) === "1"
-  ) return;
+  if (shouldDisableDeprecatedApiWarning) return;
 
   const key = config.apiName + config.stack;
   if (ALREADY_WARNED_DEPRECATED.has(key)) return;
@@ -78,7 +81,7 @@ export function warnOnDeprecatedApi(config: WarnDeprecatedApiConfig) {
   console.log("%c\u2502", "color: yellow;");
   console.log("%c\u2502", "color: yellow;");
   console.log(
-    "%c\u251c Set `NO_DEPRECATION_WARNINGS=1` to disable these deprecation warnings.",
+    "%c\u251c Set `DENO_NO_DEPRECATION_WARNINGS=1` to disable these deprecation warnings.",
     "color: yellow;",
   );
   console.log("%c\u2514 Stack trace:", "color: yellow;");

diff --git a/internal/warn_on_deprecated_api_test.ts b/internal/warn_on_deprecated_api_test.ts
@@ -21,7 +21,7 @@ Deno.test("warnDeprecatedApi()", async () => {
 ├ Suggestion: Do something else instead.
 │
 │
-├ Set \`NO_DEPRECATION_WARNINGS=1\` to disable these deprecation warnings.
+├ Set \`DENO_NO_DEPRECATION_WARNINGS=1\` to disable these deprecation warnings.
 └ Stack trace:
   ├─ at fn (${import.meta.url}:39:12)
   └─ at ${import.meta.url}:47:31