Skip to content

chore: Formatting fixes - #490

Merged
ilyabo merged 3 commits into
mainfrom
format
Mar 22, 2026
Merged

ilyabo merged 3 commits into
mainfrom
format

Conversation

@ilyabo

@ilyabo ilyabo commented Mar 22, 2026 •

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation

    • Improved formatting and examples across docs for clarity and fixed Markdown issues.
  • Chores

    • Updated formatting and linting workflow (editor/format tooling) and added global ignore rules.
    • Consolidated or removed many per-package changelog files to streamline release notes.

ilyabo added 2 commits March 22, 2026 16:07
Signed-off-by: Ilya Boyandin <[email protected]>
@coderabbitai

coderabbitai Bot commented Mar 22, 2026 •

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: dd18bd67-1b47-433a-af53-0b202d3fcfdd

📥 Commits

Reviewing files that changed from the base of the PR and between 91051b1 and f0697a9.

📒 Files selected for processing (2)
  • .prettierignore
  • python/sqlrooms-rag/docs/METADATA.md
✅ Files skipped from review due to trivial changes (1)
  • .prettierignore
🚧 Files skipped from review as they are similar to previous changes (1)
  • python/sqlrooms-rag/docs/METADATA.md

📝 Walkthrough

Walkthrough

Remove many package/example changelogs, add/adjust formatting and lint tooling, reorder Tailwind utility class strings across UI examples/components, and perform widespread documentation and minor Python/JS formatting changes (no API or behavioral changes).

Changes

Cohort / File(s) Summary
Config & Tooling
/.gitignore, /.prettierignore, /.lintstagedrc.json, /package.json
Ignore .venv/ and certain CHANGELOG.md paths; add Prettier ignore file; update lint-staged to run Prettier on **/*.md and Ruff format on Python; split format script into format:ts and format:python.
Bulk Changelog Removals
packages/*/CHANGELOG.md, examples/*/CHANGELOG.md
Deleted changelog contents across 40+ package and example changelog files.
Docs & READMEs
AGENTS.md, contributing/..., docs/..., packages/*/README.md, python/.../docs/*
Markdown/table alignment, code snippet reformatting, blank-line normalization, and minor content fixes (no semantic changes).
Tailwind Class Reordering — Examples
examples/.../src/.../*.tsx
Reordered Tailwind utility class strings in multiple example components (positioning/order only).
Tailwind Class Reordering — Packages
packages/.../src/.../*.tsx, packages/.../README.md
Reordered utility classes and minor class-string formatting in UI components and README snippets (no behavior changes).
Python Formatting & Tests
python/sqlrooms-cli/..., python/sqlrooms-server/..., python/.../tests/*, python/sqlrooms-rag/pyproject.toml
Whitespace/line-break formatting, small parameter/type layout changes, removed black from a dev dependency, and minor test whitespace edits.
Minor Code Formatting (TS/Tests)
packages/.../src/..., packages/.../__tests__/*
Non-functional formatting changes in tests and components (multi-line wrapping, imports, type formatting).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested reviewers

  • mihajlo-stojkovic
  • dmitriy-kostianetskiy
  • bdjulbic

Poem

🐰 Hopped the repo, tidy and spry,

Tailwind bits I ordered awry.
Changelogs cleared, docs groomed with care,
Ruff and Prettier hum through the air.
A neat little burrow — clean, light, and fair.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 16.13% 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
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'chore: Formatting fixes' is directly related to the changeset, which consists almost entirely of formatting and code style adjustments across the repository.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch format

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
packages/layout/README.md (1)

90-92: Consider consistent formatting for both buttons.

The second button is now formatted across multiple lines, while the first button on line 89 remains on a single line. For consistency in this documentation example, both buttons should follow the same formatting pattern.

📝 Suggested formatting for consistency

Either format both on single lines:

     <div className="flex gap-2">
       <Button onClick={() => togglePanel('data')}>Toggle Data Panel</Button>
-      <Button onClick={() => togglePanelPin('data')}>
-        Pin/Unpin Data Panel
-      </Button>
+      <Button onClick={() => togglePanelPin('data')}>Pin/Unpin Data Panel</Button>
     </div>

Or format both across multiple lines:

     <div className="flex gap-2">
-      <Button onClick={() => togglePanel('data')}>Toggle Data Panel</Button>
+      <Button onClick={() => togglePanel('data')}>
+        Toggle Data Panel
+      </Button>
       <Button onClick={() => togglePanelPin('data')}>
         Pin/Unpin Data Panel
       </Button>
     </div>
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@packages/layout/README.md` around lines 90 - 92, The two example Button
usages are formatted inconsistently; update the Button that calls
togglePanelPin('data') and the other Button so they follow the same style
(either both single-line or both multi-line) in the README example; locate the
Button elements referencing togglePanelPin and the button label "Pin/Unpin Data
Panel" and make their JSX formatting consistent across both occurrences.
.prettierignore (1)

2-2: Consider narrowing hidden-directory ignore scope.

.*\/ is very broad and will skip formatting for all root dot-directories (including .github/). If that’s not intentional, list only specific directories you want ignored.

✂️ Suggested change
 docs/api/
-.*/
+.turbo/
+.next/
+.cache/
 CHANGELOG.md
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.prettierignore at line 2, The ignore pattern ".*\/" in .prettierignore is
too broad and skips all root dot-directories; replace it with an explicit list
of the dot-directories you actually want ignored (e.g., ".git/", ".github/",
".venv/", ".cache/") or remove the pattern entirely if you only intended
specific entries, ensuring the pattern ".*\/" is updated to the exact directory
names to avoid unintentionally skipping formatting.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@python/sqlrooms-rag/docs/METADATA.md`:
- Around line 205-210: The fenced code block in METADATA.md lacks a language tag
(triggering markdownlint MD040); update the block that begins with triple
backticks containing "Created database with: text-embedding-3-small..." to
include a language identifier (e.g., add "text" after the opening ```), so
change ``` to ```text to satisfy the linter.

