Skip to content

Improve formatting of .json and .yml files #1605

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 21 commits into
base: trunk
Choose a base branch
from
Open

Improve formatting of .json and .yml files #1605

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
f101786
Formats json and yml files using npm run format
devansh016 Oct 18, 2024
3fed57a
Adds override config for yml and json
devansh016 Oct 18, 2024
eaaa59d
Formats json and yml files
devansh016 Oct 18, 2024
a3ae0e1
Add singleQuote for yml files
devansh016 Oct 18, 2024
d336d2a
Ignores generated lock files
devansh016 Oct 18, 2024
90ac758
Updates .editorconfig as per core and Gutenberg
devansh016 Oct 21, 2024
1d13a44
Formats using npm run format-js
devansh016 Oct 21, 2024
a565773
Updates patterns to ignore
devansh016 Oct 21, 2024
afc3339
Overides .yml config to use 2 spaces
devansh016 Oct 21, 2024
4a9d135
Adds file end line and update WordPress coding standards URL
devansh016 Oct 21, 2024
f9a6838
Merge branch 'trunk' of github.com:devansh016/wp-performance into For…
devansh016 Oct 28, 2024
6773f8e
Merge branch 'Format-files-using-npm-run-format-js' of github.com:dev…
devansh016 Oct 28, 2024
376b0fd
Merge branch 'trunk' of github.com:devansh016/wp-performance into For…
devansh016 Nov 19, 2024
9356e5a
Removes yml file override from prettier config
devansh016 Nov 19, 2024
9f687fd
Merge branch 'trunk' into Format-files-using-npm-run-format-js
devansh016 Jun 3, 2025
278fd9a
Merge branch 'trunk' into Format-files-using-npm-run-format-js
devansh016 Jun 6, 2025
3432198
Merge branch 'trunk' of https://github.com/WordPress/performance into…
westonruter Jun 10, 2025
981e5e5
Update package-lock.json
westonruter Jun 10, 2025
7c0f56c
Ignore build files in plugins and fix path to ignore minified files
westonruter Jun 10, 2025
d59caf6
Remove duplicate prettier config file
devansh016 Jun 10, 2025
ebeefd3
Update indent size to 4 for yml and yaml
devansh016 Jun 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 9 additions & 24 deletions .editorconfig
View file
Open in desktop
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://make.wordpress.org/core/handbook/best-practices/coding-standards/
# https://make.wordpress.org/core/handbook/coding-standards/

root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 4
tab_width = 4
indent_style = tab
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = tab
Comment on lines -9 to +14
Copy link
Member

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 .json and .yml, but then we should have specific rules for these file types.

Copy link
Contributor Author

@devansh016 devansh016 Jun 3, 2025 •
edited
Loading

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!

Copy link
Member

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 .json and .yml files use the indent of 4, but that's exactly what is currently happening: All .json and .yml files use the indent of 4. So from that perspective, I don't see why having this here would be problematic.

Copy link
Contributor Author

@devansh016 devansh016 Jun 10, 2025 •
edited
Loading

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.


[*.md]
trim_trailing_whitespace = false
[*.yml]
indent_style = space
indent_size = 2

[*.txt]
[*.md]
trim_trailing_whitespace = false

[*.json]
indent_style = space
indent_size = 2

[.*rc]
insert_final_newline = false
indent_style = space
indent_size = 2

[*.yml]
insert_final_newline = false
quote_type = single
indent_style = space
indent_size = 2

[.github/CODEOWNERS]
indent_style = space
[*.txt]
end_of_line = crlf
18 changes: 9 additions & 9 deletions .github/dependabot.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,26 @@ updates:
interval: weekly
open-pull-requests-limit: 10
labels:
- "no milestone"
- "[Type] Enhancement"
- "github_actions"
- 'no milestone'
- '[Type] Enhancement'
- 'github_actions'

- package-ecosystem: npm
directory: '/'
schedule:
interval: weekly
open-pull-requests-limit: 10
labels:
- "no milestone"
- "[Type] Enhancement"
- "javascript"
- 'no milestone'
- '[Type] Enhancement'
- 'javascript'

- package-ecosystem: composer
directory: '/'
schedule:
interval: weekly
open-pull-requests-limit: 10
labels:
- "no milestone"
- "[Type] Enhancement"
- "php"
- 'no milestone'
- '[Type] Enhancement'
- 'php'
10 changes: 5 additions & 5 deletions .github/workflows/deploy-plugins.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ jobs:
echo "plugins=$(echo $PLUGINS | jq -c .)" >> $GITHUB_OUTPUT

deploy:
name: "Deploy Plugin: ${{ matrix.plugin }}"
name: 'Deploy Plugin: ${{ matrix.plugin }}'
needs: pre-run
runs-on: ubuntu-latest
permissions:
Expand Down Expand Up @@ -131,7 +131,7 @@ jobs:
with:
step: start
token: ${{ secrets.GITHUB_TOKEN }}
env: "wp.org plugin: ${{ matrix.plugin }}"
env: 'wp.org plugin: ${{ matrix.plugin }}'

- name: Deploy Plugin - ${{ matrix.plugin }}
if: steps.check-deployment.outputs.deploy == 'true'
Expand All @@ -154,12 +154,12 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
status: ${{ job.status }}
deployment_id: ${{ steps.wporg-deployment.outputs.deployment_id }}
env: "wp.org plugin: ${{ matrix.plugin }}"
env_url: "https://wordpress.org/plugins/${{ matrix.plugin }}/"
env: 'wp.org plugin: ${{ matrix.plugin }}'
env_url: 'https://wordpress.org/plugins/${{ matrix.plugin }}/'

release-assets:
name: Add release assets
needs: [ pre-run, deploy ]
needs: [pre-run, deploy]
runs-on: ubuntu-latest
permissions:
actions: read
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/php-test-plugins.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,14 @@ on:

jobs:
php-test-plugins:
name: "PHP ${{ matrix.php }} / WP ${{ matrix.wp }}"
name: 'PHP ${{ matrix.php }} / WP ${{ matrix.wp }}'
runs-on: ubuntu-latest
timeout-minutes: 20
strategy:
fail-fast: false
matrix:
php: ['8.2', '8.1', '8.0', '7.4', '7.3', '7.2']
wp: [ 'latest' ]
wp: ['latest']
include:
- php: '7.4'
wp: '6.5'
Expand Down
14 changes: 14 additions & 0 deletions .prettierignore
View file
Open in desktop
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
1 change: 0 additions & 1 deletion .prettierrc
View file
Open in desktop

This file was deleted.

16 changes: 16 additions & 0 deletions .prettierrc.js
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

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

Is this any different than the .prettierrc?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, functionally they're identical in this case. Both .prettierrc.js and .prettierrc contain the same configuration options and produce the same formatting results.
We can remove .prettierrc.js here

Copy link
Member

Choose a reason for hiding this comment

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

Alternatively, it could be added to package.json:

"prettier": "@wordpress/prettier-config",

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,
},
},
],
};
44 changes: 22 additions & 22 deletions .wp-env.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
{
"core": null,
"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": "."
}
}
}
"core": null,
"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": "."
}
}
}
}
Loading
Loading