prettier-plugin-markdown-list-tabwidth 1.1.0 → 1.2.0

package/Changelog.md

@@ -1,3 +1,9 @@
+# v1.2.0
+
+## Changes
+
+-   Removed the `/replace-parser` export and made it the default behavior, as MDX throws errors about frontmatter when the old printer is used with the newer parser.
+
 # v1.1.0
 
 ## Additions

package/README.md

@@ -16,11 +16,9 @@ Starting in v3.4.0, Prettier switched to a fixed single space between a list mar
 
 Prior to this change, Prettier ensured that the marker + following spaces always consumed exactly `tabWidth` characters, producing indentation that aligned consistently across nested lists, multiline items, and mixed marker widths.
 
-The way this plugin works is that it replaces the printer/formatter for Markdown with the one from Prettier v3.3.3.
+Any other issues you may have experienced due to the v3.4.0 update are also fixed by this plugin.
 
-Note: It does NOT replace the Markdown parser with that from Prettier v3.3.3, only the printer, the parser uses the one from your current version of Prettier except it sets the `astFormat` property to reference the v3.3.3 markdown printer.
-If you do want it to replace the parser, import it as `prettier-plugin-markdown-list-tabwidth/replace-parser` instead of `prettier-plugin-markdown-list-tabwidth`.
-If you want it to export the Markdown language and options from Prettier v3.3.3 as well, import it as `prettier-plugin-markdown-list-tabwidth/full-replace`.
+The way this plugin works is that it replaces the parser and printer/formatter for Markdown, MDX, and Remark with the ones from Prettier v3.3.3.
 
 This plugin supports Markdown, MDX, and Remark.
 
@@ -40,7 +38,7 @@ npm i prettier-plugin-markdown-list-tabwidth --save-dev
 
 ## Usage
 
-To use the plugin, just `prettier-plugin-markdown-list-tabwidth` to the plugins array of your prettier config.
+To use the plugin, just add `prettier-plugin-markdown-list-tabwidth` to the plugins array of your prettier config.
 
 ```json
 // .prettierrc
@@ -49,16 +47,7 @@ To use the plugin, just `prettier-plugin-markdown-list-tabwidth` to the plugins
 }
 ```
 
