Skip to content

Conversation

Subham-KRLX
Copy link

Description
This PR updates the Markdown syntax highlighter API for greater clarity and consistency:

✨ Introduced setMarkdownHighlighter() — a clearer, more intuitive method name.

⚠️ Deprecated the old addMarkdownHighlighter(), preserving existing behavior while logging a deprecation warning.

📚 Updated README.md to reflect the new API and include a note about the deprecation.

🧪 Added a new AVA test (user-config-deprecation.test.js) to verify both backward compatibility and warning output.

✅ All existing tests pass successfully. No example configuration updates are required.

✅ Closes [#3105]

@Subham-KRLX Subham-KRLX requested a review from zachleat as a code owner June 25, 2025 17:24
@Subham-KRLX
Copy link
Author

• setMarkdownHighlighter() replaces addMarkdownHighlighter() for clearer intent and naming consistency.
• The old API is still supported but marked deprecated (with a console warning) for now.
• README.md updated to reflect the change, and a new AVA test verifies the deprecation.

💬 Why this matters:
Aligns the API with the set*() design convention, prevents surprise removals, and ensures existing workflows continue smoothly.

@Ryuno-Ki
Copy link
Contributor

Can you resolve the merge conflicts, @Subham-KRLX ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants