Improve formatting of `.json` and `.yml` files by devansh016 · Pull Request #1605 · WordPress/performance

devansh016 · 2024-10-18T05:00:17Z

Summary

Relevant technical choices

The following files have been formatted by using npm run format-js
Note: .yml and .json files were not ignored to ensure they are properly formatted as well.

.eslintrc.js 22ms
.github/dependabot.yml 12ms
.github/workflows/bump-wordpress-tested-up-to.yml 7ms
.github/workflows/codeql-analysis.yml 3ms
.github/workflows/deploy-plugins.yml 8ms
.github/workflows/e2e-test.yml 3ms
.github/workflows/js-lint.yml 2ms
.github/workflows/php-lint.yml 3ms
.github/workflows/php-test-plugins.yml 5ms
.github/workflows/plugin-check.yml 4ms
.github/workflows/pr-validation.yml 1ms
.github/workflows/props-bot.yml 2ms
.github/workflows/spell-check.yml 1ms
.prettierrc.js 2ms
.wp-env.json 2ms
.wp-env.override.json 2ms
bin/plugin/cli.js 7ms
bin/plugin/commands/changelog.js 15ms
bin/plugin/commands/readme.js 7ms
bin/plugin/commands/since.js 4ms
bin/plugin/commands/versions.js 4ms
bin/plugin/config.js 1ms
bin/plugin/lib/logger.js 1ms
bin/plugin/lib/milestone.js 2ms
bin/validate-json-schema.js 3ms
codecov.yml 1ms
composer.json 1ms
lint-staged.config.js 3ms
package.json 1ms
plugins.json 0ms
plugins/auto-sizes/tests/e2e/specs/improve-calculate-sizes.spec.js 3ms
plugins/embed-optimizer/detect.js 2ms
plugins/embed-optimizer/lazy-load.js 2ms
plugins/image-prioritizer/detect.js 3ms
plugins/image-prioritizer/lazy-load-bg-image.js 2ms
plugins/image-prioritizer/lazy-load-video.js 2ms
plugins/image-prioritizer/tests/test-cases/preload-links-with-one-half-stale-group/url-metrics.json 8ms
plugins/optimization-detective/detect-loader.js 1ms
plugins/optimization-detective/detect.js 14ms
plugins/optimization-detective/tests/data/url-metrics/tablet-viewport-half-stale.json 5ms
plugins/optimization-detective/types.ts 64ms
plugins/performance-lab/.wordpress-org/blueprints/blueprint.json 1ms
plugins/performance-lab/includes/admin/plugin-activate-ajax.js 2ms
plugins/view-transitions/js/types.ts 2ms
plugins/view-transitions/js/view-transitions.js 4ms
tools/e2e/playwright.config.ts 2ms
tools/webpack/utils.js 3ms
tsconfig.json 1ms
webpack.config.js 8ms

github-actions · 2024-10-18T05:04:44Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: devansh016 <devansh2002@git.wordpress.org>
Co-authored-by: westonruter <westonruter@git.wordpress.org>
Co-authored-by: mukeshpanchal27 <mukesh27@git.wordpress.org>
Co-authored-by: thelovekesh <thelovekesh@git.wordpress.org>
Co-authored-by: swissspidy <swissspidy@git.wordpress.org>
Co-authored-by: felixarntz <flixos90@git.wordpress.org>
Co-authored-by: phanduynam <phanduynam@git.wordpress.org>
Co-authored-by: dilipom13 <dilip2615@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

westonruter · 2024-10-18T05:06:47Z

Let's also do linting of JSON and YML files in the lint-staged config so this doesn't happen again. Also, why isn't the formatting not causing a failure on the GHA checks?

westonruter · 2024-10-18T05:20:00Z

Will Dependabot updates undo the changes to composer.json, package-lock.json, and package.json?

.wp-env.json

devansh016 · 2024-10-18T07:02:22Z

Also, why isn't the formatting not causing a failure on the GHA checks?

npm run lint-js doesn't check for .yml and .json file and hence not causing a failure on the GHA checks.

thelovekesh · 2024-10-18T07:04:04Z

