fix: update codebase to work with Deno RC (#6018)

* fix: update codebase to work with Deno RC * work * fix * fix * fix * fixes * work * update * fixes * fix * revert
denoland · Sep 19, 2024 · 0b2497f · 0b2497f
1 parent 6a4eb6c
commit 0b2497f
Show file tree

Hide file tree

Showing 96 changed files with 247 additions and 294 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -163,12 +163,12 @@ Example code snippets must:
    [documentation checker tool](../_tools/check_docs.ts) and are flagged when
    they throw an error.
 
-Note: To skip running a specific code snippet, add `no-eval` to the starting
+Note: To skip running a specific code snippet, add `ignore` to the starting
 delimiter. E.g.
 
 ````ts
 /**
- * ```ts no-eval
+ * ```ts ignore
  * (code snippet will not be run)
  * ```
  */

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -41,8 +41,6 @@ jobs:
         run: |
           deno task test
           rm deno.lock # remove deno.lock (v4) as it's incompatible with v3
-        env:
-          DENO_FUTURE: 1
 
       - name: Run timezone-dependent tests
         run: |
@@ -55,15 +53,16 @@ jobs:
       # - name: Type check browser compatible modules
       #   run: deno task test:browser
 
-      - name: Generate lcov
-        run: deno task cov:gen
+      # TODO(iuioiua): Enable this once https://github.com/denoland/deno/pull/25736 is merged
+      # - name: Generate lcov
+      #   run: deno task cov:gen
 
-      - name: Upload coverage
-        uses: codecov/codecov-action@v4
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-        with:
-          name: ${{ matrix.os }}-${{ matrix.deno }}
+      # - name: Upload coverage
+      #   uses: codecov/codecov-action@v4
+      #   env:
+      #     CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+      #   with:
+      #     name: ${{ matrix.os }}-${{ matrix.deno }}
 
   test-node:
     runs-on: ${{ matrix.os }}

diff --git a/_tools/check_docs.ts b/_tools/check_docs.ts
@@ -194,55 +194,6 @@ function assertHasParamTag(
   }
 }
 
