:bug: fix prettier support for mdx with config by edno · Pull Request #2255 · graphql-markdown/graphql-markdown

edno · 2025-06-25T16:48:40Z

Description

User mdx parser instead of markdown when calling prettier, and add support for local config file.

Checklist

My changes follow the contributing guidelines of this project.
I have performed a self-review of my code.
I have made corresponding changes to the documentation.
I have added tests that prove my fix is effective or that my changes work.
New and existing unit tests pass locally with my changes.

Copilot

Pull Request Overview

This PR fixes prettier support by updating the parser from "markdown" to "mdx" and adding support for reading a local prettier config file.

Updated tests in packages/utils/tests/unit/prettier.test.ts to use the "mdx" parser and verify a more informative error message.
Modified packages/utils/src/prettier.ts to resolve a local config file and merge options with the parser.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
packages/utils/tests/unit/prettier.test.ts	Updated test cases to reflect the change from "markdown" to "mdx" and check for an improved error message.
packages/utils/src/prettier.ts	Changed to resolve the local prettier config and updated error logging and parser usage to "mdx".

Copilot · 2025-06-25T16:53:00Z

packages/utils/src/prettier.ts

+    const message = `Prettier is not found or not configured. Please install it or disable the "pretty" option.`;
    if ("logger" in global && global.logger) {
-      (global.logger as LoggerType)._log("Prettier is not found");
+      (global.logger as LoggerType)._log(message);
    } else {
-      global.console.log("Prettier is not found");
+      global.console.log(message);


Consider extracting the error message to a shared constant to improve maintainability and ensure consistency between implementation and tests.

Copilot · 2025-06-25T16:53:00Z

packages/utils/tests/unit/prettier.test.ts

-      expect(consoleSpy).toHaveBeenCalledWith("Prettier is not found");
+      expect(consoleSpy).toHaveBeenCalledWith(
+        'Prettier is not found or not configured. Please install it or disable the "pretty" option.',
+      );


Ensure that error message expectations are updated if the error message is refactored; consider referencing the shared constant from the implementation in tests if feasible.