I think we squash and merge this one and include an ignore commit for the merge commit to hide it in git blame. Ref: https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view.

swissspidy · 2024-10-18T07:11:52Z

We should exclude generated lock files from Prettier, just to avoid conflicts

thelovekesh · 2024-10-18T07:28:33Z

We should exclude generated lock files from Prettier, just to avoid conflicts

Yes, we should ignore any auto-generated files. @devansh016 can you please add a https://prettier.io/docs/en/ignore.html with such files?

westonruter · 2024-10-18T14:39:47Z

See also WordPress/gutenberg#30714 in which Gutenberg started applying formatting to JSON files.

.editorconfig

Co-authored-by: Mukesh Panchal <mukeshpanchal27@users.noreply.github.com>

westonruter · 2024-10-21T19:20:41Z

Will Dependabot updates undo the changes to composer.json, package-lock.json, and package.json?

I think we still need to confirm Dependabot's behavior. We wouldn't want it constantly reverting tabs back to spaces.

devansh016 · 2024-10-22T14:18:55Z

Will Dependabot updates undo the changes to composer.json, package-lock.json, and package.json?

I think we still need to confirm Dependabot's behavior. We wouldn't want it constantly reverting tabs back to spaces.

Dependabot generally respects the indentation style in package.json when updating the lockfile so it should not revert tabs back to spaces. Ref

felixarntz

I'm still not sold on the changes in .editorconfig - making things more vague just to not conflict doesn't seem right to me. For any problems that the current .editorconfig is causing, we should fix them, not avoid them. Related: #1605 (comment)

In general, I'd also love to get @swissspidy to sign off on the changes in this PR.

swissspidy · 2025-07-07T15:33:14Z

.editorconfig

+[*.txt]
+end_of_line = crlf


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.

Removed in 9813349

swissspidy · 2025-07-07T15:33:38Z

Same here.

Happy to take another look once those changes are (partially) reverted and the merge conflicts resolved.

westonruter · 2026-01-07T02:41:17Z

Once #2325 is merged, let's pick this up again. It's annoying to me how every time I run npm run format-js it modifies many files.

Co-authored-by: swissspidy <swissspidy@git.wordpress.org>

westonruter · 2026-01-07T07:04:02Z

Merge conflicts have been resolved.

Copilot

Pull request overview

This PR standardizes the formatting of JSON and YAML files across the repository using Prettier and WordPress coding standards. The changes switch JSON files from 2-space indentation to tab indentation, and YAML files to 4-space indentation.

Key changes:

JSON and YAML files reformatted with consistent indentation (tabs for JSON, 4 spaces for YAML)
Prettier configuration moved from standalone .prettierrc file to package.json
Added .prettierignore to exclude build artifacts and lock files from formatting

Reviewed changes

Copilot reviewed 7 out of 23 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
`.editorconfig`	Simplified configuration, removed specific JSON rules (now uses default tab indentation)
`.prettierrc`	Deleted - configuration moved to package.json
`.prettierignore`	Added to exclude build files, vendor, and lock files from formatting
`package.json`	Added `"prettier": "@wordpress/prettier-config"` field
`tsconfig.json`	Reformatted with tabs instead of spaces
`composer.json`	Reformatted with tabs, improved readability
`plugins.json`	Reformatted with tabs
`.wp-env.json`	Reformatted with tabs
`codecov.yml`	Reformatted with 4-space indentation
`.github/workflows/*.yml`	All workflow files reformatted with 4-space indentation
`.github/dependabot.yml`	Reformatted with 4-space indentation
`plugins//tests//.json`	Test data files reformatted with tabs

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.editorconfig

westonruter · 2026-01-07T07:18:28Z

.editorconfig

+[*.{yml,yaml}]
 indent_style = space
-indent_size = 2
+indent_size = 4


Humm. Gutenberg's .editorconfig includes:

[*.{yml,yaml}] indent_style = space indent_size = 2

Same as in wordpress-develop's .editorconfig

And yet, running npm run format-js automatically adds 4 spaces to YAML files. 😕

I just tested by making changes to .editorconfig in wordpress-develop's and running the format command. It is not following the changes.

