summaryrefslogtreecommitdiff
path: root/cli/tests
diff options
context:
space:
mode:
authorLiam Murphy <43807659+Liamolucko@users.noreply.github.com>2021-02-26 02:24:05 +1100
committerGitHub <noreply@github.com>2021-02-25 16:24:05 +0100
commitcdae4423c27443e0085d59f45eda1c978f186a1c (patch)
tree74107cebfe5a49a8021ef3fc02c60b30548163be /cli/tests
parent687ff2ab14d6a735aa5bf0ec57ef00cfe0c04e4b (diff)
feat(cli/doc): use type definitions "deno doc" if available (#8459)
This commit adds support for type definitions in "deno doc"; with this change "deno doc" is able to leverage the same directives as TS compiler. Co-authored-by: Bartek IwaƄczuk <biwanczuk@gmail.com>
Diffstat (limited to 'cli/tests')
-rw-r--r--cli/tests/doc/types_header.out6
-rw-r--r--cli/tests/doc/types_header.ts1
-rw-r--r--cli/tests/doc/types_hint.out5
-rw-r--r--cli/tests/doc/types_hint.ts2
-rw-r--r--cli/tests/doc/types_ref.js2
-rw-r--r--cli/tests/doc/types_ref.out5
-rw-r--r--cli/tests/integration_tests.rs54
7 files changed, 61 insertions, 14 deletions
diff --git a/cli/tests/doc/types_header.out b/cli/tests/doc/types_header.out
new file mode 100644
index 000000000..ccff1a373
--- /dev/null
+++ b/cli/tests/doc/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:0
+
+const foo: "foo"
+
diff --git a/cli/tests/doc/types_header.ts b/cli/tests/doc/types_header.ts
new file mode 100644
index 000000000..b64c8d000
--- /dev/null
+++ b/cli/tests/doc/types_header.ts
@@ -0,0 +1 @@
+export * from "http://127.0.0.1:4545/xTypeScriptTypes.js";
diff --git a/cli/tests/doc/types_hint.out b/cli/tests/doc/types_hint.out
new file mode 100644
index 000000000..7eb05faed
--- /dev/null
+++ b/cli/tests/doc/types_hint.out
@@ -0,0 +1,5 @@
+Defined in [WILDCARD]/type_definitions/foo.d.ts:2:0
+
+const foo: string
+ An exported value.
+
diff --git a/cli/tests/doc/types_hint.ts b/cli/tests/doc/types_hint.ts
new file mode 100644
index 000000000..bacea46db
--- /dev/null
+++ b/cli/tests/doc/types_hint.ts
@@ -0,0 +1,2 @@
+// @deno-types="../type_definitions/foo.d.ts"
+export * from "../type_definitions/foo.js";
diff --git a/cli/tests/doc/types_ref.js b/cli/tests/doc/types_ref.js
new file mode 100644
index 000000000..03d8b5570
--- /dev/null
+++ b/cli/tests/doc/types_ref.js
@@ -0,0 +1,2 @@
+/// <reference types="../type_definitions/foo.d.ts" />
+export const foo = "foo";
diff --git a/cli/tests/doc/types_ref.out b/cli/tests/doc/types_ref.out
new file mode 100644
index 000000000..7eb05faed
--- /dev/null
+++ b/cli/tests/doc/types_ref.out
@@ -0,0 +1,5 @@
+Defined in [WILDCARD]/type_definitions/foo.d.ts:2:0
+
+const foo: string
+ An exported value.
+
diff --git a/cli/tests/integration_tests.rs b/cli/tests/integration_tests.rs
index 497028cd1..8b8d6354b 100644
--- a/cli/tests/integration_tests.rs
+++ b/cli/tests/integration_tests.rs
@@ -3669,20 +3669,10 @@ console.log("finish");
exit_code: 0,
});
- itest!(deno_doc_builtin {
- args: "doc",
- output: "deno_doc_builtin.out",
- });
-
- itest!(deno_doc {
- args: "doc deno_doc.ts",
- output: "deno_doc.out",
- });
-
- 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_header_direct {
+ args: "doc --reload http://127.0.0.1:4545/xTypeScriptTypes.js",
+ output: "doc/types_header.out",
+ http_server: true,
});
itest!(import_data_url_error_stack {
@@ -3945,6 +3935,42 @@ console.log("finish");
assert_eq!(output.stderr, b"");
}
+ mod doc {
+ use super::*;
+
+ itest!(deno_doc_builtin {
+ args: "doc",
+ output: "deno_doc_builtin.out",
+ });
+
+ itest!(deno_doc {
+ args: "doc deno_doc.ts",
+ output: "deno_doc.out",
+ });
+
+ 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,
+ });
+ }
+
mod coverage {
use super::*;