Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: prettier format markdown documents #1375

Merged

Conversation

MikeMcC399
Copy link
Collaborator

Situation

  • Top-level Markdown documents in this repo are checked with the script check:markdown for hyperlink errors. There is however no check for consistent formatting implemented, leaving Markdown source formatting inconsistencies in the documents.

  • Prettier's support for Markdown is available and unused.

Change

To ensure consistent Markdown document source formatting as part of an overall effort to increase linting coverage in the repo:

  • Add a script format:markdown to fix all formatting of Markdown documents with Prettier

  • Add a script format:markdown:check to check all Markdown documents with Prettier for use in CI

  • Add .prettierignore with an exception for LICENSE.md since this file is essentially sourced externally and should not be automatically re-formatted.

  • Add instructions to CONTRIBUTING to format Markdown documents

  • Add format:markdown:check to the .github/workflows/check-markdown.yml workflow.

  • Correct all formatting of Markdown documents.

Verification

Local

  • Ubuntu 22.04.2 LTS
  • Windows 11 24H2

Node.js 22.14.0 LTS

Execute

npm ci
npm run format:markdown:check
npm run format:markdown

CI

Run .github/workflows/check-markdown.yml

@MikeMcC399 MikeMcC399 added documentation Improvements or additions to documentation ci labels Feb 27, 2025
@MikeMcC399 MikeMcC399 self-assigned this Feb 27, 2025
@cypress-app-bot
Copy link

@MikeMcC399 MikeMcC399 marked this pull request as ready for review February 27, 2025 13:29
@MikeMcC399 MikeMcC399 force-pushed the add/markdown-formatting branch from e5dbb9c to 6d2c193 Compare February 27, 2025 15:31
@MikeMcC399
Copy link
Collaborator Author

rebased and resolved conflicts in package.json

@jennifer-shehane jennifer-shehane merged commit ec3ec42 into cypress-io:master Feb 27, 2025
74 checks passed
@MikeMcC399 MikeMcC399 deleted the add/markdown-formatting branch February 27, 2025 16:13
Copy link

🎉 This PR is included in version 6.7.14 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci documentation Improvements or additions to documentation released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants