Markdown formatter destroys Yaml Front matter metadata

Open
#2,616 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
java, markdown, yaml
Domain
tooling

Research direction

No source file or test is named. Reproduce the issue with Markdown containing YAML front matter, then locate the Markdown formatter's handling of the trailing --- delimiter. Done means formatting preserves the front matter metadata and its closing delimiter instead of destroying or reformatting it.

Written by the indexing model from the issue text.

Description

bug

Often Markdown uses metadata in the format of YAML front matter. This is supported e.g. via https://github.com/vsch/flexmark-java/wiki/Extensions#yaml-front-matter. However the markdown formatter currently destroys/reformats the tailing triple-dashed-line ---.

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.