From cdae4423c27443e0085d59f45eda1c978f186a1c Mon Sep 17 00:00:00 2001 From: Liam Murphy <43807659+Liamolucko@users.noreply.github.com> Date: Fri, 26 Feb 2021 02:24:05 +1100 Subject: feat(cli/doc): use type definitions "deno doc" if available (#8459) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- cli/tests/doc/types_header.out | 6 ++++++ cli/tests/doc/types_header.ts | 1 + cli/tests/doc/types_hint.out | 5 +++++ cli/tests/doc/types_hint.ts | 2 ++ cli/tests/doc/types_ref.js | 2 ++ cli/tests/doc/types_ref.out | 5 +++++ 6 files changed, 21 insertions(+) create mode 100644 cli/tests/doc/types_header.out create mode 100644 cli/tests/doc/types_header.ts create mode 100644 cli/tests/doc/types_hint.out create mode 100644 cli/tests/doc/types_hint.ts create mode 100644 cli/tests/doc/types_ref.js create mode 100644 cli/tests/doc/types_ref.out (limited to 'cli/tests/doc') 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 @@ +/// +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. + -- cgit v1.2.3