Improve formatting of .json and .yml files
#1605
+25,285
−25,291
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,24 @@ | ||
| # This file is for unifying the coding style for different editors and IDEs | ||
| # editorconfig.org | ||
|
|
||
| # WordPress Coding Standards | ||
| # https://developer.wordpress.org/coding-standards/wordpress-coding-standards/ | ||
|
|
||
| root = true | ||
|
|
||
| [*] | ||
| charset = utf-8 | ||
| end_of_line = lf | ||
| insert_final_newline = true | ||
| trim_trailing_whitespace = true | ||
| indent_style = tab | ||
|
|
||
| [*.yml] | ||
| indent_style = space | ||
| indent_size = 2 | ||
|
|
||
| [*.md] | ||
| trim_trailing_whitespace = false | ||
|
|
||
| [*.txt] | ||
| end_of_line = crlf | ||
|
Comment on lines
+23
to
+24
There was a problem hiding this comment. I don't see a reason for this. WP core has historically done this for its readme.txt for Windows, but we shouldn't do this here. Let's remove it. |
||
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # Files and folders related to build | ||
| /build | ||
| /node_modules | ||
| /vendor | ||
| /dist | ||
|
|
||
| # Minified files | ||
| /*.min.js | ||
|
|
||
| # Ignore Composer lock file | ||
| composer.lock | ||
|
|
||
| # Ignore npm package lock file | ||
| package-lock.json |
|
There was a problem hiding this comment. Is this any different than the There was a problem hiding this comment. No, functionally they're identical in this case. Both .prettierrc.js and .prettierrc contain the same configuration options and produce the same formatting results. There was a problem hiding this comment. Alternatively, it could be added to "prettier": "@wordpress/prettier-config", |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| // Import the default config file and expose it in the project root. | ||
| // Useful for editor integrations. | ||
| const wpPrettierConfig = require( '@wordpress/prettier-config' ); | ||
|
|
||
| module.exports = { | ||
| ...wpPrettierConfig, | ||
| overrides: [ | ||
| { | ||
| files: '*.yml', | ||
| options: { | ||
| useTabs: false, | ||
| tabWidth: 2, | ||
| }, | ||
| }, | ||
| ], | ||
| }; | ||
swissspidy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,24 @@ | ||
| { | ||
| "core": null, | ||
swissspidy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "plugins": [ | ||
| "./plugins/optimization-detective", | ||
| "./plugins/auto-sizes", | ||
| "./plugins/dominant-color-images", | ||
| "./plugins/embed-optimizer", | ||
| "./plugins/image-prioritizer", | ||
| "./plugins/performance-lab", | ||
| "./plugins/speculation-rules", | ||
| "./plugins/web-worker-offloading", | ||
| "./plugins/webp-uploads" | ||
| ], | ||
| "env": { | ||
| "tests": { | ||
| "config": { | ||
| "FS_METHOD": "direct" | ||
| }, | ||
| "mappings": { | ||
| "/wp-content/plugins/performance": "." | ||
| } | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why this change? The tab width for actual code (PHP and JS) should be 4, so I don't see why this needs to be removed here.
It doesn't apply to
.jsonand.yml, but then we should have specific rules for these file types.Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@felixarntz
When both .editorconfig and .prettierrc are present, Prettier gives precedence to .prettierrc, which ensures PHP and JS files retain their intended 4-space/tab indentation.
I removed the global indent_size = 4 from .editorconfig since it was unintentionally being inherited by .json and .yml files. These files conventionally follow 2-space indentation, so I added specific overrides for them instead.
These updates follow the coding standards defined in the WordPress Core and Gutenberg repositories to stay aligned with WordPress development practices.
Please let me know if you'd like me to make any adjustments or if there's anything I might have missed. Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Following up on this, I am still not sure about it.
You mention it was removed because it made
.jsonand.ymlfiles use the indent of 4, but that's exactly what is currently happening: All.jsonand.ymlfiles use the indent of 4. So from that perspective, I don't see why having this here would be problematic.Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking back at this more carefully, I realize I may have overcomplicated the situation. The global indent_size = 4 shouldn't actually cause issues with .json and .yml files if we have proper Prettier configuration in place, since Prettier takes precedence for formatting.
But still we should keep the .editorconfig aligned with WordPress Core and Gutenberg repositories for consistency.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure about aligning
.editorconfigjust for the sake of aligning - aren't the configurations for WordPress Core and Gutenberg somewhat incompldete?d
The WordPress Coding Standards clearly state that indent size of a tab should be 4. If this is not expressed in
.editorconfig, doesn't it leave things up to chance? That wouldn't be right.I don't think we should accept that just because Prettier handles it. The Coding Standards setup of the repository should be consistently configured between different tooling, it shouldn't conflict.
In other words, I think we have two options:
indent_size = 4globally and override it for any file types where it isn't 4..php,.js,.css,.html,.ts,.tsx).