fix: use .d.marko for await tag types

marko-js · Jul 18, 2023 · 7957fb5 · 7957fb5
1 parent 02cea4f
commit 7957fb5
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 14 deletions.
diff --git a/.changeset/clean-lemons-collect.md b/.changeset/clean-lemons-collect.md
@@ -0,0 +1,6 @@
+---
+"@marko/translator-default": patch
+"marko": patch
+---
+
+Switch to .d.marko file for <await> tag types to avoid issues when loaded in a pure typescript project. By default TypeScript doesn't play well with `node_modules` which are seen as `.js` files which is what the jsdoc version of a Marko file appears as. By switching to a `.d.marko` it is instead always seen as `.ts` which is always analyzed by typescript.
diff --git a/packages/marko/src/core-tags/core/await/index.d.marko b/packages/marko/src/core-tags/core/await/index.d.marko
@@ -0,0 +1,10 @@
+export interface Input<T> {
+  value: readonly [T];
+  then?: { renderBody: Marko.Body<[Awaited<T>]> };
+  catch?: { renderBody: Marko.Body<[unknown]> };
+  placeholder?: { renderBody: Marko.Body };
+  "client-reorder"?: boolean;
+  name?: string;
+  timeout?: number;
+  "show-after"?: string;
+}
diff --git a/packages/marko/src/core-tags/core/await/index.marko b/packages/marko/src/core-tags/core/await/index.marko
diff --git a/packages/translator-default/src/taglib/core/index.js b/packages/translator-default/src/taglib/core/index.js
@@ -284,7 +284,7 @@ export default {
   },
   "<await>": {
     renderer: "marko/src/core-tags/core/await/renderer.js",
-    types: "marko/src/core-tags/core/await/index.marko",
+    types: "marko/src/core-tags/core/await/index.d.marko",
     "code-generator": translateAwait,
     "@_provider": "expression",
     "@_name": "string",