For reference adding .prettierrc.js is making the format follow these rules. Not sure why .editorconfig rules are been followed.

/** * Prettier configuration. * * @see https://prettier.io/docs/en/configuration.html */ const wordpressConfig = require( '@wordpress/prettier-config' ); /** @type {import("prettier").Config} */ const config = { ...wordpressConfig, overrides: [ ...( wordpressConfig.overrides || [] ), { files: '*.{yml,yaml}', options: { useTabs: false, tabWidth: 2, }, }, ], }; module.exports = config;

Should we override the prettier config to force it to match .editorconfig?

Gutenberg's YAML files are formatted with 4 spaces.

yes you'll need to override settings in a prettier config because at the moment prettier is loading its options from (package.json).prettier

$ npx prettier --find-config-path webpack.config.js package.json

that loads @wordpress/prettier-config which have tabWidth: 4 for every file.

const config = { useTabs: true, tabWidth: 4, printWidth: 80, singleQuote: true, trailingComma: 'es5', bracketSameLine: false, bracketSpacing: true, semi: true, arrowParens: 'always', ...customOptions, overrides: [ { files: '*.{css,sass,scss}', options: { singleQuote: false, ...customStyleOptions, }, }, ], };

.editorconfig is just here to provide styles to editors and it don't have any effect on formatting, but when prettier config doesn't exists, it tries to resolve defaults from .editorconfig, which have no effect here since prettier config is already being resolved from @wordpress/prettier-config.

also, i think the override changes should be proposed to @wordpress/prettier-config since gutenberg and core .editorconfig says so, which is correct.

My head is kinda spinning here.

Gutenberg is using 4 spaces in its YAML files, for example: https://github.com/WordPress/gutenberg/blob/trunk/.github/dependabot.yml

wordpress-develop is using 2 spaces ints in YAML files, for example: https://github.com/WordPress/wordpress-develop/blob/trunk/.github/workflows/php-compatibility.yml

Nevertheless, both Gutenberg and wordpress-develop have .editorconfig files with:

[*.{yml,yaml}] indent_style = space indent_size = 2

So Gutenberg's YAML files are incorrectly formatted according to the .editorconfig and this appears to be due to format-js which is configured to use 4 spaces instead of 2.

So we need to override the Prettier config to force it to use 2 spaces for YAML files. I've committed this in 15f2f03.

yes that's correct

Update .editorconfig to use 2 spaces for YAML files. Add .prettierrc.js to override @wordpress/prettier-config for YAML files. Remove prettier config from package.json in favor of the new configuration file. Co-authored-by: devansh016 <devanshchaudhary2002@gmail.com> Co-authored-by: thelovekesh <thelovekesh@git.wordpress.org> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

… Format-files-using-npm-run-format-js

…ss-develop

Copilot

Pull request overview

Copilot reviewed 8 out of 16 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.editorconfig

.prettierignore

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 8 out of 16 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

… Format-files-using-npm-run-format-js

Formats json and yml files using npm run format

f101786

westonruter added no milestone PRs that do not have a defined milestone for release [Type] Bug An existing feature is broken labels Oct 18, 2024

devansh016 marked this pull request as ready for review October 18, 2024 05:04

devansh016 requested review from felixarntz, mukeshpanchal27 and thelovekesh as code owners October 18, 2024 05:04

mukeshpanchal27 requested changes Oct 18, 2024

View reviewed changes

.wp-env.json Show resolved Hide resolved

devansh016 added 3 commits October 18, 2024 12:12

Adds override config for yml and json

3fed57a

Formats json and yml files

eaaa59d

Add singleQuote for yml files

a3ae0e1

Ignores generated lock files

d336d2a

devansh016 added 4 commits October 21, 2024 15:02

Updates .editorconfig as per core and Gutenberg

90ac758

Formats using npm run format-js

1d13a44

Updates patterns to ignore

a565773

Overides .yml config to use 2 spaces

afc3339

devansh016 requested a review from mukeshpanchal27 October 21, 2024 10:21

mukeshpanchal27 reviewed Oct 21, 2024

View reviewed changes

.editorconfig Outdated Show resolved Hide resolved

mukeshpanchal27 reviewed Oct 21, 2024

View reviewed changes

.editorconfig Outdated Show resolved Hide resolved

Adds file end line and update WordPress coding standards URL

4a9d135

Co-authored-by: Mukesh Panchal <mukeshpanchal27@users.noreply.github.com>

devansh016 added 2 commits June 10, 2025 21:22

Remove duplicate prettier config file

d59caf6

Update indent size to 4 for yml and yaml

ebeefd3

devansh016 requested a review from felixarntz July 7, 2025 05:22

felixarntz reviewed Jul 7, 2025

View reviewed changes

swissspidy reviewed Jul 7, 2025

View reviewed changes

westonruter and others added 2 commits January 6, 2026 22:58

Merge branch 'trunk' into Format-files-using-npm-run-format-js

88b7d8b

Remove Windows EOL for TXT files

9813349

Co-authored-by: swissspidy <swissspidy@git.wordpress.org>

westonruter requested a review from Copilot January 7, 2026 07:05

Copilot started reviewing on behalf of westonruter January 7, 2026 07:05 View session

Copilot AI reviewed Jan 7, 2026

View reviewed changes

.editorconfig Show resolved Hide resolved

westonruter reviewed Jan 7, 2026

View reviewed changes

.editorconfig Show resolved Hide resolved

westonruter reviewed Jan 7, 2026

View reviewed changes

westonruter and others added 4 commits January 7, 2026 16:17

Reformat YAML files with 2 spaces instead of 4

f2fa79b

Merge branch 'trunk' of https://github.com/WordPress/performance into…

f92505a

… Format-files-using-npm-run-format-js

Remove *.yaml from .editorconfig since not present in repo or wordpre…

e7ca93d

…ss-develop

westonruter requested a review from Copilot January 8, 2026 00:30

Copilot started reviewing on behalf of westonruter January 8, 2026 00:30 View session

Copilot AI reviewed Jan 8, 2026

View reviewed changes

.editorconfig Outdated Show resolved Hide resolved

.editorconfig Outdated Show resolved Hide resolved

.editorconfig Show resolved Hide resolved

.prettierignore Show resolved Hide resolved

westonruter and others added 2 commits January 7, 2026 16:56

Fix typo in comment

17238f4

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Fix another comment typo

e8d9723

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

westonruter requested a review from Copilot January 8, 2026 01:06

Copilot started reviewing on behalf of westonruter January 8, 2026 01:06 View session

Copilot AI reviewed Jan 8, 2026

View reviewed changes

Merge branch 'trunk' of https://github.com/WordPress/performance into…

2e8f0b4

… Format-files-using-npm-run-format-js

westonruter merged commit 11c5c5c into WordPress:trunk Jan 8, 2026
43 of 44 checks passed

westonruter mentioned this pull request Jan 12, 2026

Run unit tests only for plugins with changes #1838

Open

		[*.txt]
		end_of_line = crlf

Conversation

devansh016 commented Oct 18, 2024 • edited by westonruter Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Relevant technical choices

Uh oh!

github-actions bot commented Oct 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

westonruter commented Oct 18, 2024

Uh oh!

westonruter commented Oct 18, 2024

Uh oh!

Uh oh!

devansh016 commented Oct 18, 2024

Uh oh!

thelovekesh commented Oct 18, 2024

Uh oh!

swissspidy commented Oct 18, 2024

Uh oh!

thelovekesh commented Oct 18, 2024

Uh oh!

westonruter commented Oct 18, 2024

Uh oh!

Uh oh!

Uh oh!

westonruter commented Oct 21, 2024

Uh oh!

devansh016 commented Oct 22, 2024

Uh oh!

felixarntz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

swissspidy commented Jul 7, 2025

Uh oh!

westonruter commented Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

westonruter commented Jan 7, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

westonruter Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

devansh016 commented Oct 18, 2024 •

edited by westonruter

Loading

github-actions bot commented Oct 18, 2024 •

edited

Loading

westonruter commented Jan 7, 2026 •

edited

Loading

westonruter Jan 7, 2026 •

edited

Loading