-async function assertSnippetEvals(
-  {
-    snippet,
-    document,
-    expectError,
-  }: {
-    snippet: string;
-    document: { jsDoc: JsDoc; location: Location };
-    expectError: boolean;
-  },
-) {
-  const command = new Deno.Command(Deno.execPath(), {
-    args: [
-      "eval",
-      "--ext=ts",
-      "--unstable-webgpu",
-      "--check",
-      "--no-lock",
-      snippet,
-    ],
-    stderr: "piped",
-  });
-  const timeoutId = setTimeout(() => {
-    // deno-lint-ignore no-console
-    console.warn(
-      `Snippet at ${document.location.filename}:${document.location.line} has been running for more than 10 seconds...\n${snippet}`,
-    );
-  }, 10_000);
-  try {
-    const { success, stderr } = await command.output();
-    const error = new TextDecoder().decode(stderr);
-    if (expectError) {
-      assert(
-        !success,
-        `Snippet is expected to have errors, but executed successfully: \n${snippet}\n${error}`,
-        document,
-      );
-    } else {
-      assert(
-        success,
-        `Failed to execute snippet: \n${snippet}\n${error}`,
-        document,
-      );
-    }
-  } finally {
-    clearTimeout(timeoutId);
-  }
-}
-
 function assertSnippetsWork(
   doc: string,
   document: { jsDoc: JsDoc; location: Location },
@@ -264,24 +215,15 @@ function assertSnippetsWork(
   }
   for (let snippet of snippets) {
     const delim = snippet.split(NEWLINE)[0];
-    if (delim?.includes("no-eval")) continue;
     // Trim the code block delimiters
     snippet = snippet.split(NEWLINE).slice(1, -1).join(NEWLINE);
-    if (!delim?.includes("no-assert")) {
+    if (!(delim?.includes("no-assert") || delim?.includes("ignore"))) {
       assert(
         snippet.match(ASSERTION_IMPORT) !== null,
         "Snippet must contain assertion from '@std/assert'",
         document,
       );
     }
-    snippetPromises.push(
-      () =>
-        assertSnippetEvals({
-          snippet,
-          document,
-          expectError: delim?.includes("expect-error") ?? false,
-        }),
-    );
   }
 }
 

diff --git a/archive/mod.ts b/archive/mod.ts
@@ -34,7 +34,7 @@
  * archive file, while untar is the inverse utility to extract the files from an
  * archive. Files are not compressed, only collected into the archive.
  *
- * ```ts no-eval
+ * ```ts ignore
  * import { Tar } from "@std/archive/tar";
  * import { Buffer } from "@std/io/buffer";
  * import { copy } from "@std/io/copy";

diff --git a/archive/tar.ts b/archive/tar.ts
@@ -225,7 +225,7 @@ export interface TarDataWithSource extends TarData {
  * * Sparse files are not supported
  *
  * @example Usage
- * ```ts no-eval
+ * ```ts ignore
  * import { Tar } from "@std/archive/tar";
  * import { Buffer } from "@std/io/buffer";
  * import { copy } from "@std/io/copy";
@@ -277,7 +277,7 @@ export class Tar {
    * reference to the content itself and potentially any related metadata.
    *
    * @example Usage
-   * ```ts no-eval
+   * ```ts ignore
    * import { Tar } from "@std/archive/tar";
    * import { Buffer } from "@std/io/buffer";
    * import { copy } from "@std/io/copy";
@@ -429,7 +429,7 @@ export class Tar {
    * @returns A reader instance for the tar archive.
    *
    * @example Usage
-   * ```ts no-eval
+   * ```ts ignore
    * import { Tar } from "@std/archive/tar";
    * import { Buffer } from "@std/io/buffer";
    * import { copy } from "@std/io/copy";

diff --git a/archive/untar.ts b/archive/untar.ts
@@ -108,7 +108,7 @@ function parseHeader(buffer: Uint8Array): TarHeader {
  * @experimental **UNSTABLE**: New API, yet to be vetted.
  *
  * @example Usage
- * ```ts no-assert
+ * ```ts ignore
  * import { TarEntry } from "@std/archive/untar";
  * import { Buffer } from "@std/io/buffer";
  *
@@ -139,7 +139,7 @@ export interface TarEntry extends TarMetaWithLinkName {}
  * @experimental **UNSTABLE**: New API, yet to be vetted.
  *
  * @example Usage
- * ```ts no-assert
+ * ```ts ignore
  * import { TarEntry } from "@std/archive/untar";
  * import { Buffer } from "@std/io/buffer";
  *
@@ -192,7 +192,7 @@ export class TarEntry implements Reader {
    * @returns Whether the entry has already been consumed.
    *
    * @example Usage
-   * ```ts
+   * ```ts ignore
    * import { TarEntry } from "@std/archive/untar";
    * import { Buffer } from "@std/io/buffer";
    * import { assertEquals } from "@std/assert/equals";
@@ -232,7 +232,7 @@ export class TarEntry implements Reader {
    * there are no more bytes to read.
    *
    * @example Usage
-   * ```ts
+   * ```ts ignore
    * import { Tar, Untar } from "@std/archive";
    * import { assertEquals } from "@std/assert/equals";
    * import { Buffer } from "@std/io/buffer";
@@ -288,7 +288,7 @@ export class TarEntry implements Reader {
    * Discords the current entry.
    *
    * @example Usage
-   * ```ts
+   * ```ts ignore
    * import { Buffer } from "@std/io/buffer";
    * import { TarEntry } from "@std/archive/untar";
    * import { assertEquals } from "@std/assert/equals";
@@ -356,7 +356,7 @@ export class TarEntry implements Reader {
  * the files.
  *
  * @example Usage
- * ```ts no-eval
+ * ```ts ignore
  * import { Untar } from "@std/archive/untar";
  * import { ensureFile } from "@std/fs/ensure-file";
  * import { ensureDir } from "@std/fs/ensure-dir";
@@ -484,7 +484,7 @@ export class Untar {
    * or null if there are no more entries to extract.
    *
    * @example Usage
-   * ```ts
+   * ```ts ignore
    * import { Tar, Untar } from "@std/archive";
    * import { Buffer } from "@std/io/buffer";
    * import { readAll } from "@std/io/read-all";
@@ -534,7 +534,7 @@ export class Untar {
    * @returns An async iterator.
    *
    * @example Usage
-   * ```ts no-eval
+   * ```ts ignore
    * import { Untar } from "@std/archive/untar";
    * import { ensureFile } from "@std/fs/ensure-file";
    * import { ensureDir } from "@std/fs/ensure-dir";

diff --git a/assert/almost_equals.ts b/assert/almost_equals.ts
@@ -12,7 +12,7 @@ import { AssertionError } from "./assertion_error.ts";
  * expected value.
  *
  * @example Usage
- * ```ts no-eval
+ * ```ts ignore
  * import { assertAlmostEquals } from "@std/assert";
  *
  * assertAlmostEquals(0.01, 0.02); // Throws

diff --git a/assert/array_includes.ts b/assert/array_includes.ts
@@ -15,7 +15,7 @@ export type ArrayLikeArg<T> = ArrayLike<T> & object;
  * same type.
  *
  * @example Usage
- * ```ts no-eval
+ * ```ts ignore
  * import { assertArrayIncludes } from "@std/assert";
  *
  * assertArrayIncludes([1, 2], [2]); // Doesn't throw

diff --git a/assert/assert.ts b/assert/assert.ts
@@ -6,7 +6,7 @@ import { AssertionError } from "./assertion_error.ts";
  * Make an assertion, error will be thrown if `expr` does not have truthy value.
  *
  * @example Usage
- * ```ts no-eval
+ * ```ts ignore
  * import { assert } from "@std/assert";
  *
  * assert("hello".includes("ello")); // Doesn't throw

diff --git a/assert/assertion_error.ts b/assert/assertion_error.ts
@@ -5,7 +5,7 @@
  * Error thrown when an assertion fails.
  *
  * @example Usage
- * ```ts no-eval
+ * ```ts ignore
  * import { AssertionError } from "@std/assert";
  *
  * try {

diff --git a/assert/equal.ts b/assert/equal.ts
@@ -13,15 +13,15 @@ function constructorsEqual(a: object, b: object) {
 }
 
 /**
- * Deep equality comparison used in assertions
+ * Deep equality comparison used in assertions.
  *
  * @param c The actual value
  * @param d The expected value
  * @returns `true` if the values are deeply equal, `false` otherwise
  *
  * @example Usage
  * ```ts
- * import { equal } from "@std/assert";
+ * import { equal } from "@std/assert/equal";
  *
  * equal({ foo: "bar" }, { foo: "bar" }); // Returns `true`
  * equal({ foo: "bar" }, { foo: "baz" }); // Returns `false

diff --git a/assert/equals.ts b/assert/equals.ts
@@ -16,7 +16,7 @@ import { AssertionError } from "./assertion_error.ts";
  * same type.
  *
  * @example Usage
- * ```ts no-eval
+ * ```ts ignore
  * import { assertEquals } from "@std/assert";
  *
  * assertEquals("world", "world"); // Doesn't throw

diff --git a/assert/exists.ts b/assert/exists.ts
@@ -7,7 +7,7 @@ import { AssertionError } from "./assertion_error.ts";
  * If not then throw.
  *
  * @example Usage
- * ```ts no-eval
+ * ```ts ignore
  * import { assertExists } from "@std/assert";
  *
  * assertExists("something"); // Doesn't throw

diff --git a/assert/fail.ts b/assert/fail.ts
@@ -6,7 +6,7 @@ import { AssertionError } from "./assertion_error.ts";
  * Forcefully throws a failed assertion.
  *
  * @example Usage
- * ```ts no-eval
+ * ```ts ignore
  * import { fail } from "@std/assert";
  *
  * fail("Deliberately failed!"); // Throws

diff --git a/assert/false.ts b/assert/false.ts
@@ -9,7 +9,7 @@ export type Falsy = false | 0 | 0n | "" | null | undefined;
  * Make an assertion, error will be thrown if `expr` have truthy value.
  *
  * @example Usage
- * ```ts no-eval
+ * ```ts ignore
  * import { assertFalse } from "@std/assert";
  *
  * assertFalse(false); // Doesn't throw

diff --git a/assert/greater.ts b/assert/greater.ts
@@ -8,7 +8,7 @@ import { AssertionError } from "./assertion_error.ts";
  * If not then throw.
  *
  * @example Usage
- * ```ts no-eval
+ * ```ts ignore
  * import { assertGreater } from "@std/assert";
  *
  * assertGreater(2, 1); // Doesn't throw

diff --git a/assert/greater_or_equal.ts b/assert/greater_or_equal.ts
@@ -8,7 +8,7 @@ import { AssertionError } from "./assertion_error.ts";
  * If not then throw.
  *
  * @example Usage
- * ```ts no-eval
+ * ```ts ignore
  * import { assertGreaterOrEqual } from "@std/assert";
  *
  * assertGreaterOrEqual(2, 1); // Doesn't throw

diff --git a/assert/instance_of.ts b/assert/instance_of.ts
@@ -13,7 +13,7 @@ export type GetConstructorType<T extends AnyConstructor> = InstanceType<T>;
  * If not then throw.
  *
  * @example Usage
- * ```ts no-eval
+ * ```ts ignore
  * import { assertInstanceOf } from "@std/assert";
  *
  * assertInstanceOf(new Date(), Date); // Doesn't throw

diff --git a/assert/is_error.ts b/assert/is_error.ts
@@ -10,7 +10,7 @@ import { stripAnsiCode } from "@std/internal/styles";
  * error message can also be asserted.
  *
  * @example Usage
- * ```ts no-eval
+ * ```ts ignore
  * import { assertIsError } from "@std/assert";
  *
  * assertIsError(null); // Throws

diff --git a/assert/less.ts b/assert/less.ts
@@ -8,7 +8,7 @@ import { AssertionError } from "./assertion_error.ts";
  * If not then throw.
  *
  * @example Usage
- * ```ts no-eval
+ * ```ts ignore
  * import { assertLess } from "@std/assert";
  *
  * assertLess(1, 2); // Doesn't throw

diff --git a/assert/less_or_equal.ts b/assert/less_or_equal.ts
@@ -8,7 +8,7 @@ import { AssertionError } from "./assertion_error.ts";
  * If not then throw.
  *
  * @example Usage
- * ```ts no-eval
+ * ```ts ignore
  * import { assertLessOrEqual } from "@std/assert";
  *
  * assertLessOrEqual(1, 2); // Doesn't throw

diff --git a/assert/match.ts b/assert/match.ts
@@ -7,7 +7,7 @@ import { AssertionError } from "./assertion_error.ts";
  * then throw.
  *
  * @example Usage
- * ```ts no-eval
+ * ```ts ignore
  * import { assertMatch } from "@std/assert";
  *
  * assertMatch("Raptor", /Raptor/); // Doesn't throw