Skip to content

fix: formatting (protographic)#2639

Merged
comatory merged 3 commits intomainfrom
ondrej/eng-9169-cosmoprotographic-fix-formatting-drift-enable-ci-check
Mar 12, 2026
Merged

fix: formatting (protographic)#2639
comatory merged 3 commits intomainfrom
ondrej/eng-9169-cosmoprotographic-fix-formatting-drift-enable-ci-check

Conversation

@comatory
Copy link
Copy Markdown
Contributor

@comatory comatory commented Mar 12, 2026

Summary by CodeRabbit

  • Documentation

    • Improved formatting and clarity across multiple developer guides, including Operations-to-Proto mapping rules and SDL specifications.
    • Enhanced code examples with better alignment and readability.
  • Chores

    • Updated CI/CD workflow to include dedicated lint and format steps.
    • Updated code formatting script to actively rewrite files instead of check-only mode.
    • Minor formatting adjustments to test files for consistency.

Checklist

Fixing formatting drift. Formatting was not enforced in CI and that's why it happened probably.

Now we run lint:fix which runs linter & formatter at the same time in the CI. Subsequent step
then checks whether there are any uncomitted changes, so in case the formatting does not
happen, it will fail in this step.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 12, 2026

Walkthrough

This PR updates the protographic CI workflow to include a dedicated lint/format step, adjusts the format script to rewrite files instead of checking only, and applies extensive formatting and documentation refinements across configuration, test, and documentation files.

Changes

Cohort / File(s) Summary
CI Workflow & Configuration
.github/workflows/protographic.yaml, protographic/package.json, protographic/vite.config.ts
Added "Lint & format" CI step running pnpm lint:fix and removed previous lint step; updated format script from prettier -w -c . to prettier -w . to enable file rewriting; added trailing newline.
Documentation & Guides
protographic/OPERATIONS_TO_PROTO.md, protographic/README.md, protographic/SDL_MAPPING_RULES.md, protographic/SDL_PROTO_RULES.md, protographic/plugin_development.md
Documentation formatting adjustments including table headers, spacing fixes, and alignment tweaks; added explicit mapping detail bullets; minor rewordings and whitespace cleanup; trailing commas added to code snippets for consistency.
Test Files Formatting
protographic/tests/abstract-selection-rewriter/01-basics.test.ts, protographic/tests/abstract-selection-rewriter/02-advanced.test.ts, protographic/tests/operations/proto-text-generator.test.ts, protographic/tests/operations/request-builder.test.ts
Reformatted import statements to multi-line vertical alignment; adjusted blank lines around function and describe blocks; corrected test block closure syntax; restored proper trailing newlines.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 2 | ❌ 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 (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'fix: formatting (protographic)' accurately summarizes the main changes, which are formatting corrections applied to the protographic package.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)

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 and usage tips.

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.29%. Comparing base (1d0085d) to head (64c6c85).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #2639       +/-   ##
===========================================
+ Coverage   39.90%   89.29%   +49.39%     
===========================================
  Files         969       21      -948     
  Lines      121820     4503   -117317     
  Branches     5469     1236     -4233     
===========================================
- Hits        48609     4021    -44588     
+ Misses      71517      482    -71035     
+ Partials     1694        0     -1694     

see 990 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@comatory comatory marked this pull request as ready for review March 12, 2026 08:14
@comatory comatory requested review from a team, Noroth, StarpTech, dkorittki and endigma as code owners March 12, 2026 08:14
@comatory comatory requested a review from Aenimus March 12, 2026 08:14
Comment thread protographic/package.json
@comatory comatory enabled auto-merge (squash) March 12, 2026 08:42
Copy link
Copy Markdown
Member

@Aenimus Aenimus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@comatory comatory merged commit c8b8408 into main Mar 12, 2026
10 checks passed
@comatory comatory deleted the ondrej/eng-9169-cosmoprotographic-fix-formatting-drift-enable-ci-check branch March 12, 2026 13:56
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.

4 participants