0
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2025-02-15 10:06:23 -05:00
denoland-deno/runtime
Bartek Iwańczuk f08ca6414b
feat(lint): add JavaScript plugin support (#27203)
This commit adds an unstable lint plugin API.

Plugins are specified in the `deno.json` file under
`lint.plugins` option like so:

```
{
  "lint": {
    "plugins": [
      "./plugins/my-plugin.ts",
      "jsr:@deno/lint-plugin1",
      "npm:@deno/lint-plugin2"
    ]
  }
}
```

The API is considered unstable and might be subject
to changes in the future.

Plugin API was modelled after ESLint API for the 
most part, but there are no guarantees for compatibility.
The AST format exposed to plugins is closely modelled
after the AST that `typescript-eslint` uses.

Lint plugins use the visitor pattern and can add
diagnostics like so:

```
export default {
  name: "lint-plugin",
  rules: {
    "plugin-rule": {
      create(context) {
        return {
          Identifier(node) {
            if (node.name === "a") {
              context.report({
                node,
                message: "should be b",
                fix(fixer) {
                  return fixer.replaceText(node, "_b");
                },
              });
            }
          },
        };
      },
    },
  },
} satisfies Deno.lint.Plugin;
```

Besides reporting errors (diagnostics) plugins can provide
automatic fixes that use text replacement to apply changes.

---------

Co-authored-by: Marvin Hagemeister <marvin@deno.com>
Co-authored-by: David Sherret <dsherret@gmail.com>
2025-02-05 16:59:24 +01:00
..
examples/extension refactor: create deno_lib crate (#27673) 2025-01-15 09:35:46 -05:00
js feat(lint): add JavaScript plugin support (#27203) 2025-02-05 16:59:24 +01:00
ops refactor: add 'deno_process' crate (#27680) 2025-01-17 13:30:14 +01:00
permissions chore: forward v2.1.9 release commit to main (#27888) 2025-01-31 03:02:00 +01:00
Cargo.toml chore: forward v2.1.9 release commit to main (#27888) 2025-01-31 03:02:00 +01:00
clippy.toml fix: otel resiliency (#26857) 2024-11-14 12:16:28 +00:00
code_cache.rs chore: Happy New Year 2025 (#27509) 2024-12-31 19:12:39 +00:00
fmt_errors.rs refactor(quic): introduce endpoint, 0rtt, cleanup (#27444) 2025-01-06 15:24:59 +01:00
fs_util.rs refactor: update deno_core and use more concrete errors (#27620) 2025-01-17 09:41:52 -08:00
inspector_server.rs refactor: update deno_core and use more concrete errors (#27620) 2025-01-17 09:41:52 -08:00
js.rs chore: Happy New Year 2025 (#27509) 2024-12-31 19:12:39 +00:00
lib.rs chore: fix hmr build (#27781) 2025-01-22 18:00:36 +00:00
permissions.rs chore: Happy New Year 2025 (#27509) 2024-12-31 19:12:39 +00:00
README.md fix (doc): Typo in runtime/README.md (#20020) 2023-12-13 17:24:32 +00:00
shared.rs perf(compile): remove swc from denort (#27721) 2025-01-19 14:23:07 -05:00
snapshot.rs feat(ext/cache): support lscache (#27628) 2025-01-28 18:51:06 +00:00
tokio_util.rs chore: Happy New Year 2025 (#27509) 2024-12-31 19:12:39 +00:00
transpile.rs chore: fix hmr build (#27781) 2025-01-22 18:00:36 +00:00
web_worker.rs feat(ext/cache): support lscache (#27628) 2025-01-28 18:51:06 +00:00
worker.rs feat(ext/cache): support lscache (#27628) 2025-01-28 18:51:06 +00:00
worker_bootstrap.rs chore: fix canary version (#27723) 2025-01-19 11:19:47 +01:00

deno_runtime crate

crates docs

This is a slim version of the Deno CLI which removes typescript integration and various tooling (like lint and doc). Basically only JavaScript execution with Deno's operating system bindings (ops).

Stability

This crate is built using battle-tested modules that were originally in the deno crate, however the API of this crate is subject to rapid and breaking changes.

MainWorker

The main API of this crate is MainWorker. MainWorker is a structure encapsulating deno_core::JsRuntime with a set of ops used to implement Deno namespace.

When creating a MainWorker implementors must call MainWorker::bootstrap to prepare JS runtime for use.

MainWorker is highly configurable and allows to customize many of the runtime's properties:

  • module loading implementation
  • error formatting
  • support for source maps
  • support for V8 inspector and Chrome Devtools debugger
  • HTTP client user agent, CA certificate
  • random number generator seed

Worker Web API

deno_runtime comes with support for Worker Web API. The Worker API is implemented using WebWorker structure.

When creating a new instance of MainWorker implementors must provide a callback function that is used when creating a new instance of Worker.

All WebWorker instances are descendents of MainWorker which is responsible for setting up communication with child worker. Each WebWorker spawns a new OS thread that is dedicated solely to that worker.