Formats json and yml files using npm run format #1605

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.

.github/dependabot.yml
.github/workflows/codeql-analysis.yml
.github/workflows/deploy-plugins.yml
.github/workflows/js-lint.yml
.github/workflows/php-lint.yml
.github/workflows/php-test-plugins.yml
.github/workflows/pr-validation.yml
.github/workflows/props-bot.yml
.github/workflows/spell-check.yml
.wp-env.json
composer.json
package-lock.json
package.json
plugins.json
plugins/performance-lab/.wordpress-org/blueprints/blueprint.json
tsconfig.json

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 <[email protected]>
Co-authored-by: mukeshpanchal27 <[email protected]>
Co-authored-by: thelovekesh <[email protected]>
Co-authored-by: swissspidy <[email protected]>
Co-authored-by: felixarntz <[email protected]>
Co-authored-by: westonruter <[email protected]>

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?

mukeshpanchal27 · 2024-10-18T05:25:05Z

.wp-env.json

-      }
-    }
-  }
+	"core": null,


Per https://github.com/WordPress/performance/blob/trunk/.editorconfig#L23-L25 the json config it should use two space not tab 🤔

It seems that when running npm run format-js, the .editorconfig settings are not being applied, which is causing JSON files to use tabs instead of 2 spaces as specified in the .editorconfig. It appears the command is currently using the .prettierrc configuration instead.

When both .editorconfig and .prettierrc are present, Prettier gives precedence to .prettierrc. You can override config for yml and json to change this behavior from the Prettier config file - https://prettier.io/docs/en/configuration.html#configuration-overrides

Seems strange that we have to apply a manual override for the default Prettier configuration used by wp-scripts, as that is the de facto standard.

Our .editorconfig file looks quite different from what's in core or Gutenberg. They both use tabs for JSON files for example.

So I think we should rather update our .editorconfig rather than the Prettier config.

Yeah, I noticed that too the other week. FWIW the .editorconfig we use is old, and a long time ago I believe this was common in WP land to use two spaces for those kinds of files. But since Gutenberg provides centralized tooling that dictates otherwise, I feel like it would make sense to align with that.

I have updated the .editorconfig file to align with the settings used in Core and Gutenberg, where JSON files use tabs instead of 2 spaces. This should prevent conflicts with the existing Prettier configuration and ensure consistency across the project.

Thanks. Can we then remove this .prettierrc.js override for yml files? We should be able to use the default config for those too, no?

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 <[email protected]>

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

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

…ansh016/wp-performance into Format-files-using-npm-run-format-js

swissspidy · 2024-11-04T16:45:54Z

.prettierrc.js

+// 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,
+			},
+		},
+	],
+};


Why do we need this override?

@swissspidy When both .editorconfig and .prettierrc are present, Prettier gives precedence to .prettierrc. Further the recommended indentation for YAML files is two spaces per level, so we override it here.

But the default Prettier config should be correct for our needs, and the editorconfig should match the Prettier config 🤔

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 mukeshpanchal27, felixarntz and thelovekesh as code owners October 18, 2024 05:04

mukeshpanchal27 requested changes Oct 18, 2024

View reviewed changes

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 <[email protected]>

devansh016 requested a review from mukeshpanchal27 October 28, 2024 08:20

devansh016 added 2 commits October 28, 2024 13:53

Merge branch 'trunk' of github.com:devansh016/wp-performance into For…

f9a6838

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

Merge branch 'Format-files-using-npm-run-format-js' of github.com:dev…

6773f8e

…ansh016/wp-performance into Format-files-using-npm-run-format-js

swissspidy reviewed Nov 4, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Formats json and yml files using npm run format #1605

Formats json and yml files using npm run format #1605

devansh016 commented Oct 18, 2024 •

edited by westonruter

Loading

github-actions bot commented Oct 18, 2024 •

edited

Loading

westonruter commented Oct 18, 2024

westonruter commented Oct 18, 2024

mukeshpanchal27 Oct 18, 2024

devansh016 Oct 18, 2024

thelovekesh Oct 18, 2024

swissspidy Oct 18, 2024

felixarntz Oct 18, 2024

devansh016 Oct 21, 2024

swissspidy Nov 4, 2024

devansh016 commented Oct 18, 2024

thelovekesh commented Oct 18, 2024

swissspidy commented Oct 18, 2024

thelovekesh commented Oct 18, 2024

westonruter commented Oct 18, 2024

westonruter commented Oct 21, 2024

devansh016 commented Oct 22, 2024

swissspidy Nov 4, 2024

devansh016 Nov 8, 2024

swissspidy Nov 8, 2024

Formats json and yml files using npm run format #1605

Are you sure you want to change the base?

Formats json and yml files using npm run format #1605

Conversation

devansh016 commented Oct 18, 2024 • edited by westonruter Loading

Summary

Relevant technical choices

github-actions bot commented Oct 18, 2024 • edited Loading

westonruter commented Oct 18, 2024

westonruter commented Oct 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devansh016 commented Oct 18, 2024

thelovekesh commented Oct 18, 2024

swissspidy commented Oct 18, 2024

thelovekesh commented Oct 18, 2024

westonruter commented Oct 18, 2024

westonruter commented Oct 21, 2024

devansh016 commented Oct 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devansh016 commented Oct 18, 2024 •

edited by westonruter

Loading

github-actions bot commented Oct 18, 2024 •

edited

Loading