Add EditorConfig and Prettier for basic global formatting config/validation #7788
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces EditorConfig and Prettier for standardized formatting across the project. The changes establish global formatting rules that work across different file types and editors without requiring individual configuration.
Key changes:
- Added EditorConfig configuration for consistent basic formatting rules (line endings, indentation, etc.)
- Introduced Prettier with XML plugin for automated formatting and validation
- Fixed XML syntax issues in plist file to make it valid XML
Reviewed Changes
Copilot reviewed 6 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
.editorconfig |
Defines global formatting rules for all file types with special indentation for manifest files |
.prettierrc |
Configures Prettier with trailing commas, single quotes, and XML plugin |
.prettierignore |
Excludes problematic files from Prettier formatting (WXS files, template JS files, Go modules) |
package.json |
Adds development dependencies for Prettier and Redocly CLI tools |
service/script_templates/com.couchbase.mobile.sync_gateway.plist |
Fixes XML syntax by adding proper quotes around attribute values |
db/functions/js_runner.go |
Renames embedded JS file and updates variable names to exclude it from Prettier |
Member
Author
|
will simplify what I'm doing and just merge into #7787 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
EditorConfig covers basic rules for most files/languages. Most editors will automatically utilize
.editorconfigto provide committed project-level rules for formatting without individual/manual configuration.Introduced to cover consistent formatting for things like JSON and XML files, without introducing more language specific tools.
More advanced language dependent formatting can still use things like
gofmt,yamllint,ruff, etc.Prettier is one way to use those EditorConfig rules, which can validate and/or automatically fix. Most editors will reformat on save without a third-party tool though.
Changes of note:
db/functions/js_runnerchanges to allow the invalid javascript.jsfile to be ignoredcom.couchbase.mobile.sync_gateway.plistto make the file valid XML (verified withplutil)package.json- is a convenient way to specify a list of non-critical dev tools: Prettier and redocly-cli, which can be installed simply vianpm installoryarn installActual formatting fixes off the back of these rules can be made in a follow-up PR just for isolating them.
I've added a preview below either way - it is mostly indentation changes.
diff after
prettier --write .: