A modern runtime for JavaScript and TypeScript.
Go to file
Yusuke Tanaka 0ea71abdef
fix(cli): handle edge cases around exports in doc tests and default export (#25720)
This commit fixes issues with the pseudo test file generation logic,
namely:

- `export`s declared in snippets
- auto import insertion for `default export`

## Case 1: `export`s declared in snippets

In the previous implementation, `export`s declared in snippets were
moved to the top level of the module in the generated pseudo test file.
This is required because `export` must be at the top level.

This becomes a problem if such a `export` has a body, containing a
reference to a local variable. Suppose we extract this snippet from
JSDoc:

```ts
const logger = createLogger("my-awesome-module");

export function sum(a: number, b: number): number {
  logger.debug("sum called");
  return a + b;
}
```

This gets converted into the following invalid code (note that `export
function sum` is moved to the top level, but its body references
`logger` variable which can't be referenced from here):

```ts
export function sum(a: number, b: number): number {
  logger.debug("sum called");
  return a + b;
}

Deno.test("./base.ts$1-7.ts", async () => {
  const logger = createLogger("my-awesome-module");
});
```

To resolve this issue, this commit adds a logic to remove the `export`
keyword, allowing the exported items to stay in the `Deno.test` block
scope, like so:

```ts
Deno.test("./base.ts$1-7.ts", async () => {
  const logger = createLogger("my-awesome-module");

  function sum(a: number, b: number): number {
    logger.debug("sum called");
    return a + b;
  }
});
```

## Case 2: default export

Previously `default export foo` was not captured by the export
collector, so auto import insertion didn't work for this case. To put it
concretely, the following code snippet didn't work when run with `deno
test --doc` because `import foo from "file:///path/to/mod.ts"` didn't
get inserted automatically:

```ts
/**
 * ```ts
 * console.log(foo);
 * ```
 * 
 * @module
 */

const foo = 42;
export default foo;
```

This commit fixes this issue and the above example works fine.

---

Fixes #25718
2024-09-19 00:19:40 -07:00
.cargo feat: bring back WebGPU (#20812) 2023-12-09 01:19:16 +01:00
.devcontainer fix(devcontainer): moved settings to customizations/vscode (#21512) 2023-12-19 13:29:39 +01:00
.github ci: bump fetch depth to unblock canary uploads (#25716) 2024-09-19 00:37:13 +00:00
bench_util chore: forward v1.46.3 release commit to main (#25425) 2024-09-04 17:16:24 +00:00
cli fix(cli): handle edge cases around exports in doc tests and default export (#25720) 2024-09-19 00:19:40 -07:00
ext refactor(ext/webgpu): align error messages (#25719) 2024-09-19 09:14:54 +02:00
runtime fix: do not panic running invalid file specifier (#25530) 2024-09-18 14:51:39 +01:00
tests refactor(ext/webgpu): align error messages (#25719) 2024-09-19 09:14:54 +02:00
tools feat: default to TS for file extension and support ext flag in more scenarios (#25472) 2024-09-18 21:15:13 +02:00
.dlint.json chore: enable no-console dlint rule (#25113) 2024-08-20 15:14:37 -04:00
.dprint.json feat: default to TS for file extension and support ext flag in more scenarios (#25472) 2024-09-18 21:15:13 +02:00
.editorconfig chore(tests): Remove vestiges of cli/tests folder (#22712) 2024-03-05 13:49:21 -07:00
.gitattributes chore: move cli/tests/ -> tests/ (#22369) 2024-02-10 20:22:13 +00:00
.gitignore chore: move tools/wpt to tests/wpt/runner (#22545) 2024-03-05 00:41:16 +00:00
.gitmodules chore: make remaining submodules shallow (#23441) 2024-04-18 19:45:09 +00:00
.rustfmt.toml chore: update copyright year to 2023 (#17247) 2023-01-02 21:00:42 +00:00
Cargo.lock v2.0.0-rc.3 (#25704) 2024-09-18 23:21:45 +02:00
Cargo.toml feat(ext/node): add rootCertificates to node:tls (#25707) 2024-09-18 21:14:26 +02:00
import_map.json chore: update std submodule (#25595) 2024-09-12 22:32:09 +10:00
LICENSE.md chore: update LICENSE.md to 2024 (#21833) 2024-01-06 19:14:38 -05:00
README.md chore: update references to deno_std to use JSR (#23239) 2024-04-10 17:26:35 -04:00
Releases.md chore: forward v1.46.3 release commit to main (#25425) 2024-09-04 17:16:24 +00:00
rust-toolchain.toml chore: Rust 1.80.1 (#25089) 2024-08-18 22:24:56 -04:00

Deno

Twitter badge Discord badge YouTube badge

the deno mascot dinosaur standing in the rain

Deno (/ˈdiːnoʊ/, pronounced dee-no) is a JavaScript, TypeScript, and WebAssembly runtime with secure defaults and a great developer experience. It's built on V8, Rust, and Tokio.

Learn more about the Deno runtime in the documentation.

Installation

Install the Deno runtime on your system using one of the commands below. Note that there are a number of ways to install Deno - a comprehensive list of installation options can be found here.

Shell (Mac, Linux):

curl -fsSL https://deno.land/install.sh | sh

PowerShell (Windows):

irm https://deno.land/install.ps1 | iex

Homebrew (Mac):

brew install deno

Chocolatey (Windows):

choco install deno

Build and install from source

Complete instructions for building Deno from source can be found in the manual here.

Your first Deno program

Deno can be used for many different applications, but is most commonly used to build web servers. Create a file called server.ts and include the following TypeScript code:

Deno.serve((_req: Request) => {
  return new Response("Hello, world!");
});

Run your server with the following command:

deno run --allow-net server.ts

This should start a local web server on http://localhost:8000.

Learn more about writing and running Deno programs in the docs.

Additional resources

Contributing

We appreciate your help! To contribute, please read our contributing instructions.