mirror of
https://github.com/denoland/deno.git
synced 2024-12-23 15:49:44 -05:00
8acf059ac6
As pointed out in https://github.com/denoland/deno/issues/21067 , it's confusing that `deno doc --lint mod.ts` outputs the documentation to stdout on success. Instead, it would be better if it outputted how many files were checked similar to what `deno lint` does on success. It still outputs the documentation if `--lint` or `--html` are provided so this is non-breaking.
150 lines
4 KiB
Rust
150 lines
4 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!(deno_doc_html_lint_referenced_private_types_fixed {
|
|
args: "doc --lint --html --name=Library doc/referenced_private_types.ts",
|
|
exit_code: 1,
|
|
output: "doc/referenced_private_types_lint.out",
|
|
});
|
|
|
|
itest!(deno_doc_lint_success {
|
|
args: "doc --lint doc/lint_success.ts",
|
|
output: "doc/lint_success.out",
|
|
});
|
|
|
|
itest!(deno_doc_lint_json_success {
|
|
args: "doc --lint --json doc/lint_success.ts",
|
|
output: "doc/lint_success_json.out",
|
|
});
|
|
|
|
itest!(deno_doc_lint_html_success {
|
|
args: "doc --lint --html --name=Library lint_success.ts",
|
|
copy_temp_dir: Some("doc"),
|
|
cwd: Some("doc"),
|
|
output: "doc/lint_success_html.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",
|
|
});
|
|
|
|
#[test]
|
|
fn deno_doc_html() {
|
|
let context = TestContext::default();
|
|
let temp_dir = context.temp_dir();
|
|
let output = context
|
|
.new_command()
|
|
.env("NO_COLOR", "1")
|
|
.args_vec(vec![
|
|
"doc",
|
|
"--html",
|
|
"--name=MyLib",
|
|
&format!("--output={}", temp_dir.path().to_string_lossy()),
|
|
"doc/referenced_private_types_fixed.ts",
|
|
])
|
|
.split_output()
|
|
.run();
|
|
|
|
output.assert_exit_code(0);
|
|
assert_contains!(output.stderr(), "Written 8 files to");
|
|
assert!(temp_dir.path().join("index.html").exists());
|
|
assert!(temp_dir.path().join("compound_index.html").exists());
|
|
assert!(temp_dir.path().join("fuse.js").exists());
|
|
assert!(temp_dir.path().join("search.js").exists());
|
|
assert!(temp_dir.path().join("search_index.js").exists());
|
|
assert!(temp_dir.path().join("styles.css").exists());
|
|
assert!(temp_dir.path().join("MyInterface.html").exists());
|
|
assert!(temp_dir.path().join("MyClass.html").exists());
|
|
}
|