Skip to content

ci: add prettier format check to lint workflow#594

Merged
stehessel merged 1 commit into
mainfrom
chore/prettier-formatting
Jun 30, 2026
Merged

ci: add prettier format check to lint workflow#594
stehessel merged 1 commit into
mainfrom
chore/prettier-formatting

Conversation

@stehessel

Copy link
Copy Markdown
Contributor

Description

Format with prettier and add formatting to lint workflow.

@stehessel stehessel requested a review from a team as a code owner June 23, 2026 11:06
@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: afa9491b-2173-4e97-9fc8-065c51780c20

📥 Commits

Reviewing files that changed from the base of the PR and between 5071116 and a336cf8.

📒 Files selected for processing (11)
  • .github/dependabot.yml
  • .github/pull_request_template.md
  • .github/workflows/e2e.yml
  • .github/workflows/lint.yml
  • .github/workflows/package.yml
  • README.md
  • action.yml
  • eslint.config.mjs
  • package.json
  • src/main.ts
  • tsconfig.json

📝 Walkthrough

Summary by CodeRabbit

  • New Features

    • Added a formatting check to the pull request workflow before linting.
    • Expanded project formatting to include YAML files alongside TypeScript.
  • Documentation

    • Improved README examples and code-block formatting for clearer setup instructions.
  • Chores

    • Updated several configuration files for consistent formatting and quoting.
    • Refined the pull request template placeholder text.

Walkthrough

Prettier formatting is applied across TypeScript, YAML, and config files, normalizing quote styles, semicolons, and indentation. The format and format-check npm scripts are extended to include **/*.yml alongside **/*.ts, and a new Format step running npm run format-check is added to the lint CI workflow before the existing Lint step.

Changes

Prettier Formatting and CI Enforcement

Layer / File(s) Summary
Format scripts extended to YAML and CI enforcement added
package.json, .github/workflows/lint.yml
format and format-check scripts now target **/*.ts and **/*.yml globs; lint workflow gains a Format step that runs npm run format-check before Lint.
Prettier reformatting across all project files
src/main.ts, eslint.config.mjs, tsconfig.json, action.yml, .github/dependabot.yml, .github/workflows/e2e.yml, .github/workflows/package.yml, .github/pull_request_template.md, README.md
All files reformatted: single quotes replacing double quotes, semicolons removed in TS/MJS files, indentation and whitespace normalized. No logic, values, or behavior changed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding a Prettier format check to the lint workflow.
Description check ✅ Passed The description follows the template and briefly explains the formatting and lint workflow changes.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/prettier-formatting

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@stehessel stehessel force-pushed the chore/prettier-formatting branch from cde876c to a336cf8 Compare June 30, 2026 12:47
@stehessel stehessel merged commit ca7cb69 into main Jun 30, 2026
4 checks passed
@stehessel stehessel deleted the chore/prettier-formatting branch June 30, 2026 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants