mirror of
https://github.com/denoland/deno.git
synced 2024-11-22 15:06:54 -05:00
d1ef561dbf
Adds a new `--lint` flag to `deno doc` that surfaces three kinds of diagnostics: 1. Diagnostic for non-exported type referenced in an exported type. * Why? People often forget to export types from a module in TypeScript. To supress this diagnostic, add an `@internal` jsdoc tag to the internal type. 1. Diagnostic for missing return type or missing property type on a **public** type. * Why? Otherwise `deno doc` will not display good documentation. Adding explicit types also helps with type checking performance. 1. Diagnostic for missing jsdoc on a **public** type. * Why? Everything should be documented. This diagnostic can be supressed by adding a jsdoc comment description. If the lint passes, `deno doc` generates documentation as usual. For example, checking for deno doc diagnostics on the CI: ```shellsession $ deno doc --lint mod.ts second_entrypoint.ts > /dev/null ``` This feature is incredibly useful for library authors. ## Why not include this in `deno lint`? 1. The command needs the documenation output in order to figure out the diagnostics. 1. `deno lint` doesn't understand where the entrypoints are. That's critical for the diagnostics to be useful. 1. It's much more performant to do this while generating documentation. 1. There is precedence in rustdoc (ex. `#![warn(missing_docs)]`). ## Why not `--check`? It is confusing with `deno run --check`, since that means to run type checking (and confusing with `deno check --docs`). ## Output Future Improvement The output is not ideal atm, but it's fine for a first pass. We will improve it in the future. Closes https://github.com/denoland/deno_lint/pull/972 Closes https://github.com/denoland/deno_lint/issues/970 Closes https://github.com/denoland/deno/issues/19356
98 lines
2.5 KiB
Rust
98 lines
2.5 KiB
Rust
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
|
|
|
|
use test_util as util;
|
|
use util::assert_contains;
|
|
use util::TestContext;
|
|
|
|
itest!(deno_doc_builtin {
|
|
args: "doc",
|
|
output: "doc/deno_doc_builtin.out",
|
|
});
|
|
|
|
#[test]
|
|
fn deno_doc() {
|
|
let context = TestContext::default();
|
|
// try this twice to ensure it works with the cache
|
|
for _ in 0..2 {
|
|
let output = context
|
|
.new_command()
|
|
.env("NO_COLOR", "1")
|
|
.args("doc doc/deno_doc.ts doc/deno_doc2.ts")
|
|
.split_output()
|
|
.run();
|
|
|
|
output.assert_exit_code(0);
|
|
assert_contains!(output.stdout(), "function foo");
|
|
assert_contains!(output.stdout(), "function bar");
|
|
}
|
|
}
|
|
|
|
itest!(deno_doc_import_map {
|
|
args: "doc --unstable --import-map=doc/import_map.json doc/use_import_map.js",
|
|
output: "doc/use_import_map.out",
|
|
});
|
|
|
|
itest!(deno_doc_types_hint {
|
|
args: "doc doc/types_hint.ts",
|
|
output: "doc/types_hint.out",
|
|
});
|
|
|
|
itest!(deno_doc_types_ref {
|
|
args: "doc doc/types_ref.js",
|
|
output: "doc/types_ref.out",
|
|
});
|
|
|
|
itest!(deno_doc_types_header {
|
|
args: "doc --reload doc/types_header.ts",
|
|
output: "doc/types_header.out",
|
|
http_server: true,
|
|
});
|
|
|
|
itest!(deno_doc_referenced_private_types {
|
|
args: "doc doc/referenced_private_types.ts",
|
|
output: "doc/referenced_private_types.out",
|
|
});
|
|
|
|
itest!(deno_doc_lint_referenced_private_types_error {
|
|
args: "doc --lint doc/referenced_private_types.ts",
|
|
exit_code: 1,
|
|
output: "doc/referenced_private_types_lint.out",
|
|
});
|
|
|
|
itest!(deno_doc_lint_referenced_private_types_fixed {
|
|
args: "doc --lint doc/referenced_private_types_fixed.ts",
|
|
output: "doc/referenced_private_types_fixed.out",
|
|
});
|
|
|
|
itest!(_060_deno_doc_displays_all_overloads_in_details_view {
|
|
args:
|
|
"doc --filter NS.test doc/060_deno_doc_displays_all_overloads_in_details_view.ts",
|
|
output: "doc/060_deno_doc_displays_all_overloads_in_details_view.ts.out",
|
|
});
|
|
|
|
itest!(deno_doc_types_header_direct {
|
|
args: "doc --reload http://127.0.0.1:4545/xTypeScriptTypes.js",
|
|
output: "doc/types_header.out",
|
|
http_server: true,
|
|
});
|
|
|
|
itest!(deno_doc_invalid_url {
|
|
args: "doc https://raw.githubusercontent.com%2Fdyedgreen%2Fdeno-sqlite%2Frework_api%2Fmod.ts",
|
|
output: "doc/invalid_url.out",
|
|
exit_code: 1,
|
|
});
|
|
|
|
itest!(doc_lock {
|
|
args: "doc main.ts",
|
|
http_server: true,
|
|
cwd: Some("lockfile/basic"),
|
|
exit_code: 10,
|
|
output: "lockfile/basic/fail.out",
|
|
});
|
|
|
|
itest!(doc_no_lock {
|
|
args: "doc --no-lock main.ts",
|
|
http_server: true,
|
|
cwd: Some("lockfile/basic"),
|
|
output: "lockfile/basic/doc.nolock.out",
|
|
});
|