chore(tools): improved web-compatibility checks (#3263)

denoland · Mar 18, 2023 · cf14c9b · cf14c9b
1 parent 8708618
commit cf14c9b
Show file tree

Hide file tree

Showing 110 changed files with 191 additions and 7 deletions.
diff --git a/_tools/check_browser_compat.ts b/_tools/check_browser_compat.ts
@@ -0,0 +1,48 @@
+// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+
+/**
+ * Running this script provides a list of suggested files that might be browser-compatible.
+ * It skips test code, benchmark code, internal code and `version.ts` at the root.
+ *
+ * Run using: deno run --allow-read --allow-run _tools/check_browser_compat.ts
+ */
+import { walkSync } from "../fs/walk.ts";
+
+const ROOT = new URL("../", import.meta.url);
+const SKIP = [/(test|bench|\/_|\\_|testdata|version.ts)/];
+const DECLARATION = "// This module is browser compatible.";
+
+function isBrowserCompatible(filePath: string): boolean {
+  const command = new Deno.Command(Deno.execPath(), {
+    args: [
+      "check",
+      "--config",
+      "browser-compat.tsconfig.json",
+      filePath,
+    ],
+  });
+  const { success } = command.outputSync();
+  return success;
+}
+
+function hasBrowserCompatibleComment(path: string): boolean {
+  const output = Deno.readTextFileSync(path);
+  return output.includes(DECLARATION);
+}
+
+const maybeBrowserCompatibleFiles: string[] = [];
+
+for (const { path } of walkSync(ROOT, { exts: [".ts"], skip: SKIP })) {
+  if (isBrowserCompatible(path) && !hasBrowserCompatibleComment(path)) {
+    maybeBrowserCompatibleFiles.push(path);
+  }
+}
+
+if (maybeBrowserCompatibleFiles.length) {
+  console.log(
+    `The following files are likely browser-compatible and can have the "${DECLARATION}" comment added:`,
+  );
+  maybeBrowserCompatibleFiles.forEach((path, index) =>
+    console.log(`${index + 1}. ${path}`)
+  );
+}
diff --git a/async/abortable.ts b/async/abortable.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 import { deferred } from "./deferred.ts";
 
 /**

diff --git a/async/retry.ts b/async/retry.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 export class RetryError extends Error {
   constructor(cause: unknown, count: number) {

diff --git a/collections/binary_heap.ts b/collections/binary_heap.ts
@@ -1,5 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
-/** This module is browser compatible. */
+// This module is browser compatible.
 
 import { descend } from "./_comparators.ts";
 

diff --git a/collections/binary_search_node.ts b/collections/binary_search_node.ts
@@ -1,5 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
-/** This module is browser compatible. */
+// This module is browser compatible.
 
 export type Direction = "left" | "right";
 

diff --git a/collections/binary_search_tree.ts b/collections/binary_search_tree.ts
@@ -1,5 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
-/** This module is browser compatible. */
+// This module is browser compatible.
 
 import { ascend } from "./_comparators.ts";
 import { BinarySearchNode, Direction } from "./binary_search_node.ts";

diff --git a/collections/mod.ts b/collections/mod.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /** Functions for specific common tasks around collection types like `Array` and
  * `Record`. This module is heavily inspired by `kotlin`s stdlib.

diff --git a/collections/red_black_node.ts b/collections/red_black_node.ts
@@ -1,5 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
-/** This module is browser compatible. */
+// This module is browser compatible.
 
 import { BinarySearchNode, Direction } from "./binary_search_node.ts";
 export type { Direction };

diff --git a/collections/red_black_tree.ts b/collections/red_black_tree.ts
@@ -1,5 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
-/** This module is browser compatible. */
+// This module is browser compatible.
 
 import { ascend, BinarySearchTree } from "./binary_search_tree.ts";
 import { Direction, RedBlackNode } from "./red_black_node.ts";

diff --git a/crypto/crypto.ts b/crypto/crypto.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /**
  * Extensions to the

diff --git a/crypto/mod.ts b/crypto/mod.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /**
  * Extensions to the

diff --git a/crypto/timing_safe_equal.ts b/crypto/timing_safe_equal.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 import { assert } from "../_util/asserts.ts";
 

diff --git a/crypto/to_hash_string.ts b/crypto/to_hash_string.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 import { encode as hexEncode } from "../encoding/hex.ts";
 import { encode as base64Encode } from "../encoding/base64.ts";
 

diff --git a/csv/mod.ts b/csv/mod.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 export * from "./stringify.ts";
 export * from "./parse.ts";
 export * from "./stream.ts";
diff --git a/csv/parse.ts b/csv/parse.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 import {
   convertRowToObject,
   ERR_BARE_QUOTE,

diff --git a/csv/stream.ts b/csv/stream.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 import {
   convertRowToObject,
   defaultReadOptions,

diff --git a/csv/stringify.ts b/csv/stringify.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 type PropertyAccessor = number | string;
 type ObjectWithStringPropertyKeys = Record<string, unknown>;
 

diff --git a/datetime/constants.ts b/datetime/constants.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 /**
  * The number of milliseconds in a second.
  *

diff --git a/datetime/day_of_year.ts b/datetime/day_of_year.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 import { DAY } from "./constants.ts";
 
 /**

diff --git a/datetime/difference.ts b/datetime/difference.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 import { DAY, HOUR, MINUTE, SECOND, WEEK } from "./constants.ts";
 
 export type Unit =

diff --git a/datetime/format.ts b/datetime/format.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 import { DateTimeFormatter } from "./_common.ts";
 
 /**

diff --git a/datetime/is_leap.ts b/datetime/is_leap.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 /**
  * Returns whether the given date or year (in number) is a leap year or not.
  * based on: https://docs.microsoft.com/en-us/office/troubleshoot/excel/determine-a-leap-year

diff --git a/datetime/mod.ts b/datetime/mod.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /**
  * Utilities for dealing with {@linkcode Date} objects.

diff --git a/datetime/parse.ts b/datetime/parse.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 import { DateTimeFormatter } from "./_common.ts";
 
 /**

diff --git a/datetime/to_imf.ts b/datetime/to_imf.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 /**
  * Formats the given date to IMF date time format. (Reference:
  * https://tools.ietf.org/html/rfc7231#section-7.1.1.1).

diff --git a/datetime/week_of_year.ts b/datetime/week_of_year.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 import { DAY, WEEK } from "./constants.ts";
 
 const DAYS_PER_WEEK = 7;

diff --git a/deno.json b/deno.json
@@ -32,8 +32,8 @@
     }
   },
   "tasks": {
-    "test": "deno test --doc --unstable --allow-all --coverage=./cov --ignore=_tools/testdata",
-    "test:browser": "git grep --name-only \"This module is browser compatible.\" | grep -v deno.json | grep -v .github/workflows | xargs deno cache --check --reload --config browser-compat.tsconfig.json",
+    "test": "deno test --doc --unstable --allow-all --coverage=./cov",
+    "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 ./_tools/check_deprecation.ts",
     "lint:doc-imports": "deno run --allow-env --allow-read ./_tools/check_doc_imports.ts",

diff --git a/encoding/ascii85.ts b/encoding/ascii85.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /**
  * {@linkcode encode} and {@linkcode decode} for

diff --git a/encoding/base32.ts b/encoding/base32.ts
@@ -1,5 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
 // Copyright (c) 2014 Jameson Little. MIT License.
+// This module is browser compatible.
 
 /**
  * {@linkcode encode} and {@linkcode decode} for

diff --git a/encoding/base58.ts b/encoding/base58.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /**
  * {@linkcode encode} and {@linkcode decode} for

diff --git a/encoding/base64.ts b/encoding/base64.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /**
  * {@linkcode encode} and {@linkcode decode} for

diff --git a/encoding/base64url.ts b/encoding/base64url.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /**
  * {@linkcode encode} and {@linkcode decode} for

diff --git a/encoding/csv/stream.ts b/encoding/csv/stream.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 export {
   /** @deprecated (will be removed after 0.182.0) Import from `csv/stream.ts` instead. */
   CsvStream,

diff --git a/encoding/hex.ts b/encoding/hex.ts
@@ -1,6 +1,7 @@
 // Copyright 2009 The Go Authors. All rights reserved.
 // https://github.com/golang/go/blob/master/LICENSE
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /** Port of the Go
  * [encoding/hex](https://github.com/golang/go/blob/go1.12.5/src/encoding/hex/hex.go)

diff --git a/encoding/jsonc.ts b/encoding/jsonc.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /**
  * @deprecated (will be removed after 0.182.0) Import from `std/jsonc` instead.

diff --git a/encoding/toml.ts b/encoding/toml.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /**
  * @deprecated (will be removed after 0.182.0) Import from `std/toml` instead.

diff --git a/encoding/varint/mod.ts b/encoding/varint/mod.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /**
  * Functions for encoding typed integers in array buffers.

diff --git a/encoding/yaml.ts b/encoding/yaml.ts
@@ -1,5 +1,6 @@
 // Copyright 2011-2015 by Vitaly Puzrin. All rights reserved. MIT license.
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /**
  * @deprecated (will be removed after 0.182.0) Import from `std/yaml` instead.

diff --git a/examples/welcome.ts b/examples/welcome.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /** Welcome to Deno!
  *

diff --git a/flags/mod.ts b/flags/mod.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 /**
  * Command line arguments parser based on
  * [minimist](https://github.com/minimistjs/minimist).

diff --git a/fmt/bytes.ts b/fmt/bytes.ts
@@ -1,6 +1,7 @@
 // Copyright 2014-2021 Sindre Sorhus. All rights reserved. MIT license.
 // Copyright 2021 Yoshiya Hinosawa. All rights reserved. MIT license.
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /** Pretty print bytes.
  *

diff --git a/fmt/colors.ts b/fmt/colors.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 // A module to print ANSI terminal colors. Inspired by chalk, kleur, and colors
 // on npm.
 

diff --git a/fmt/duration.ts b/fmt/duration.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /**
  * Format milliseconds to time duration.

diff --git a/http/cookie_map.ts b/http/cookie_map.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /** Provides a iterable map interfaces for managing cookies server side.
  *

diff --git a/http/http_errors.ts b/http/http_errors.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /** A collection of HTTP errors and utilities.
  *

diff --git a/http/negotiation.ts b/http/negotiation.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /**
  * Contains the functions {@linkcode accepts}, {@linkcode acceptsEncodings}, and

diff --git a/http/server_sent_event.ts b/http/server_sent_event.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 /**
  * Provides {@linkcode ServerSentEvent} and

diff --git a/http/util.ts b/http/util.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 import { Status, STATUS_TEXT } from "./http_status.ts";
 import { deepMerge } from "../collections/deep_merge.ts";
 

diff --git a/io/buf_reader.ts b/io/buf_reader.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 import { assert } from "../_util/asserts.ts";
 import { copy } from "../bytes/copy.ts";

diff --git a/io/buf_writer.ts b/io/buf_writer.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 import { copy } from "../bytes/copy.ts";
 import type { Writer, WriterSync } from "../types.d.ts";

diff --git a/io/buffer.ts b/io/buffer.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 import { assert } from "../_util/asserts.ts";
 import { copy } from "../bytes/copy.ts";
 import type { Reader, ReaderSync } from "../types.d.ts";

diff --git a/io/copy_n.ts b/io/copy_n.ts
@@ -1,4 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
 
 import { assert } from "../_util/asserts.ts";
 import type { Reader, Writer } from "../types.d.ts";

diff --git a/io/limited_reader.ts b/io/limited_reader.ts
@@ -1,4 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
 /**
  * A `LimitedReader` reads from `reader` but limits the amount of data returned to just `limit` bytes.
  * Each call to `read` updates `limit` to reflect the new amount remaining.