fix type errors

Author: trusktr

src/core/render/compiler.js

@@ -1,6 +1,7 @@
 import { marked } from 'marked';
+/** @import {TokensList, Marked} from 'marked' */
 import { isAbsolutePath, getPath, getParentPath } from '../router/util.js';
-import { isFn, cached, isPrimitive } from '../util/core.js';
+import { isFn, cached } from '../util/core.js';
 import { tree as treeTpl } from './tpl.js';
 import { genTree } from './gen-tree.js';
 import { slugify } from './slugify.js';
@@ -32,6 +33,7 @@ export class Compiler {
     this.contentBase = router.getBasePath();
 
     this.renderer = this._initRenderer();
+    /** @type {typeof marked & Marked} */
     let compile;
     const mdConf = config.markdown || {};
 
@@ -43,10 +45,14 @@ export class Compiler {
           renderer: Object.assign(this.renderer, mdConf.renderer),
         }),
       );
+      // @ts-expect-error FIXME temporary ugly Marked types
       compile = marked;
     }
 
+    /** @type {typeof marked & Marked} */
     this._marked = compile;
+
+    /** @param {string | TokensList} text */
     this.compile = text => {
       let isCached = true;
 
@@ -59,8 +65,8 @@ export class Compiler {
           return text;
         }
 
-        if (isPrimitive(text)) {
-          html = compile(text);
+        if (typeof text === 'string') {
+          html = /** @type {string} */ (compile(text));
         } else {
           html = compile.parser(text);
         }
@@ -113,7 +119,8 @@ export class Compiler {
       }
 
       let media;
-      if (config.type && (media = compileMedia[config.type])) {
+      const configType = /** @type {string | undefined} */ (config.type);
+      if (configType && (media = compileMedia[configType])) {
         embed = media.call(this, href, title);
         embed.type = config.type;
       } else {
@@ -273,8 +280,8 @@ export class Compiler {
 
   /**
    * Compile cover page
-   * @param {Text} text Text content
-   * @returns {String} Cover page
+   * @param {TokensList} text Text content
+   * @returns {string} Cover page
    */
   cover(text) {
     const cacheToc = this.toc.slice();

src/core/render/embed.js

@@ -1,5 +1,7 @@
 import { stripIndent } from 'common-tags';
 import { get } from '../util/ajax.js';
+/** @import { Compiler } from '../Docsify.js' */
+/** @import {TokensList} from 'marked' */
 
 const cached = {};
 
@@ -32,7 +34,7 @@ function extractFragmentContent(text, fragment, fullLine) {
   return stripIndent((match || [])[1] || '').trim();
 }
 
-function walkFetchEmbed({ embedTokens, compile, fetch }, cb) {
+function walkFetchEmbed({ embedTokens, compile }, cb) {
   let token;
   let step = 0;
   let count = 0;
@@ -132,7 +134,13 @@ function walkFetchEmbed({ embedTokens, compile, fetch }, cb) {
   }
 }
 
-export function prerenderEmbed({ compiler, raw = '', fetch }, done) {
+/**
+ * @param {Object} options
+ * @param {Compiler} options.compiler
+ * @param {string} [options.raw]
+ * @param {Function} done
+ */
+export function prerenderEmbed({ compiler, raw = '' }, done) {
   const hit = cached[raw];
   if (hit) {
     const copy = hit.slice();
@@ -193,7 +201,7 @@ export function prerenderEmbed({ compiler, raw = '', fetch }, done) {
   // are returned
   const moves = [];
   walkFetchEmbed(
-    { compile, embedTokens, fetch },
+    { compile, embedTokens },
     ({ embedToken, token, rowIndex, cellIndex, tokenRef }) => {
       if (token) {
         if (typeof rowIndex === 'number' && typeof cellIndex === 'number') {
@@ -212,9 +220,14 @@ export function prerenderEmbed({ compiler, raw = '', fetch }, done) {
 
           Object.assign(links, embedToken.links);
 
+          // FIXME This is an actual code error caught by TypeScript, but
+          // apparently we've not been effected by deleting the `.links` property
+          // yet.
+          // @ts-expect-error
           tokens = tokens
-            .slice(0, index)
+            .slice(0, index) // This deletes the original .links by returning a new array, so now we have Tokens[] instead of TokensList
             .concat(embedToken, tokens.slice(index + 1));
+
           moves.push({ start: index, length: embedToken.length - 1 });
         }
       } else {

src/core/render/index.js

@@ -433,7 +433,6 @@ export function Render(Base) {
             {
               compiler: /** @type {Compiler} */ (this.compiler),
               raw: result,
-              fetch: undefined,
             },
             tokens => {
               html = /** @type {Compiler} */ (this.compiler).compile(tokens);
@@ -445,8 +444,10 @@ export function Render(Base) {
     }
 
     _renderCover(text, coverOnly, next) {
-      const el = dom.getNode('.cover');
+      const el = /** @type {HTMLElement} */ (dom.getNode('.cover'));
       const rootElm = document.documentElement;
+      // TODO this is now unused. What did we break?
+      // eslint-disable-next-line no-unused-vars
       const coverBg = getComputedStyle(rootElm).getPropertyValue('--cover-bg');
 
       dom.getNode('main').classList[coverOnly ? 'add' : 'remove']('hidden');
@@ -470,7 +471,7 @@ export function Render(Base) {
           } else {
             let path = m[1];
 
-            dom.toggleClass(el, 'add', 'has-mask');
+            el.classList.add('has-mask');
             if (!isAbsolutePath(m[1])) {
               path = getPath(this.router.getBasePath(), m[1]);
             }
@@ -495,12 +496,16 @@ export function Render(Base) {
       if (this.coverIsHTML) {
         callback(text);
       } else {
+        const compiler = this.compiler;
+        if (!compiler) {
+          throw new Error('Compiler is not initialized');
+        }
         prerenderEmbed(
           {
-            compiler: this.compiler,
+            compiler,
             raw: text,
           },
-          tokens => callback(this.compiler.cover(tokens)),
+          tokens => callback(compiler.cover(tokens)),
         );
       }
     }

src/core/util/core.js

@@ -33,9 +33,10 @@ export function isPrimitive(value) {
 
 /**
  * Performs no operation.
- * @void
+ * @param  {...any} args Any arguments ignored.
+ * @returns {void}
  */
-export function noop() {}
+export function noop(...args) {}
 
 /**
  * Check if value is function