Setup jsconfig.json to check TypeScript against js files.

dillonkearns · Sep 16, 2019 · 1bf3213 · 1bf3213
1 parent 8eacf1e
commit 1bf3213
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 21 deletions.
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/examples/docs/index.js b/examples/docs/index.js
@@ -1,9 +1,11 @@
 import "elm-oembed";
 import "./lib/code-editor.js";
 import "./style.css";
+// @ts-ignore
 const { Elm } = require("./src/Main.elm");
 // const pagesInit = require("elm-pages");
-const pagesInit = require("../../index.js");
+// @ts-ignore
+const pagesInit = require("../../index.js").default;
 
 pagesInit({
   mainElmModule: Elm.Main

diff --git a/index.js b/index.js
@@ -1,14 +1,19 @@
+// @ts-ignore
 const elmPagesVersion = require("./package.json").version;
 
-module.exports = function pagesInit({ mainElmModule }) {
+module.exports = function pagesInit(
+  /** @type { { mainElmModule: { init: any  } } } */ { mainElmModule }
+) {
   let prefetchedPages = [window.location.pathname];
 
   document.addEventListener("DOMContentLoaded", function() {
     let app = mainElmModule.init({
       flags: {}
     });
 
-    app.ports.toJsPort.subscribe(payload => {
+    app.ports.toJsPort.subscribe((
+      /** @type { HeadTag[] } headTags */ headTags
+    ) => {
       appendTag({
         name: "meta",
         attributes: [
@@ -21,6 +26,11 @@ module.exports = function pagesInit({ mainElmModule }) {
           appendTag(headTag);
         });
       } else {
+        console.log("headTags", headTags);
+
+        headTags.forEach(headTag => {
+          appendTag(headTag);
+        });
         setupLinkPrefetching();
       }
 
@@ -36,7 +46,10 @@ module.exports = function pagesInit({ mainElmModule }) {
     });
   }
 
-  function observeFirstRender(mutationList, firstRenderObserver) {
+  function observeFirstRender(
+    /** @type {MutationRecord[]} */ mutationList,
+    /** @type {MutationObserver} */ firstRenderObserver
+  ) {
     for (let mutation of mutationList) {
       if (mutation.type === "childList") {
         console.log(
@@ -53,7 +66,10 @@ module.exports = function pagesInit({ mainElmModule }) {
       subtree: false
     });
   }
-  function observeUrlChanges(mutationList, theObserver) {
+  function observeUrlChanges(
+    /** @type {MutationRecord[]} */ mutationList,
+    /** @type {MutationObserver} */ _theObserver
+  ) {
     for (let mutation of mutationList) {
       if (mutation.type === "attributes") {
         console.log(
@@ -65,14 +81,19 @@ module.exports = function pagesInit({ mainElmModule }) {
     }
   }
 
-  function setupLinkPrefetchingHelp(mutationList, theObserver) {
+  function setupLinkPrefetchingHelp(
+    /** @type {MutationObserver} */ _mutationList,
+    /** @type {MutationObserver} */ _theObserver
+  ) {
     const links = document.querySelectorAll("a");
-    window.links = links;
-    console.log("LINKS");
     links.forEach(link => {
-      console.log(link.pathname);
+      // console.log(link.pathname);
       link.addEventListener("mouseenter", function(event) {
-        if (event && event.target) {
+        if (
+          event &&
+          event.target &&
+          event.target instanceof HTMLAnchorElement
+        ) {
           prefetchIfNeeded(event.target);
         } else {
           console.log("Couldn't prefetch with event", event);
@@ -81,10 +102,10 @@ module.exports = function pagesInit({ mainElmModule }) {
     });
   }
 
-  function prefetchIfNeeded(target) {
+  function prefetchIfNeeded(/** @type {HTMLAnchorElement} */ target) {
     if (target.host === window.location.host) {
       if (prefetchedPages.includes(target.pathname)) {
-        console.log("Already preloaded", event.target.href);
+        console.log("Already preloaded", target.href);
       } else {
         prefetchedPages.push(target.pathname);
         console.log("Preloading...", target.pathname);
@@ -96,7 +117,8 @@ module.exports = function pagesInit({ mainElmModule }) {
     }
   }
 
-  function appendTag(tagDetails) {
+  /** @typedef {{ name: string; attributes: string[][]; }} HeadTag */
+  function appendTag(/** @type {HeadTag} */ tagDetails) {
     const meta = document.createElement(tagDetails.name);
     tagDetails.attributes.forEach(([name, value]) => {
       meta.setAttribute(name, value);

diff --git a/jsconfig.json b/jsconfig.json
@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "noImplicitAny": true,
+    "removeComments": true,
+    "strictNullChecks": true,
+    "sourceMap": false,
+    "resolveJsonModule": true,
+    "lib": ["es5", "es2015.promise", "dom", "es2015"],
+    "checkJs": true
+  }
+}