Add markdownlint formatter

Open
#2,680 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
38/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
markdown, node.js
Domain
tooling

Research direction

Start by locating the existing Flexmark formatter and the infrastructure used to call npm packages. Compare markdownlint's integration and configuration needs with the current formatter; done means Spotless can expose markdownlint as an alternative Markdown formatter.

Written by the indexing model from the issue text.

Description

enhancement

The currently available formatter for Markdown (Flexmark) is a bit intrusive for my taste, especially on tables. On the one hand, it might help to actually implement more of the configuration options. But from my feeling, markdownlint would be a nicer alternative. I already use it as a vscode-plugin, but integrating it into spotless would be even better. As there already is some infrastructure to call npm packages, it should be reasonable to implement.

Dominant language
Java
Stars
5.7k
Forks
560
Avg merge
1d 13h
Merged PRs (30d)
43

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from diffplug/spotless

All issues in diffplug/spotless

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.