---

Nitpick comments:
In @.prettierignore:
- Line 2: The ignore pattern ".*\/" in .prettierignore is too broad and skips
all root dot-directories; replace it with an explicit list of the
dot-directories you actually want ignored (e.g., ".git/", ".github/", ".venv/",
".cache/") or remove the pattern entirely if you only intended specific entries,
ensuring the pattern ".*\/" is updated to the exact directory names to avoid
unintentionally skipping formatting.

In `@packages/layout/README.md`:
- Around line 90-92: The two example Button usages are formatted inconsistently;
update the Button that calls togglePanelPin('data') and the other Button so they
follow the same style (either both single-line or both multi-line) in the README
example; locate the Button elements referencing togglePanelPin and the button
label "Pin/Unpin Data Panel" and make their JSX formatting consistent across
both occurrences.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: aa69373e-f2f4-402a-85f5-e66ca7d8d1bd

📥 Commits

Reviewing files that changed from the base of the PR and between daefc89 and 91051b1.

⛔ Files ignored due to path filters (1)
  • python/uv.lock is excluded by !**/*.lock
📒 Files selected for processing (115)
  • .gitignore
  • .lintstagedrc.json
  • .prettierignore
  • AGENTS.md
  • contributing/architecture.md
  • contributing/patterns.md
  • contributing/python.md
  • docs/commands.md
  • docs/deployment-scenarios.md
  • docs/upgrade-guide.md
  • docs/whats-new.md
  • examples/ai-agent/CHANGELOG.md
  • examples/ai-core/CHANGELOG.md
  • examples/ai-rag/CHANGELOG.md
  • examples/ai/CHANGELOG.md
  • examples/app-builder/CHANGELOG.md
  • examples/canvas-sync/src/InputApiKey.tsx
  • examples/cosmos-embedding/src/components/publications-map/components/Legend.tsx
  • examples/deckgl-discuss/src/components/DiscussionPanel.tsx
  • examples/deckgl-mosaic/src/components/map/MapControls.tsx
  • examples/deckgl-mosaic/src/components/map/MapView.tsx
  • examples/deckgl/src/components/MainView.tsx
  • examples/get-started/src/components/MainView.tsx
  • examples/kepler/CHANGELOG.md
  • examples/kepler/src/components/KeplerMapsContainer.tsx
  • examples/mosaic/CHANGELOG.md
  • examples/mosaic/src/components/MainView.tsx
  • examples/query-pwa/src/MainView.tsx
  • examples/query-websocket/src/MainView.tsx
  • examples/query/src/MainView.tsx
  • examples/sync/README.md
  • package.json
  • packages/ai-config/CHANGELOG.md
  • packages/ai-core/CHANGELOG.md
  • packages/ai-core/README.md
  • packages/ai-rag/CHANGELOG.md
  • packages/ai-settings/CHANGELOG.md
  • packages/ai-settings/README.md
  • packages/ai-settings/src/components/AiSettingsPanel.tsx
  • packages/ai/CHANGELOG.md
  • packages/ai/README.md
  • packages/canvas/CHANGELOG.md
  • packages/cells/CHANGELOG.md
  • packages/codemirror/CHANGELOG.md
  • packages/cosmos/CHANGELOG.md
  • packages/cosmos/README.md
  • packages/cosmos/src/CosmosGraphControls.tsx
  • packages/crdt/CHANGELOG.md
  • packages/crdt/README.md
  • packages/data-table/CHANGELOG.md
  • packages/db/CHANGELOG.md
  • packages/discuss/CHANGELOG.md
  • packages/discuss/README.md
  • packages/discuss/src/components/CommentItem.tsx
  • packages/dropzone/CHANGELOG.md
  • packages/duckdb-core/CHANGELOG.md
  • packages/duckdb-node/CHANGELOG.md
  • packages/duckdb/CHANGELOG.md
  • packages/duckdb/__tests__/DuckDbSlice.test.ts
  • packages/kepler-config/CHANGELOG.md
  • packages/kepler/CHANGELOG.md
  • packages/layout-config/CHANGELOG.md
  • packages/layout/CHANGELOG.md
  • packages/layout/README.md
  • packages/monaco-editor/CHANGELOG.md
  • packages/monaco-editor/README.md
  • packages/mosaic/CHANGELOG.md
  • packages/motherduck/CHANGELOG.md
  • packages/notebook/CHANGELOG.md
  • packages/preset-eslint/CHANGELOG.md
  • packages/preset-jest/CHANGELOG.md
  • packages/preset-typedoc/CHANGELOG.md
  • packages/preset-typescript/CHANGELOG.md
  • packages/recharts/CHANGELOG.md
  • packages/room-config/CHANGELOG.md
  • packages/room-shell/CHANGELOG.md
  • packages/room-shell/src/data-sources/TableCard.tsx
  • packages/room-store/CHANGELOG.md
  • packages/s3-browser-config/CHANGELOG.md
  • packages/s3-browser/CHANGELOG.md
  • packages/s3-utils/CHANGELOG.md
  • packages/schema-tree/CHANGELOG.md
  • packages/schema-tree/README.md
  • packages/sql-editor-config/CHANGELOG.md
  • packages/sql-editor/CHANGELOG.md
  • packages/sql-editor/README.md
  • packages/ui/CHANGELOG.md
  • packages/ui/src/components/alert.tsx
  • packages/ui/src/components/card.tsx
  • packages/ui/src/components/progress.tsx
  • packages/utils/CHANGELOG.md
  • packages/utils/README.md
  • packages/vega/CHANGELOG.md
  • packages/vega/src/VegaChartActions.tsx
  • packages/vega/src/VegaLiteSqlChart.tsx
  • packages/webcontainer/CHANGELOG.md
  • packages/webcontainer/README.md
  • python/README.md
  • python/sqlrooms-cli/sqlrooms/cli.py
  • python/sqlrooms-cli/sqlrooms/web/db_bridge/connectors/postgres.py
  • python/sqlrooms-cli/sqlrooms/web/db_bridge/connectors/snowflake.py
  • python/sqlrooms-cli/sqlrooms/web/launcher.py
  • python/sqlrooms-cli/sqlrooms/web/ui.py
  • python/sqlrooms-cli/tests/test_cli.py
  • python/sqlrooms-cli/tests/test_db_bridge.py
  • python/sqlrooms-cli/tests/test_launcher.py
  • python/sqlrooms-cli/tests/test_ui_provider.py
  • python/sqlrooms-rag/docs/ARCHITECTURE.md
  • python/sqlrooms-rag/docs/HEADER_WEIGHTING.md
  • python/sqlrooms-rag/docs/METADATA.md
  • python/sqlrooms-rag/docs/QUERYING.md
  • python/sqlrooms-rag/pyproject.toml
  • python/sqlrooms-server/sqlrooms/server/db_async.py
  • python/sqlrooms-server/sqlrooms/server/query.py
  • python/sqlrooms-server/sqlrooms/server/tests/test_concurrency.py
💤 Files with no reviewable changes (56)
  • examples/ai/CHANGELOG.md
  • examples/app-builder/CHANGELOG.md
  • packages/cells/CHANGELOG.md
  • examples/ai-agent/CHANGELOG.md
  • examples/sync/README.md
  • python/sqlrooms-cli/sqlrooms/web/db_bridge/connectors/snowflake.py
  • examples/ai-core/CHANGELOG.md
  • examples/ai-rag/CHANGELOG.md
  • examples/kepler/CHANGELOG.md
  • docs/deployment-scenarios.md
  • python/sqlrooms-rag/pyproject.toml
  • packages/discuss/CHANGELOG.md
  • python/README.md
  • examples/mosaic/CHANGELOG.md
  • packages/duckdb-node/CHANGELOG.md
  • python/sqlrooms-cli/sqlrooms/web/ui.py
  • packages/db/CHANGELOG.md
  • packages/notebook/CHANGELOG.md
  • packages/canvas/CHANGELOG.md
  • packages/mosaic/CHANGELOG.md
  • packages/data-table/CHANGELOG.md
  • packages/ai/CHANGELOG.md
  • packages/schema-tree/CHANGELOG.md
  • packages/motherduck/CHANGELOG.md
  • packages/duckdb/CHANGELOG.md
  • packages/ai-rag/CHANGELOG.md
  • packages/crdt/CHANGELOG.md
  • packages/sql-editor/CHANGELOG.md
  • packages/layout/CHANGELOG.md
  • packages/kepler-config/CHANGELOG.md
  • packages/layout-config/CHANGELOG.md
  • packages/preset-jest/CHANGELOG.md
  • packages/utils/CHANGELOG.md
  • packages/codemirror/CHANGELOG.md
  • packages/s3-utils/CHANGELOG.md
  • packages/preset-eslint/CHANGELOG.md
  • packages/ai-core/CHANGELOG.md
  • packages/room-config/CHANGELOG.md
  • packages/duckdb-core/CHANGELOG.md
  • packages/room-store/CHANGELOG.md
  • packages/preset-typedoc/CHANGELOG.md
  • packages/webcontainer/CHANGELOG.md
  • packages/ai-config/CHANGELOG.md
  • packages/room-shell/CHANGELOG.md
  • packages/dropzone/CHANGELOG.md
  • packages/sql-editor-config/CHANGELOG.md
  • packages/monaco-editor/CHANGELOG.md
  • packages/ui/CHANGELOG.md
  • packages/vega/CHANGELOG.md
  • packages/kepler/CHANGELOG.md
  • packages/preset-typescript/CHANGELOG.md
  • packages/s3-browser-config/CHANGELOG.md
  • packages/recharts/CHANGELOG.md
  • packages/ai-settings/CHANGELOG.md
  • packages/s3-browser/CHANGELOG.md
  • packages/cosmos/CHANGELOG.md

Comment thread python/sqlrooms-rag/docs/METADATA.md
Signed-off-by: Ilya Boyandin <[email protected]>
@ilyabo
ilyabo merged commit 751ec8e into main Mar 22, 2026
7 checks passed
@ilyabo
ilyabo deleted the format branch March 22, 2026 15:50
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.

1 participant