Skip to content

chore: add root editorconfig defaults#380

Open
meganetaaan wants to merge 1 commit intodev/v1.0from
ops/add-editorconfig
Open

chore: add root editorconfig defaults#380
meganetaaan wants to merge 1 commit intodev/v1.0from
ops/add-editorconfig

Conversation

@meganetaaan
Copy link
Copy Markdown
Collaborator

@meganetaaan meganetaaan commented Mar 27, 2026

Adds a repository-level .editorconfig so common text formats follow consistent line ending, indentation, and trailing-whitespace defaults.

Summary by CodeRabbit

  • Chores
    • Added editor configuration to standardize code formatting standards (encoding, line endings, indentation) across the repository for common file types.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 27, 2026

📝 Walkthrough

Walkthrough

A new .editorconfig file is added to the repository root to standardize editor formatting rules. It configures UTF-8 encoding, LF line endings, 2-space indentation, and trailing whitespace handling across JavaScript, TypeScript, JSON, YAML, HTML, CSS, and Markdown files.

Changes

Cohort / File(s) Summary
Editor Configuration
.editorconfig
New configuration file establishing consistent formatting standards for common web development file types (JS, TS, JSON, YAML, HTML, CSS) with UTF-8 encoding, LF line endings, and 2-space indentation. Markdown files preserve trailing whitespace while other formats trim it.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A config hop-skip so neat,
Tabs and spaces now compete,
With UTF-8 dreams so bright,
LF endings set just right,
Our little warren's formatting suite!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding a root-level .editorconfig file with default formatting rules for the repository.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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 ops/add-editorconfig

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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
.editorconfig (1)

3-9: Configuration covers main web files, but shell scripts are uncovered.

The configuration properly covers web/text file types (JS, TS, JSON, YAML, HTML, CSS) with appropriate defaults. However, shell scripts (.sh files) exist in firmware/docker/ but are not included in the file pattern.

Consider adding shell scripts to the coverage:

[*.{js,ts,json,jsonc,yml,yaml,html,css,mjs,sh}]

This ensures consistent formatting standards across all configuration and deployment scripts.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.editorconfig around lines 3 - 9, Update the
[*.{js,ts,json,jsonc,yml,yaml,html,css,mjs}] file pattern in .editorconfig to
include shell scripts so .sh files in firmware/docker/ are covered; edit the
existing file pattern (the line starting with
[*.{js,ts,json,jsonc,yml,yaml,html,css,mjs}]) to add "sh" into the brace list
(i.e., expand the glob to include sh) so the existing rules (charset,
end_of_line, indent_style, indent_size, insert_final_newline,
trim_trailing_whitespace) apply to shell scripts as well.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.editorconfig:
- Around line 3-9: Update the [*.{js,ts,json,jsonc,yml,yaml,html,css,mjs}] file
pattern in .editorconfig to include shell scripts so .sh files in
firmware/docker/ are covered; edit the existing file pattern (the line starting
with [*.{js,ts,json,jsonc,yml,yaml,html,css,mjs}]) to add "sh" into the brace
list (i.e., expand the glob to include sh) so the existing rules (charset,
end_of_line, indent_style, indent_size, insert_final_newline,
trim_trailing_whitespace) apply to shell scripts as well.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d76196fa-0bb7-4f26-bef1-7ff5524da64d

📥 Commits

Reviewing files that changed from the base of the PR and between 20a4b1b and c1164d2.

📒 Files selected for processing (1)
  • .editorconfig

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