summaryrefslogtreecommitdiff
path: root/tests
diff options
context:
space:
mode:
authorMohammad Sulaiman <mohammad.sulaiman@exalt.ps>2024-09-05 11:09:09 +0300
committerGitHub <noreply@github.com>2024-09-05 08:09:09 +0000
commit49340b96f6b3603186e03f0102b99bc4a34a1b63 (patch)
tree24a1278efb472a52c58811a62ce9e38bcffc674b /tests
parentdfc5eec43c481b1eeaa0ad069aeba8b7559d4440 (diff)
chore: deprecate doc itests (#25452)
Diffstat (limited to 'tests')
-rw-r--r--tests/integration/doc_tests.rs145
-rw-r--r--tests/integration/mod.rs2
-rw-r--r--tests/specs/doc/_060_deno_doc_displays_all_overloads_in_details_view/060_deno_doc_displays_all_overloads_in_details_view.ts (renamed from tests/testdata/doc/060_deno_doc_displays_all_overloads_in_details_view.ts)0
-rw-r--r--tests/specs/doc/_060_deno_doc_displays_all_overloads_in_details_view/060_deno_doc_displays_all_overloads_in_details_view.ts.out (renamed from tests/testdata/doc/060_deno_doc_displays_all_overloads_in_details_view.ts.out)0
-rw-r--r--tests/specs/doc/_060_deno_doc_displays_all_overloads_in_details_view/__test__.jsonc4
-rw-r--r--tests/specs/doc/builtin/__test__.jsonc4
-rw-r--r--tests/specs/doc/builtin/deno_doc_builtin.out (renamed from tests/testdata/doc/deno_doc_builtin.out)0
-rw-r--r--tests/specs/doc/deno_doc/__test__.jsonc17
-rw-r--r--tests/specs/doc/deno_doc/bar.out5
-rw-r--r--tests/specs/doc/deno_doc/deno_doc.ts (renamed from tests/testdata/doc/deno_doc.ts)0
-rw-r--r--tests/specs/doc/deno_doc/deno_doc2.ts (renamed from tests/testdata/doc/deno_doc2.ts)0
-rw-r--r--tests/specs/doc/deno_doc/foo.out5
-rw-r--r--tests/specs/doc/html/__test__.jsonc12
-rw-r--r--tests/specs/doc/html/referenced_private_types_fixed.ts (renamed from tests/testdata/doc/referenced_private_types_fixed.ts)0
-rw-r--r--tests/specs/doc/html_lint_referenced_private_types_fixed/__test__.jsonc5
-rw-r--r--tests/specs/doc/html_lint_referenced_private_types_fixed/referenced_private_types.ts (renamed from tests/testdata/doc/referenced_private_types.ts)0
-rw-r--r--tests/specs/doc/html_lint_referenced_private_types_fixed/referenced_private_types_lint.out (renamed from tests/testdata/doc/referenced_private_types_lint.out)0
-rw-r--r--tests/specs/doc/import_map/__test__.jsonc4
-rw-r--r--tests/specs/doc/import_map/import_map.json (renamed from tests/testdata/doc/import_map.json)0
-rw-r--r--tests/specs/doc/import_map/module/fun.js (renamed from tests/testdata/doc/module/fun.js)0
-rw-r--r--tests/specs/doc/import_map/use_import_map.js (renamed from tests/testdata/doc/use_import_map.js)0
-rw-r--r--tests/specs/doc/import_map/use_import_map.out (renamed from tests/testdata/doc/use_import_map.out)2
-rw-r--r--tests/specs/doc/invalid_url/__test__.jsonc5
-rw-r--r--tests/specs/doc/invalid_url/invalid_url.out (renamed from tests/testdata/doc/invalid_url.out)0
-rw-r--r--tests/specs/doc/lint_html_success/__test__.jsonc5
-rw-r--r--tests/specs/doc/lint_html_success/lint_success.ts (renamed from tests/testdata/doc/lint_success.ts)0
-rw-r--r--tests/specs/doc/lint_html_success/lint_success_html.out (renamed from tests/testdata/doc/lint_success_html.out)0
-rw-r--r--tests/specs/doc/lint_json_success/__test__.jsonc4
-rw-r--r--tests/specs/doc/lint_json_success/lint_success.ts5
-rw-r--r--tests/specs/doc/lint_json_success/lint_success_json.out (renamed from tests/testdata/doc/lint_success_json.out)0
-rw-r--r--tests/specs/doc/lint_referenced_private_types_error/__test__.jsonc5
-rw-r--r--tests/specs/doc/lint_referenced_private_types_error/referenced_private_types.ts7
-rw-r--r--tests/specs/doc/lint_referenced_private_types_error/referenced_private_types_lint.out29
-rw-r--r--tests/specs/doc/lint_referenced_private_types_fixed/__test__.jsonc4
-rw-r--r--tests/specs/doc/lint_referenced_private_types_fixed/referenced_private_types_fixed.out (renamed from tests/testdata/doc/referenced_private_types_fixed.out)0
-rw-r--r--tests/specs/doc/lint_referenced_private_types_fixed/referenced_private_types_fixed.ts11
-rw-r--r--tests/specs/doc/lint_success/__test__.jsonc4
-rw-r--r--tests/specs/doc/lint_success/lint_success.out (renamed from tests/testdata/doc/lint_success.out)0
-rw-r--r--tests/specs/doc/lint_success/lint_success.ts5
-rw-r--r--tests/specs/doc/referenced_private_types/__test__.jsonc4
-rw-r--r--tests/specs/doc/referenced_private_types/referenced_private_types.out12
-rw-r--r--tests/specs/doc/referenced_private_types/referenced_private_types.ts7
-rw-r--r--tests/specs/doc/types_header/__test__.jsonc4
-rw-r--r--tests/specs/doc/types_header/types_header.out (renamed from tests/testdata/doc/types_header.out)0
-rw-r--r--tests/specs/doc/types_header/types_header.ts (renamed from tests/testdata/doc/types_header.ts)0
-rw-r--r--tests/specs/doc/types_header_direct/__test__.jsonc4
-rw-r--r--tests/specs/doc/types_header_direct/types_header.out6
-rw-r--r--tests/specs/doc/types_hint/__test__.jsonc4
-rw-r--r--tests/specs/doc/types_hint/foo.d.ts2
-rw-r--r--tests/specs/doc/types_hint/foo.js1
-rw-r--r--tests/specs/doc/types_hint/types_hint.out5
-rw-r--r--tests/specs/doc/types_hint/types_hint.ts2
-rw-r--r--tests/specs/doc/types_ref/__test__.jsonc4
-rw-r--r--tests/specs/doc/types_ref/foo.d.ts2
-rw-r--r--tests/specs/doc/types_ref/types_ref.js2
-rw-r--r--tests/specs/doc/types_ref/types_ref.out5
-rw-r--r--tests/testdata/doc/referenced_private_types.out12
-rw-r--r--tests/testdata/doc/types_hint.out5
-rw-r--r--tests/testdata/doc/types_hint.ts2
-rw-r--r--tests/testdata/doc/types_ref.js2
-rw-r--r--tests/testdata/doc/types_ref.out5
61 files changed, 205 insertions, 174 deletions
diff --git a/tests/integration/doc_tests.rs b/tests/integration/doc_tests.rs
deleted file mode 100644
index 2abb01960..000000000
--- a/tests/integration/doc_tests.rs
+++ /dev/null
@@ -1,145 +0,0 @@
-// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
-
-use test_util as util;
-use test_util::itest;
-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 --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,
-});
-
-#[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 14 files to");
- assert!(temp_dir.path().join("all_symbols.html").exists());
- assert!(temp_dir.path().join("index.html").exists());
- assert!(temp_dir.path().join("fuse.js").exists());
- assert!(temp_dir.path().join("page.css").exists());
- assert!(temp_dir.path().join("reset.css").exists());
- assert!(temp_dir.path().join("script.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("~/MyInterface.prop.html").exists());
- assert!(temp_dir.path().join("~/MyClass.html").exists());
- assert!(temp_dir.path().join("~/MyClass.prototype.html").exists());
- assert!(temp_dir
- .path()
- .join("~/MyClass.prototype.prop.html")
- .exists());
-}
diff --git a/tests/integration/mod.rs b/tests/integration/mod.rs
index d12abcde6..1b8e79469 100644
--- a/tests/integration/mod.rs
+++ b/tests/integration/mod.rs
@@ -17,8 +17,6 @@ mod check;
mod compile;
#[path = "coverage_tests.rs"]
mod coverage;
-#[path = "doc_tests.rs"]
-mod doc;
#[path = "eval_tests.rs"]
mod eval;
#[path = "flags_tests.rs"]
diff --git a/tests/testdata/doc/060_deno_doc_displays_all_overloads_in_details_view.ts b/tests/specs/doc/_060_deno_doc_displays_all_overloads_in_details_view/060_deno_doc_displays_all_overloads_in_details_view.ts
index 854c1b464..854c1b464 100644
--- a/tests/testdata/doc/060_deno_doc_displays_all_overloads_in_details_view.ts
+++ b/tests/specs/doc/_060_deno_doc_displays_all_overloads_in_details_view/060_deno_doc_displays_all_overloads_in_details_view.ts
diff --git a/tests/testdata/doc/060_deno_doc_displays_all_overloads_in_details_view.ts.out b/tests/specs/doc/_060_deno_doc_displays_all_overloads_in_details_view/060_deno_doc_displays_all_overloads_in_details_view.ts.out
index 28d1cb921..28d1cb921 100644
--- a/tests/testdata/doc/060_deno_doc_displays_all_overloads_in_details_view.ts.out
+++ b/tests/specs/doc/_060_deno_doc_displays_all_overloads_in_details_view/060_deno_doc_displays_all_overloads_in_details_view.ts.out
diff --git a/tests/specs/doc/_060_deno_doc_displays_all_overloads_in_details_view/__test__.jsonc b/tests/specs/doc/_060_deno_doc_displays_all_overloads_in_details_view/__test__.jsonc
new file mode 100644
index 000000000..3060bed1b
--- /dev/null
+++ b/tests/specs/doc/_060_deno_doc_displays_all_overloads_in_details_view/__test__.jsonc
@@ -0,0 +1,4 @@
+{
+ "args": "doc --filter NS.test 060_deno_doc_displays_all_overloads_in_details_view.ts",
+ "output": "060_deno_doc_displays_all_overloads_in_details_view.ts.out"
+}
diff --git a/tests/specs/doc/builtin/__test__.jsonc b/tests/specs/doc/builtin/__test__.jsonc
new file mode 100644
index 000000000..e277c8733
--- /dev/null
+++ b/tests/specs/doc/builtin/__test__.jsonc
@@ -0,0 +1,4 @@
+{
+ "args": "doc",
+ "output": "deno_doc_builtin.out"
+}
diff --git a/tests/testdata/doc/deno_doc_builtin.out b/tests/specs/doc/builtin/deno_doc_builtin.out
index b4a90d6bc..b4a90d6bc 100644
--- a/tests/testdata/doc/deno_doc_builtin.out
+++ b/tests/specs/doc/builtin/deno_doc_builtin.out
diff --git a/tests/specs/doc/deno_doc/__test__.jsonc b/tests/specs/doc/deno_doc/__test__.jsonc
new file mode 100644
index 000000000..251565ecb
--- /dev/null
+++ b/tests/specs/doc/deno_doc/__test__.jsonc
@@ -0,0 +1,17 @@
+{
+ "steps": [{
+ "args": "doc deno_doc.ts",
+ "output": "foo.out",
+ "exitCode": 0,
+ "envs": {
+ "NO_COLOR": "1"
+ }
+ }, {
+ "args": "doc deno_doc2.ts",
+ "output": "bar.out",
+ "exitCode": 0,
+ "envs": {
+ "NO_COLOR": "1"
+ }
+ }]
+}
diff --git a/tests/specs/doc/deno_doc/bar.out b/tests/specs/doc/deno_doc/bar.out
new file mode 100644
index 000000000..1d681f446
--- /dev/null
+++ b/tests/specs/doc/deno_doc/bar.out
@@ -0,0 +1,5 @@
+Defined in [WILDCARD]/deno_doc2.ts:2:1
+
+function bar(): void
+ Some JSDoc
+
diff --git a/tests/testdata/doc/deno_doc.ts b/tests/specs/doc/deno_doc/deno_doc.ts
index fb3c50957..fb3c50957 100644
--- a/tests/testdata/doc/deno_doc.ts
+++ b/tests/specs/doc/deno_doc/deno_doc.ts
diff --git a/tests/testdata/doc/deno_doc2.ts b/tests/specs/doc/deno_doc/deno_doc2.ts
index ee6fc22dc..ee6fc22dc 100644
--- a/tests/testdata/doc/deno_doc2.ts
+++ b/tests/specs/doc/deno_doc/deno_doc2.ts
diff --git a/tests/specs/doc/deno_doc/foo.out b/tests/specs/doc/deno_doc/foo.out
new file mode 100644
index 000000000..9b5284582
--- /dev/null
+++ b/tests/specs/doc/deno_doc/foo.out
@@ -0,0 +1,5 @@
+Defined in [WILDCARD]/deno_doc.ts:2:1
+
+function foo(): void
+ Some JSDoc
+
diff --git a/tests/specs/doc/html/__test__.jsonc b/tests/specs/doc/html/__test__.jsonc
new file mode 100644
index 000000000..5114127cd
--- /dev/null
+++ b/tests/specs/doc/html/__test__.jsonc
@@ -0,0 +1,12 @@
+{
+ "tempDir": true,
+ "args": [
+ "doc",
+ "--html",
+ "--name=MyLib",
+ "--output=temp_dir_path_here",
+ "referenced_private_types_fixed.ts"
+ ],
+ "output": "[WILDCARD]",
+ "exitCode": 0
+}
diff --git a/tests/testdata/doc/referenced_private_types_fixed.ts b/tests/specs/doc/html/referenced_private_types_fixed.ts
index cd99bc76e..cd99bc76e 100644
--- a/tests/testdata/doc/referenced_private_types_fixed.ts
+++ b/tests/specs/doc/html/referenced_private_types_fixed.ts
diff --git a/tests/specs/doc/html_lint_referenced_private_types_fixed/__test__.jsonc b/tests/specs/doc/html_lint_referenced_private_types_fixed/__test__.jsonc
new file mode 100644
index 000000000..8bac77469
--- /dev/null
+++ b/tests/specs/doc/html_lint_referenced_private_types_fixed/__test__.jsonc
@@ -0,0 +1,5 @@
+{
+ "args": "doc --lint --html --name=Library referenced_private_types.ts",
+ "output": "referenced_private_types_lint.out",
+ "exitCode": 1
+}
diff --git a/tests/testdata/doc/referenced_private_types.ts b/tests/specs/doc/html_lint_referenced_private_types_fixed/referenced_private_types.ts
index 9570d4625..9570d4625 100644
--- a/tests/testdata/doc/referenced_private_types.ts
+++ b/tests/specs/doc/html_lint_referenced_private_types_fixed/referenced_private_types.ts
diff --git a/tests/testdata/doc/referenced_private_types_lint.out b/tests/specs/doc/html_lint_referenced_private_types_fixed/referenced_private_types_lint.out
index 1de3247bf..1de3247bf 100644
--- a/tests/testdata/doc/referenced_private_types_lint.out
+++ b/tests/specs/doc/html_lint_referenced_private_types_fixed/referenced_private_types_lint.out
diff --git a/tests/specs/doc/import_map/__test__.jsonc b/tests/specs/doc/import_map/__test__.jsonc
new file mode 100644
index 000000000..55554beff
--- /dev/null
+++ b/tests/specs/doc/import_map/__test__.jsonc
@@ -0,0 +1,4 @@
+{
+ "args": "doc --import-map=import_map.json use_import_map.js",
+ "output": "use_import_map.out"
+}
diff --git a/tests/testdata/doc/import_map.json b/tests/specs/doc/import_map/import_map.json
index 244a30296..244a30296 100644
--- a/tests/testdata/doc/import_map.json
+++ b/tests/specs/doc/import_map/import_map.json
diff --git a/tests/testdata/doc/module/fun.js b/tests/specs/doc/import_map/module/fun.js
index 28901d945..28901d945 100644
--- a/tests/testdata/doc/module/fun.js
+++ b/tests/specs/doc/import_map/module/fun.js
diff --git a/tests/testdata/doc/use_import_map.js b/tests/specs/doc/import_map/use_import_map.js
index 672a7a7bd..672a7a7bd 100644
--- a/tests/testdata/doc/use_import_map.js
+++ b/tests/specs/doc/import_map/use_import_map.js
diff --git a/tests/testdata/doc/use_import_map.out b/tests/specs/doc/import_map/use_import_map.out
index 9509d5bfe..5b455c0d6 100644
--- a/tests/testdata/doc/use_import_map.out
+++ b/tests/specs/doc/import_map/use_import_map.out
@@ -1,4 +1,4 @@
-Defined in [WILDCARD]/doc/module/fun.js:2:1
+Defined in [WILDCARD]/module/fun.js:2:1
function fun(_a, _b): void
This is some documentation
diff --git a/tests/specs/doc/invalid_url/__test__.jsonc b/tests/specs/doc/invalid_url/__test__.jsonc
new file mode 100644
index 000000000..58266267f
--- /dev/null
+++ b/tests/specs/doc/invalid_url/__test__.jsonc
@@ -0,0 +1,5 @@
+{
+ "args": "doc https://raw.githubusercontent.com%2Fdyedgreen%2Fdeno-sqlite%2Frework_api%2Fmod.ts",
+ "output": "invalid_url.out",
+ "exitCode": 1
+}
diff --git a/tests/testdata/doc/invalid_url.out b/tests/specs/doc/invalid_url/invalid_url.out
index 038c53177..038c53177 100644
--- a/tests/testdata/doc/invalid_url.out
+++ b/tests/specs/doc/invalid_url/invalid_url.out
diff --git a/tests/specs/doc/lint_html_success/__test__.jsonc b/tests/specs/doc/lint_html_success/__test__.jsonc
new file mode 100644
index 000000000..64153f1b2
--- /dev/null
+++ b/tests/specs/doc/lint_html_success/__test__.jsonc
@@ -0,0 +1,5 @@
+{
+ "tempDir": true,
+ "args": "doc --lint --html --name=Library lint_success.ts",
+ "output": "lint_success_html.out"
+}
diff --git a/tests/testdata/doc/lint_success.ts b/tests/specs/doc/lint_html_success/lint_success.ts
index 42c44b2d7..42c44b2d7 100644
--- a/tests/testdata/doc/lint_success.ts
+++ b/tests/specs/doc/lint_html_success/lint_success.ts
diff --git a/tests/testdata/doc/lint_success_html.out b/tests/specs/doc/lint_html_success/lint_success_html.out
index 783dd5927..783dd5927 100644
--- a/tests/testdata/doc/lint_success_html.out
+++ b/tests/specs/doc/lint_html_success/lint_success_html.out
diff --git a/tests/specs/doc/lint_json_success/__test__.jsonc b/tests/specs/doc/lint_json_success/__test__.jsonc
new file mode 100644
index 000000000..e4c71af78
--- /dev/null
+++ b/tests/specs/doc/lint_json_success/__test__.jsonc
@@ -0,0 +1,4 @@
+{
+ "args": "doc --lint --json lint_success.ts",
+ "output": "lint_success_json.out"
+}
diff --git a/tests/specs/doc/lint_json_success/lint_success.ts b/tests/specs/doc/lint_json_success/lint_success.ts
new file mode 100644
index 000000000..42c44b2d7
--- /dev/null
+++ b/tests/specs/doc/lint_json_success/lint_success.ts
@@ -0,0 +1,5 @@
+/** My test class. */
+export class Test {
+ /** My property. */
+ prop: string;
+}
diff --git a/tests/testdata/doc/lint_success_json.out b/tests/specs/doc/lint_json_success/lint_success_json.out
index 19f04c6a8..19f04c6a8 100644
--- a/tests/testdata/doc/lint_success_json.out
+++ b/tests/specs/doc/lint_json_success/lint_success_json.out
diff --git a/tests/specs/doc/lint_referenced_private_types_error/__test__.jsonc b/tests/specs/doc/lint_referenced_private_types_error/__test__.jsonc
new file mode 100644
index 000000000..7564883a8
--- /dev/null
+++ b/tests/specs/doc/lint_referenced_private_types_error/__test__.jsonc
@@ -0,0 +1,5 @@
+{
+ "args": "doc --lint referenced_private_types.ts",
+ "exitCode": 1,
+ "output": "referenced_private_types_lint.out"
+}
diff --git a/tests/specs/doc/lint_referenced_private_types_error/referenced_private_types.ts b/tests/specs/doc/lint_referenced_private_types_error/referenced_private_types.ts
new file mode 100644
index 000000000..9570d4625
--- /dev/null
+++ b/tests/specs/doc/lint_referenced_private_types_error/referenced_private_types.ts
@@ -0,0 +1,7 @@
+interface MyInterface {
+ prop?: string;
+}
+
+export class MyClass {
+ prop: MyInterface = {};
+}
diff --git a/tests/specs/doc/lint_referenced_private_types_error/referenced_private_types_lint.out b/tests/specs/doc/lint_referenced_private_types_error/referenced_private_types_lint.out
new file mode 100644
index 000000000..1de3247bf
--- /dev/null
+++ b/tests/specs/doc/lint_referenced_private_types_error/referenced_private_types_lint.out
@@ -0,0 +1,29 @@
+error[missing-jsdoc]: exported symbol is missing JSDoc documentation
+ --> [WILDCARD]:5:1
+ |
+5 | export class MyClass {
+ | ^
+
+
+error[private-type-ref]: public type 'MyClass.prototype.prop' references private type 'MyInterface'
+ --> [WILDCARD]:6:3
+ |
+6 | prop: MyInterface = {};
+ | ^
+ = hint: make the referenced type public or remove the reference
+ |
+1 | interface MyInterface {
+ | - this is the referenced type
+ |
+
+ info: to ensure documentation is complete all types that are exposed in the public API must be public
+
+
+error[missing-jsdoc]: exported symbol is missing JSDoc documentation
+ --> [WILDCARD]:6:3
+ |
+6 | prop: MyInterface = {};
+ | ^
+
+
+error: Found 3 documentation lint errors.
diff --git a/tests/specs/doc/lint_referenced_private_types_fixed/__test__.jsonc b/tests/specs/doc/lint_referenced_private_types_fixed/__test__.jsonc
new file mode 100644
index 000000000..01c579f72
--- /dev/null
+++ b/tests/specs/doc/lint_referenced_private_types_fixed/__test__.jsonc
@@ -0,0 +1,4 @@
+{
+ "args": "doc --lint referenced_private_types_fixed.ts",
+ "output": "referenced_private_types_fixed.out"
+}
diff --git a/tests/testdata/doc/referenced_private_types_fixed.out b/tests/specs/doc/lint_referenced_private_types_fixed/referenced_private_types_fixed.out
index c05ac45a1..c05ac45a1 100644
--- a/tests/testdata/doc/referenced_private_types_fixed.out
+++ b/tests/specs/doc/lint_referenced_private_types_fixed/referenced_private_types_fixed.out
diff --git a/tests/specs/doc/lint_referenced_private_types_fixed/referenced_private_types_fixed.ts b/tests/specs/doc/lint_referenced_private_types_fixed/referenced_private_types_fixed.ts
new file mode 100644
index 000000000..cd99bc76e
--- /dev/null
+++ b/tests/specs/doc/lint_referenced_private_types_fixed/referenced_private_types_fixed.ts
@@ -0,0 +1,11 @@
+/** Doc comment */
+export interface MyInterface {
+ /** Doc comment */
+ prop?: string;
+}
+
+/** Doc comment */
+export class MyClass {
+ /** Doc comment */
+ prop: MyInterface = {};
+}
diff --git a/tests/specs/doc/lint_success/__test__.jsonc b/tests/specs/doc/lint_success/__test__.jsonc
new file mode 100644
index 000000000..dc8c6a0e8
--- /dev/null
+++ b/tests/specs/doc/lint_success/__test__.jsonc
@@ -0,0 +1,4 @@
+{
+ "args": "doc --lint lint_success.ts",
+ "output": "lint_success.out"
+}
diff --git a/tests/testdata/doc/lint_success.out b/tests/specs/doc/lint_success/lint_success.out
index c05ac45a1..c05ac45a1 100644
--- a/tests/testdata/doc/lint_success.out
+++ b/tests/specs/doc/lint_success/lint_success.out
diff --git a/tests/specs/doc/lint_success/lint_success.ts b/tests/specs/doc/lint_success/lint_success.ts
new file mode 100644
index 000000000..42c44b2d7
--- /dev/null
+++ b/tests/specs/doc/lint_success/lint_success.ts
@@ -0,0 +1,5 @@
+/** My test class. */
+export class Test {
+ /** My property. */
+ prop: string;
+}
diff --git a/tests/specs/doc/referenced_private_types/__test__.jsonc b/tests/specs/doc/referenced_private_types/__test__.jsonc
new file mode 100644
index 000000000..183ff65f9
--- /dev/null
+++ b/tests/specs/doc/referenced_private_types/__test__.jsonc
@@ -0,0 +1,4 @@
+{
+ "args": "doc referenced_private_types.ts",
+ "output": "referenced_private_types.out"
+}
diff --git a/tests/specs/doc/referenced_private_types/referenced_private_types.out b/tests/specs/doc/referenced_private_types/referenced_private_types.out
new file mode 100644
index 000000000..0aa9973b7
--- /dev/null
+++ b/tests/specs/doc/referenced_private_types/referenced_private_types.out
@@ -0,0 +1,12 @@
+Defined in file:///[WILDCARD]/referenced_private_types.ts:5:1
+
+class MyClass
+
+ prop: MyInterface
+
+Defined in file:///[WILDCARD]/referenced_private_types.ts:1:1
+
+private interface MyInterface
+
+ prop?: string
+
diff --git a/tests/specs/doc/referenced_private_types/referenced_private_types.ts b/tests/specs/doc/referenced_private_types/referenced_private_types.ts
new file mode 100644
index 000000000..9570d4625
--- /dev/null
+++ b/tests/specs/doc/referenced_private_types/referenced_private_types.ts
@@ -0,0 +1,7 @@
+interface MyInterface {
+ prop?: string;
+}
+
+export class MyClass {
+ prop: MyInterface = {};
+}
diff --git a/tests/specs/doc/types_header/__test__.jsonc b/tests/specs/doc/types_header/__test__.jsonc
new file mode 100644
index 000000000..586fca28b
--- /dev/null
+++ b/tests/specs/doc/types_header/__test__.jsonc
@@ -0,0 +1,4 @@
+{
+ "args": "doc --reload types_header.ts",
+ "output": "types_header.out"
+}
diff --git a/tests/testdata/doc/types_header.out b/tests/specs/doc/types_header/types_header.out
index a97b35dd7..a97b35dd7 100644
--- a/tests/testdata/doc/types_header.out
+++ b/tests/specs/doc/types_header/types_header.out
diff --git a/tests/testdata/doc/types_header.ts b/tests/specs/doc/types_header/types_header.ts
index b64c8d000..b64c8d000 100644
--- a/tests/testdata/doc/types_header.ts
+++ b/tests/specs/doc/types_header/types_header.ts
diff --git a/tests/specs/doc/types_header_direct/__test__.jsonc b/tests/specs/doc/types_header_direct/__test__.jsonc
new file mode 100644
index 000000000..1dc5b8069
--- /dev/null
+++ b/tests/specs/doc/types_header_direct/__test__.jsonc
@@ -0,0 +1,4 @@
+{
+ "args": "doc --reload http://127.0.0.1:4545/xTypeScriptTypes.js",
+ "output": "types_header.out"
+}
diff --git a/tests/specs/doc/types_header_direct/types_header.out b/tests/specs/doc/types_header_direct/types_header.out
new file mode 100644
index 000000000..a97b35dd7
--- /dev/null
+++ b/tests/specs/doc/types_header_direct/types_header.out
@@ -0,0 +1,6 @@
+Download http://127.0.0.1:4545/xTypeScriptTypes.js
+Download http://127.0.0.1:4545/xTypeScriptTypes.d.ts
+Defined in http://127.0.0.1:4545/xTypeScriptTypes.d.ts:1:14
+
+const foo: "foo"
+
diff --git a/tests/specs/doc/types_hint/__test__.jsonc b/tests/specs/doc/types_hint/__test__.jsonc
new file mode 100644
index 000000000..f320a0f08
--- /dev/null
+++ b/tests/specs/doc/types_hint/__test__.jsonc
@@ -0,0 +1,4 @@
+{
+ "args": "doc types_hint.ts",
+ "output": "types_hint.out"
+}
diff --git a/tests/specs/doc/types_hint/foo.d.ts b/tests/specs/doc/types_hint/foo.d.ts
new file mode 100644
index 000000000..ce39201e1
--- /dev/null
+++ b/tests/specs/doc/types_hint/foo.d.ts
@@ -0,0 +1,2 @@
+/** An exported value. */
+export const foo: string;
diff --git a/tests/specs/doc/types_hint/foo.js b/tests/specs/doc/types_hint/foo.js
new file mode 100644
index 000000000..61d366eb2
--- /dev/null
+++ b/tests/specs/doc/types_hint/foo.js
@@ -0,0 +1 @@
+export const foo = "foo";
diff --git a/tests/specs/doc/types_hint/types_hint.out b/tests/specs/doc/types_hint/types_hint.out
new file mode 100644
index 000000000..a098511f4
--- /dev/null
+++ b/tests/specs/doc/types_hint/types_hint.out
@@ -0,0 +1,5 @@
+Defined in [WILDCARD]/foo.d.ts:2:14
+
+const foo: string
+ An exported value.
+
diff --git a/tests/specs/doc/types_hint/types_hint.ts b/tests/specs/doc/types_hint/types_hint.ts
new file mode 100644
index 000000000..70263bec6
--- /dev/null
+++ b/tests/specs/doc/types_hint/types_hint.ts
@@ -0,0 +1,2 @@
+// @deno-types="./foo.d.ts"
+export * from "./foo.js";
diff --git a/tests/specs/doc/types_ref/__test__.jsonc b/tests/specs/doc/types_ref/__test__.jsonc
new file mode 100644
index 000000000..bfdbf1438
--- /dev/null
+++ b/tests/specs/doc/types_ref/__test__.jsonc
@@ -0,0 +1,4 @@
+{
+ "args": "doc types_ref.js",
+ "output": "types_ref.out"
+}
diff --git a/tests/specs/doc/types_ref/foo.d.ts b/tests/specs/doc/types_ref/foo.d.ts
new file mode 100644
index 000000000..ce39201e1
--- /dev/null
+++ b/tests/specs/doc/types_ref/foo.d.ts
@@ -0,0 +1,2 @@
+/** An exported value. */
+export const foo: string;
diff --git a/tests/specs/doc/types_ref/types_ref.js b/tests/specs/doc/types_ref/types_ref.js
new file mode 100644
index 000000000..b3518e2e7
--- /dev/null
+++ b/tests/specs/doc/types_ref/types_ref.js
@@ -0,0 +1,2 @@
+/// <reference types="./foo.d.ts" />
+export const foo = "foo";
diff --git a/tests/specs/doc/types_ref/types_ref.out b/tests/specs/doc/types_ref/types_ref.out
new file mode 100644
index 000000000..a098511f4
--- /dev/null
+++ b/tests/specs/doc/types_ref/types_ref.out
@@ -0,0 +1,5 @@
+Defined in [WILDCARD]/foo.d.ts:2:14
+
+const foo: string
+ An exported value.
+
diff --git a/tests/testdata/doc/referenced_private_types.out b/tests/testdata/doc/referenced_private_types.out
deleted file mode 100644
index 3c91dbe15..000000000
--- a/tests/testdata/doc/referenced_private_types.out
+++ /dev/null
@@ -1,12 +0,0 @@
-Defined in file:///[WILDCARD]/doc/referenced_private_types.ts:5:1
-
-class MyClass
-
- prop: MyInterface
-
-Defined in file:///[WILDCARD]/doc/referenced_private_types.ts:1:1
-
-private interface MyInterface
-
- prop?: string
-
diff --git a/tests/testdata/doc/types_hint.out b/tests/testdata/doc/types_hint.out
deleted file mode 100644
index bfd5191a1..000000000
--- a/tests/testdata/doc/types_hint.out
+++ /dev/null
@@ -1,5 +0,0 @@
-Defined in [WILDCARD]/type_definitions/foo.d.ts:2:14
-
-const foo: string
- An exported value.
-
diff --git a/tests/testdata/doc/types_hint.ts b/tests/testdata/doc/types_hint.ts
deleted file mode 100644
index bacea46db..000000000
--- a/tests/testdata/doc/types_hint.ts
+++ /dev/null
@@ -1,2 +0,0 @@
-// @deno-types="../type_definitions/foo.d.ts"
-export * from "../type_definitions/foo.js";
diff --git a/tests/testdata/doc/types_ref.js b/tests/testdata/doc/types_ref.js
deleted file mode 100644
index 03d8b5570..000000000
--- a/tests/testdata/doc/types_ref.js
+++ /dev/null
@@ -1,2 +0,0 @@
-/// <reference types="../type_definitions/foo.d.ts" />
-export const foo = "foo";
diff --git a/tests/testdata/doc/types_ref.out b/tests/testdata/doc/types_ref.out
deleted file mode 100644
index bfd5191a1..000000000
--- a/tests/testdata/doc/types_ref.out
+++ /dev/null
@@ -1,5 +0,0 @@
-Defined in [WILDCARD]/type_definitions/foo.d.ts:2:14
-
-const foo: string
- An exported value.
-