Changed frontmatter filtering to support YAML, JSON, TOML, and arbitrary languages (!23331) · Merge Requests · GitLab.org / GitLab FOSS

Changed frontmatter filtering to support YAML, JSON, TOML, and arbitrary languages

What does this MR do?

Adds support for rendering other languages beyond YAML in Markdown front matter. Explicit support for TOML and JSON is added with common delimiter markers. Status of support can be demonstrated on GitLab.com here: https://gitlab.com/travismiller/gitlab-frontmatter

YAML Delimiter --- already supported
TOML Delimiter +++
JSON Delimiter ;;;
~~JSON Without Delimiter~~
Arbitrary language ---php, +++python, ;;;python

YAML

---
example:
  language: yaml
---

example:
  language: yaml

TOML

+++
[example]
language = 'toml'
+++

[example]
language = 'toml'

JSON

;;;
{
  "example": {
    "language": "json"
  }
}
;;;

{
  "example": {
    "language": "json"
  }
}

Arbitrary

Support other languages by adding a specifier to any of the existing delimiters.

---php
$example = array(
  'language' => "php",
)
---

$example = array(
  'language' => "php",
)

+++python
example = {
  language: "python",
}
+++

example = {
  language: "python",
}

Various front matter format influences

https://gohugo.io/content-management/front-matter/ (Supports YAML, TOML, and non-delimited JSON)
https://middlemanapp.com/basics/frontmatter/ (Supports YAML & delimited JSON)
No prior example for arbitrary language specifier found.

What are the relevant issue numbers?

#52007 (closed)

Does this MR meet the acceptance criteria?

Changelog entry added, if necessary
Documentation created/updated
Tests added for this feature/bug
Conforms to the code review guidelines
Conforms to the merge request performance guidelines
Conforms to the style guides
Conforms to the database guides
Link to e2e tests MR added if this MR has Requires e2e tests label. See the Test Planning Process.

Closes #52007 (closed)

## What does this MR do?

- YAML Delimiter `---` ***already supported***
- TOML Delimiter `+++`
- JSON Delimiter `;;;`
- ~~JSON Without Delimiter~~
- Arbitrary language `---php`, `+++python`, `;;;python`

### YAML
<pre>
---
example:
  language: yaml
---
</pre>

```yaml
example:
  language: yaml
```

### TOML
<pre>
+++
[example]
language = 'toml'
+++
</pre>

```toml
[example]
language = 'toml'
```

### JSON
<pre>
;;;
{
  "example": {
    "language": "json"
  }
}
;;;
</pre>

```json
{
  "example": {
    "language": "json"
  }
}
```

### Arbitrary

Support other languages by adding a specifier to any of the existing delimiters.

<pre>
---php
$example = array(
  'language' => "php",
)
---
</pre>

```php
$example = array(
  'language' => "php",
)
```

<pre>
+++python
example = {
  language: "python",
}
+++
</pre>

```python
example = {
  language: "python",
}
```

### Various front matter format influences

- https://gohugo.io/content-management/front-matter/ (Supports YAML, TOML, and non-delimited JSON)
- https://middlemanapp.com/basics/frontmatter/ (Supports YAML & delimited JSON)
- No prior example for arbitrary language specifier found.

## What are the relevant issue numbers?

#52007

## Does this MR meet the acceptance criteria?

- [ ] [Changelog entry](https://docs.gitlab.com/ee/development/changelog.html) added, if necessary
- [ ] [Documentation created/updated](https://docs.gitlab.com/ee/development/documentation/index.html#contributing-to-docs)
- [ ] [Tests added for this feature/bug](https://docs.gitlab.com/ee/development/testing_guide/index.html)
- [ ] Conforms to the [code review guidelines](https://docs.gitlab.com/ee/development/code_review.html)
- [ ] Conforms to the [merge request performance guidelines](https://docs.gitlab.com/ee/development/merge_request_performance_guidelines.html)
- [ ] Conforms to the [style guides](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/CONTRIBUTING.md#style-guides)
- [ ] Conforms to the [database guides](https://docs.gitlab.com/ee/development/README.html#database-guides)
- [ ] Link to e2e tests MR added if this MR has ~"Requires e2e tests" label. See the [Test Planning Process](https://about.gitlab.com/handbook/engineering/quality/test-engineering/).

Closes #52007

Edited Dec 03, 2018 by Travis Miller