Convert markdownlint library to an ECMAScript module, replace markdow…

…nlint-micromark with micromark, stop publishing (large) markdownlint-browser.js, see https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c for guidance.

.github/workflows/ci.yml

@@ -30,11 +30,3 @@ jobs:
       run: npm install --no-package-lock
     - name: Run CI Tests
       run: npm run ci
-    - name: Install markdownlint-micromark Dependencies
-      run: npm run install-micromark
-    - name: Build markdownlint-micromark
-      run: npm run build-micromark
-    - name: Install local markdownlint-micromark
-      run: npm install --no-package-lock ./micromark
-    - name: Test with local markdownlint-micromark
-      run: npm test

.gitignore

@@ -1,14 +1,7 @@
 coverage
 demo/markdown-it.min.js
+demo/markdownlint-browser.js
 demo/markdownlint-browser.min.js
-demo/micromark-browser.js
-demo/micromark-html-browser.js
-micromark/micromark.cjs
-micromark/micromark.dev.cjs
-micromark/micromark-browser.js
-micromark/micromark-browser.dev.js
-micromark/micromark-html-browser.js
-micromark/micromark-html-browser.dev.js
 node_modules
 !test/node_modules
 npm-debug.log

.npmignore

@@ -5,13 +5,11 @@
 .vscode
 coverage
 demo/*
-!demo/markdownlint-browser.js
 doc-build
 eslint.config.mjs
 example
-micromark
 npm-debug.log
-schema/*.js
+schema/*.mjs
 scripts
 test
 test-repos

README.md

@@ -798,20 +798,18 @@ function applyFixes(input, errors) { ... }
 Invoking `applyFixes` with the results of a call to lint can be done like so:
 
 ```javascript
-const { "sync": markdownlintSync, applyFixes } = require("markdownlint");
+import markdownlint from "markdownlint";
 
-function fixMarkdownlintViolations(content) {
-  const fixResults = markdownlintSync({ strings: { content } });
-  return applyFixes(content, fixResults.content);
-}
+const fixResults = markdownlint.sync({ "strings": { "content": original } });
+const fixed = markdownlint.applyFixes(original, fixResults.content);
 ```
 
 ## Usage
 
 Invoke `markdownlint` and use the `result` object's `toString` method:
 
 ```javascript
-const markdownlint = require("markdownlint");
+import markdownlint from "markdownlint";
 
 const options = {
   "files": [ "good.md", "bad.md" ],
@@ -897,10 +895,10 @@ Output:
 ```
 
 Integration with the [gulp](https://gulpjs.com/) build system is
-straightforward: [`gulpfile.js`](example/gulpfile.js).
+straightforward: [`gulpfile.cjs`](example/gulpfile.cjs).
 
 Integration with the [Grunt](https://gruntjs.com/) build system is similar:
-[`Gruntfile.js`](example/Gruntfile.js).
+[`Gruntfile.cjs`](example/Gruntfile.cjs).
 
 ## Browser
 
@@ -912,11 +910,9 @@ Generate normal and minified scripts with:
 npm run build-demo
 ```
 
-Then reference `markdownlint` and `micromark` scripts:
+Then reference the `markdownlint` script:
 
 ```html
-<script src="demo/micromark-browser.js"></script>
-<script src="demo/micromark-html-browser.js"></script>
 <script src="demo/markdownlint-browser.min.js"></script>
 ```
 
@@ -928,7 +924,7 @@ const options = {
     "content": "Some Markdown to lint."
   }
 };
-const results = window.markdownlint.sync(options).toString();
+const results = window.markdownlint.markdownlint.sync(options).toString();
 ```
 
 ## Examples

demo/browser-exports.mjs

@@ -0,0 +1,9 @@
+// @ts-check
+
+export { default as markdownlint } from "../lib/markdownlint.mjs";
+export { compile, parse, postprocess, preprocess } from "micromark";
+export { directive, directiveHtml } from "micromark-extension-directive";
+export { gfmAutolinkLiteral, gfmAutolinkLiteralHtml } from "micromark-extension-gfm-autolink-literal";
+export { gfmFootnote, gfmFootnoteHtml } from "micromark-extension-gfm-footnote";
+export { gfmTable, gfmTableHtml } from "micromark-extension-gfm-table";
+export { math, mathHtml } from "micromark-extension-math";

demo/default.htm

@@ -34,8 +34,6 @@
     </div>
   </div>
   <script src="markdown-it.min.js"></script>
-  <script src="micromark-browser.js"></script>
-  <script src="micromark-html-browser.js"></script>
   <script src="markdownlint-browser.min.js"></script>
   <script src="default.js"></script>
 </body>

demo/default.js

@@ -3,9 +3,8 @@
 (function main() {
   // Dependencies
   var markdownit = globalThis.markdownit;
-  var markdownlint = globalThis.markdownlint.library;
-  var micromark = globalThis.micromarkBrowser;
-  var micromarkHtml = globalThis.micromarkHtmlBrowser;
+  var markdownlint = globalThis.markdownlint.markdownlint;
+  var micromark = globalThis.markdownlint;
 
   // DOM elements
   var markdown = document.getElementById("markdown");
@@ -70,15 +69,15 @@
       const compileOptions = {
         "allowDangerousHtml": true,
         "htmlExtensions": [
-          micromarkHtml.directiveHtml({ "*": handleDirective }),
-          micromarkHtml.gfmAutolinkLiteralHtml(),
-          micromarkHtml.gfmFootnoteHtml(),
-          micromarkHtml.gfmTableHtml(),
-          micromarkHtml.mathHtml()
+          micromark.directiveHtml({ "*": handleDirective }),
+          micromark.gfmAutolinkLiteralHtml(),
+          micromark.gfmFootnoteHtml(),
+          micromark.gfmTableHtml(),
+          micromark.mathHtml()
         ]
       };
       try {
-        return micromarkHtml.compile(compileOptions)(events);
+        return micromark.compile(compileOptions)(events);
       } catch (error) {
         return `[Exception: "${error}"]`;
       }