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

ci: add overall prettier check to ci #1399

Merged
merged 1 commit into from
Mar 11, 2025

Conversation

MikeMcC399
Copy link
Collaborator

Situation

  • Previous PRs have made incremental changes to the scope of Prettier formatting and checks

  • Running npx prettier . --check now returns success

  • Scripts to run Prettier across the whole repo and in CI are missing

  • The use of Prettier is not documented

Change

  • Add script
    • format:all to fix all required formatting with Prettier
    • format:all:check to check all required formatting with Prettier
  • Add instructions to CONTRIBUTING
  • Add format:all:check to .github/workflows/main.yml

Verification

On Ubuntu 24.04.2 LTS, Node.js 22.14.0 LTS

npm ci
npm run format:all:check

and confirm the response is:

Checking formatting...
All matched files use Prettier code style!

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

@MikeMcC399

This comment was marked as outdated.

@MikeMcC399 MikeMcC399 marked this pull request as ready for review March 11, 2025 16:29
@jennifer-shehane jennifer-shehane merged commit 918d8a7 into cypress-io:master Mar 11, 2025
76 checks passed
@MikeMcC399 MikeMcC399 deleted the ci/prettier branch March 11, 2025 17:31
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants