mirror of
https://github.com/denoland/deno.git
synced 2025-02-22 13:13:32 -05:00
f08ca6414b
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>
|
||
|---|---|---|
| .. | ||
| __snapshots__ | ||
| abort_controller_test.ts | ||
| blob_test.ts | ||
| body_test.ts | ||
| broadcast_channel_test.ts | ||
| build_test.ts | ||
| cache_api_test.ts | ||
| chmod_test.ts | ||
| chown_test.ts | ||
| command_test.ts | ||
| console_test.ts | ||
| copy_file_test.ts | ||
| cron_test.ts | ||
| custom_event_test.ts | ||
| dir_test.ts | ||
| dom_exception_test.ts | ||
| error_stack_test.ts | ||
| error_test.ts | ||
| esnext_test.ts | ||
| event_source_test.ts | ||
| event_target_test.ts | ||
| event_test.ts | ||
| fetch_test.ts | ||
| ffi_test.ts | ||
| file_test.ts | ||
| filereader_test.ts | ||
| files_test.ts | ||
| fs_events_test.ts | ||
| get_random_values_test.ts | ||
| globals_test.ts | ||
| headers_test.ts | ||
| http_test.ts | ||
| image_bitmap_test.ts | ||
| image_data_test.ts | ||
| internals_test.ts | ||
| intl_test.ts | ||
| jupyter_test.ts | ||
| kv_queue_test.ts | ||
| kv_queue_test_no_db_close.ts | ||
| kv_queue_undelivered_test.ts | ||
| kv_test.ts | ||
| link_test.ts | ||
| lint_plugin_test.ts | ||
| lint_selectors_test.ts | ||
| make_temp_test.ts | ||
| message_channel_test.ts | ||
| mkdir_test.ts | ||
| navigator_test.ts | ||
| net_test.ts | ||
| network_interfaces_test.ts | ||
| ops_test.ts | ||
| os_test.ts | ||
| path_from_url_test.ts | ||
| performance_test.ts | ||
| permissions_test.ts | ||
| process_test.ts | ||
| progressevent_test.ts | ||
| promise_hooks_test.ts | ||
| quic_test.ts | ||
| read_dir_test.ts | ||
| read_file_test.ts | ||
| read_link_test.ts | ||
| read_text_file_test.ts | ||
| README.md | ||
| real_path_test.ts | ||
| ref_unref_test.ts | ||
| remove_test.ts | ||
| rename_test.ts | ||
| request_test.ts | ||
| response_test.ts | ||
| serve_test.ts | ||
| signal_test.ts | ||
| stat_test.ts | ||
| stdio_test.ts | ||
| streams_test.ts | ||
| structured_clone_test.ts | ||
| symbol_test.ts | ||
| symlink_test.ts | ||
| test_util.ts | ||
| testing_test.ts | ||
| text_encoding_test.ts | ||
| timers_test.ts | ||
| tls_sni_test.ts | ||
| tls_test.ts | ||
| truncate_test.ts | ||
| tty_color_test.ts | ||
| tty_test.ts | ||
| umask_test.ts | ||
| url_search_params_test.ts | ||
| url_test.ts | ||
| urlpattern_test.ts | ||
| utime_test.ts | ||
| version_test.ts | ||
| wasm_test.ts | ||
| webcrypto_test.ts | ||
| webgpu_test.ts | ||
| websocket_test.ts | ||
| websocketstream_test.ts.disabled | ||
| webstorage_test.ts | ||
| worker_permissions_test.ts | ||
| worker_test.ts | ||
| write_file_test.ts | ||
| write_text_file_test.ts | ||
Deno runtime tests
Files in this directory are unit tests for Deno runtime.
Testing Deno runtime code requires checking API under different runtime
permissions. To accomplish this all tests exercised are created using
Deno.test() function.
import {} from "./test_util.ts";
Deno.test(function simpleTestFn(): void {
// test code here
});
Deno.test(
{
ignore: Deno.build.os === "windows",
permissions: { read: true, write: true },
},
function complexTestFn(): void {
// test code here
},
);
Running tests
There are two ways to run unit_test_runner.ts:
# Run all tests.
cargo run --bin deno -- test --allow-all --location=http://js-unit-tests/foo/bar cli/tests/unit/
# Run a specific test module
cargo run --bin deno -- test --allow-all --location=http://js-unit-tests/foo/bar cli/tests/unit/files_test.ts
Http server
target/debug/test_server is required to run when one's running unit tests.
During CI it's spawned automatically, but if you want to run tests manually make
sure that server is spawned otherwise there'll be cascade of test failures.