-If you are having issues with the plugin, try importing the `replace-parser` version, as it doesn't attempt to import your current prettier installation, and replaces the parser with the one from Prettier v3.3.3 that is guaranteed to be compatible with the printer used by the plugin.
-
-```json
-// .prettierrc
-{
-    "plugins": ["prettier-plugin-markdown-list-tabwidth/replace-parser"]
-}
-```
-
-If you are still having issues after trying `replace-parser`, then try `full-replace` which will export the Markdown language and options from Prettier v3.3.3 as well, which should fix your issue.
+If you are having issues with the plugin, try importing the `full-replace` version, which will export the Markdown language and options from Prettier v3.3.3 as well, which should fix your issue.
 
 ```json
 // .prettierrc

package/index.mjs

@@ -1,50 +1,24 @@
 import * as prettier333MarkdownPlugin from "./prettier-3.3.3-markdown-plugin.mjs";
-// import * as prettierCurrentMarkdownPlugin from "prettier/plugins/markdown.mjs";
-import { createRequire } from "module"; // Use `module` instead of `node:module` to support Node < 14.13.0.
-
-let prettierCurrentMarkdownPlugin;
-
-try {
-    // Resolve from project root
-    const requireFromProject = createRequire(process.cwd() + "/");
-    prettierCurrentMarkdownPlugin = requireFromProject("prettier/plugins/markdown.mjs");
-} catch {
-    // Fallback: resolve from plugin directory
-    const requireFromPlugin = createRequire(import.meta.url);
-    prettierCurrentMarkdownPlugin = requireFromPlugin("prettier/plugins/markdown.mjs");
-}
 
 export const parsers = {
     markdown: {
         // The prettier Markdown parser from the currently installed prettier version.
-        ...prettierCurrentMarkdownPlugin.parsers.markdown,
+        ...prettier333MarkdownPlugin.parsers.markdown,
         // Overrides the prettier Markdown parser's AST format.
         astFormat: "prettier-3.3.3-mdast",
     },
-    "markdown-original": {
-        // The prettier Markdown parser from the currently installed prettier version.
-        ...prettierCurrentMarkdownPlugin.parsers.markdown,
-    },
     mdx: {
         // The prettier MDX parser from the currently installed prettier version.
-        ...prettierCurrentMarkdownPlugin.parsers.mdx,
+        ...prettier333MarkdownPlugin.parsers.mdx,
         // Overrides the prettier MDX parser's AST format.
         astFormat: "prettier-3.3.3-mdast",
     },
-    "mdx-original": {
-        // The prettier MDX parser from the currently installed prettier version.
-        ...prettierCurrentMarkdownPlugin.parsers.mdx,
-    },
     remark: {
         // The prettier Remark parser from the currently installed prettier version.
-        ...prettierCurrentMarkdownPlugin.parsers.remark,
+        ...prettier333MarkdownPlugin.parsers.remark,
         // Overrides the prettier Remark parser's AST format.
         astFormat: "prettier-3.3.3-mdast",
     },
-    "remark-original": {
-        // The prettier Remark parser from the currently installed prettier version.
-        ...prettierCurrentMarkdownPlugin.parsers.remark,
-    },
 };
 export const printers = {
     // Adds the prettier v3.3.3 Markdown printer.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "prettier-plugin-markdown-list-tabwidth",
-    "version": "1.1.0",
+    "version": "1.2.0",
     "description": "A Prettier plugin that reverts the change in Prettier v3.4.0 that altered how Markdown list items are indented.",
     "keywords": [
         "prettier",
@@ -37,7 +37,6 @@
     "module": "./index.mjs",
     "exports": {
         ".": "./index.mjs",
-        "./replace-parser": "./index-replace-parser.mjs",
         "./full-replace": "./index-full-replace.mjs",
         "./packge.json": "./package.json",
         "./*": "./*.mjs",
@@ -48,7 +47,11 @@
         "prettier": "*"
     },
     "devDependencies": {
-        "prettier": "^3.7.4"
+        "@types/node": "14.0.0",
+        "eslint": "^9.39.2",
+        "eslint-plugin-import": "^2.32.0",
+        "prettier": "^3.7.4",
+        "typescript-eslint": "^8.52.0"
     },
     "engines": {
         "node": ">=14"

package/index-replace-parser.mjs

@@ -1,31 +0,0 @@
-import * as prettier333MarkdownPlugin from "./prettier-3.3.3-markdown-plugin.mjs";
-
-export const parsers = {
-    markdown: {
-        // Replaces the prettier Markdown parser with the one from Prettier v3.3.3.
-        ...prettier333MarkdownPlugin.parsers.markdown,
-        // Overrides the prettier Markdown parser's AST format.
-        astFormat: "prettier-3.3.3-mdast",
-    },
-    mdx: {
-        // Replaces the prettier MDX parser with the one from Prettier v3.3.3.
-        ...prettier333MarkdownPlugin.parsers.mdx,
-        // Overrides the prettier MDX parser's AST format.
-        astFormat: "prettier-3.3.3-mdast",
-    },
-    remark: {
-        // Replaces the prettier Remark parser with the one from Prettier v3.3.3.
-        ...prettier333MarkdownPlugin.parsers.remark,
-        // Overrides the prettier Remark parser's AST format.
-        astFormat: "prettier-3.3.3-mdast",
-    },
-};
-export const printers = {
-    // Adds the prettier v3.3.3 Markdown printer.
-    "prettier-3.3.3-mdast": prettier333MarkdownPlugin.printers.mdast,
-};
-
-export default {
-    parsers,
-    printers,
-};