Fix markdownlint-github issues (#61)

Fixes issues with the markdownlint-github plugin that were causing
runtime errors.

Author: iansan5653

@types/markdownlint-github.d.ts

@@ -1,7 +1,6 @@
 declare module "@github/markdownlint-github" {
   import {Configuration, Rule} from "markdownlint";
-  const main: Rule[] & {
-    init(overrides: Configuration): Configuration;
-  };
-  export default main;
+  const rules: Rule[];
+  export default rules;
+  export function init(config: Configuration): Promise<Configuration>;
 }

package-lock.json

@@ -13,7 +13,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@github/markdownlint-github": "^0.7.0",
+    "@github/markdownlint-github": "^0.8.0",
     "@webcomponents/custom-elements": "^1.6.0",
     "dom-input-range": "^2.0.0",
     "markdownlint": "^0.37.4"

package.json

@@ -168,15 +168,15 @@ export abstract class LintedMarkdownEditor extends Component {
     this.#tooltipAnnotations = [];
   }
 
-  #lint() {
+  async #lint() {
     this.#clear();
 
     // clear() will not hide the tooltip if the mouse is over it, but if the user is typing then they are not trying to copy content
     this.#tooltip.hide(true);
 
     if (document.activeElement !== this.#editor) return;
 
-    const errors = lintMarkdown(this.value, this.markdownRenderTarget);
+    const errors = await lintMarkdown(this.value, this.markdownRenderTarget);
 
     this.#annotations = errors.map(
       (error) => new LintErrorAnnotation(error, this, this.#annotationsPortal)

src/components/linted-markdown-editor.ts

@@ -1,6 +1,8 @@
-import {lint} from "markdownlint/sync";
+import {lint} from "markdownlint/promise";
 import {LintError as MarkdownLintError} from "markdownlint";
-import markdownlintGitHub from "@github/markdownlint-github";
+import githubRules, {
+  init as initGitHubConfig,
+} from "@github/markdownlint-github";
 import startHeadingLevel from "../rules/start-heading-level.js";
 
 export interface LintError extends MarkdownLintError {
@@ -15,15 +17,15 @@ export type MarkdownRenderTarget = "github" | "document";
  * rendered? This affects which rules should be enabled as some only apply to
  * GitHub.com content.
  */
-export const lintMarkdown = (
+export const lintMarkdown = async (
   markdown: string,
   renderTarget: MarkdownRenderTarget
-): LintError[] =>
-  lint({
+): Promise<LintError[]> => {
+  const result = await lint({
     strings: {
       content: markdown,
     },
-    config: markdownlintGitHub.init({
+    config: await initGitHubConfig({
       default: false,
       "no-reversed-links": true,
       "no-empty-links": true,
@@ -39,13 +41,18 @@ export const lintMarkdown = (
       },
     }),
     handleRuleFailures: true,
-    customRules: [...markdownlintGitHub, startHeadingLevel],
-  }).content?.map((error) => ({
-    ...error,
-    justification: error.ruleNames
-      .map((name) => ruleJustifications[name])
-      .join(" "),
-  })) ?? [];
+    customRules: [...githubRules, startHeadingLevel],
+  });
+
+  return (
+    result.content?.map((error) => ({
+      ...error,
+      justification: error.ruleNames
+        .map((name) => ruleJustifications[name])
+        .join(" "),
+    })) ?? []
+  );
+};
 
 export const ruleJustifications: Partial<Record<string, string>> = {
   "heading-increment":