OAI / OpenAPI-Specification

The OpenAPI Specification Repository
https://openapis.org
Apache License 2.0
28.52k stars 9.05k forks source link

Add whitespace/formatting automation to the build process #3596

Open lornajane opened 4 months ago

lornajane commented 4 months ago

Over time the formatting on our key documents has become inconsistent in terms of spacing and quotes, etc.

Add a tool to our build process for pull requests and the main branch to that that the official spec documents conform to our standards (as established by our current conventions).

Bellangelo commented 1 month ago

I have run some tests here and I have succeeded to format most of the cases using Prettier for formatitng and Markdownlint for linting. One thing that Prettier cannot catch is the optional quotes in the YAML properties and strings. There is an open issue for this case but couldn't find any solution to this.