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

_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}`)
+ );
+}

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";
 
 /**

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) {

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";
 

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";
 

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";

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.

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 };

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";

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

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

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";
 

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";
 

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";

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,

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,

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>;
 

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.
  *

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";
 
 /**

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 =

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";
 
 /**

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

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.

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";
 
 /**

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).

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;

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",

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

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

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

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

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

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,

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)

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.

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.

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.

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.

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!
  *

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).

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.
  *

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.
 

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.

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.
  *

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.
  *

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

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

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";
 

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";

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";

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";

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";

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.