fix a bunch of type errors by adding type declarations, suppress ~600 errors with noImplicitAny disabled, which we'll fix later

Author: trusktr

docs/plugins.md

@@ -25,7 +25,7 @@ By default, the hyperlink on the current page is recognized and the content is s
       insertBefore: '.sidebar-nav', // CSS selector in .sidebar scope
 
       maxAge: 86400000, // Expiration time, the default one day
-      paths: [], // or 'auto'
+      paths: [], // string[] of files to search in, or 'auto' for discovery based on your sidebar
       placeholder: 'Type to search',
 
       // Localization

package-lock.json

@@ -51,7 +51,9 @@
     "@rollup/plugin-node-resolve": "^16.0.0",
     "@rollup/plugin-replace": "^6.0.1",
     "@rollup/plugin-terser": "^0.4.3",
+    "@types/common-tags": "^1.8.4",
     "@types/eslint": "^8.40.2",
+    "@types/prismjs": "^1.26.5",
     "axios": "^1.5.0",
     "browser-sync": "^3.0.2",
     "common-tags": "^1.8.0",
@@ -78,6 +80,7 @@
     "rimraf": "^6.1.0",
     "rollup": "^4.17.2",
     "rollup-plugin-import-css": "^4.0.1",
+    "typescript": "^5.9.3",
     "vue": "^3.4.27",
     "xhr-mock": "^2.5.1"
   },

package.json

@@ -1,10 +1,13 @@
-import prism from 'prismjs';
+import * as prism from 'prismjs';
 import { Router } from './router/index.js';
 import { Render } from './render/index.js';
 import { Fetch } from './fetch/index.js';
 import { Events } from './event/index.js';
 import { VirtualRoutes } from './virtual-routes/index.js';
 
+// CONTINUE Prism type
+console.log('##### Prism:', prism);
+
 import config from './config.js';
 import { isFn } from './util/core.js';
 import { Lifecycle } from './init/lifecycle.js';

src/core/Docsify.js

@@ -3,6 +3,8 @@ import { hyphenate, isPrimitive } from './util/core.js';
 
 const currentScript = document.currentScript;
 
+/** @typedef {any} TODO */
+
 /**
 @typedef {
   {
@@ -18,6 +20,7 @@ const currentScript = document.currentScript;
       externalLinkRel: 'noopener' | string
       externalLinkTarget: '_blank' | '_self' | '_parent' | '_top'  | '_unfencedTop'
       formatUpdated: string
+      frontMatter: Record<string, TODO>
       ga: string
       homepage: string
       keyBindings: false | {
@@ -129,10 +132,13 @@ export default function (vm, config = {}) {
       },
     },
 
-    typeof window.$docsify === 'function'
-      ? window.$docsify(vm)
-      : window.$docsify,
+    // Handle non-function configs no matter what (f.e. plugins assign options onto it)
+    window.$docsify,
+
+    // Also handle function config (the app can specificy a function, and plugins will assign options onto it)
+    typeof window.$docsify === 'function' ? window.$docsify(vm) : undefined,
 
+    // Finally, user config passed directly to the instance has priority.
     config,
   );
 
@@ -143,8 +149,10 @@ export default function (vm, config = {}) {
       {
         toggleSidebar: {
           bindings: ['\\'],
-          callback(e) {
-            const toggleElm = document.querySelector('.sidebar-toggle-button');
+          callback(/** @type {KeyboardEvent} */ e) {
+            const toggleElm = /** @type {HTMLElement} */ (
+              document.querySelector('.sidebar-toggle-button')
+            );
 
             if (toggleElm) {
               toggleElm.click();
@@ -164,7 +172,9 @@ export default function (vm, config = {}) {
     )[0];
 
   if (script) {
-    for (const prop of Object.keys(config)) {
+    for (const prop of /** @type {(keyof DocsifyConfig)[]} */ (
+      Object.keys(config)
+    )) {
       const val = script.getAttribute('data-' + hyphenate(prop));
 
       if (isPrimitive(val)) {
@@ -173,6 +183,8 @@ export default function (vm, config = {}) {
             'data-' + hyphenate(prop)
           }) are deprecated.`,
         );
+
+        // @ts-expect-error too dynamic for TS
         config[prop] = val === '' ? true : val;
       }
     }