Feature/formatting json yaml #30062

GrimLink · 2020-09-15T16:52:09Z

Description (*)

Consider using a indentation of 2 for json and yaml files.
The recommended default for the package.json and yaml files is 2.
The only exception is composer that uses 4.

I know yaml is not a file format found in Magento 2 by default.
But it is used for some use case.

This PR suggests adding more rules to the editorconfig.

Fixed Issues (if relevant)

Manual testing scenarios (*)

None, this just a formatting suggestion

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
All automated tests passed successfully (all builds are green)

No tests needed

m2-assistant · 2020-09-15T16:52:12Z

Hi @GrimLink. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE,
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

auth.json.sample

sidolov · 2020-09-15T21:20:59Z

@magento create issue

GrimLink · 2020-09-15T21:33:43Z

@sidolov I already made an issue for this PR
See #30063

ihor-sviziev · 2020-09-16T03:31:59Z

@magento run all tests

ihor-sviziev

✔ Approved.

Failing tests looks not related to changes form this PR.

magento-engcom-team · 2020-09-16T13:04:32Z

Hi @ihor-sviziev, thank you for the review.
ENGCOM-8219 has been created to process this Pull Request

ihor-sviziev · 2020-09-17T15:02:46Z

@magento run all tests

engcom-Foxtrot · 2020-10-05T10:56:17Z

@magento run all tests

ihor-sviziev · 2020-10-05T11:15:07Z

.editorconfig

-indent_size = 4
-
-[auth.json]
+[{composer, auth}.json]


@engcom-Foxtrot basically it's not the same. You just removed option for composer.lock files.

@ihor-sviziev yes, composer.lock inherits settings from general configuration *. It's not overridden by *.{yml,yaml,json}

ihor-sviziev

@engcom-Foxtrot see my comment here #30062 (review)

magento-engcom-team · 2020-10-06T13:32:02Z

Hi @ihor-sviziev, thank you for the review.
ENGCOM-8219 has been created to process this Pull Request

engcom-Alfa · 2020-10-07T10:53:35Z

Dev experience is required for testing this PR. Please note that Manual testing has not been performed.

engcom-Foxtrot · 2020-10-08T08:55:38Z

QA passed.

m2-assistant · 2020-10-13T11:17:37Z

Hi @GrimLink, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

GrimLink added 6 commits September 15, 2020 18:38

ADD: formatting rules for json and yaml

b70851d

IMP: formatting for grunt config files

f7f5dce

IMP: formatting for dev test config file

9ef8d9d

IMP: formatting for auth.json

93d79b8

IMP: formatting for grunt-config

0533f2e

IMP: formatting for package.json

5b47647

ghost added the Progress: pending review label Sep 15, 2020

magento-engcom-team added the Release Line: 2.4 label Sep 15, 2020

GrimLink mentioned this pull request Sep 15, 2020

editorconfig: use an indentation of 2 for json and yaml files #30063

Closed

5 tasks

ihor-sviziev reviewed Sep 15, 2020

View reviewed changes

auth.json.sample Outdated Show resolved Hide resolved

ghost assigned ihor-sviziev Sep 15, 2020

ghost added Progress: review and removed Progress: pending review labels Sep 15, 2020

ihor-sviziev added improvement Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”. labels Sep 15, 2020

IMP: formatting by keeping auth.json indent, same as composer

9d8a772

sidolov added Priority: P4 No current plan to fix. Fixing can be deferred as a logical part of more important work. Risk: low labels Sep 15, 2020

m2-assistant bot mentioned this pull request Sep 15, 2020

[Issue] Feature/formatting json yaml #30066

Closed

4 tasks

ihor-sviziev approved these changes Sep 16, 2020

View reviewed changes

ghost added Progress: ready for testing and removed Progress: review labels Sep 16, 2020

Merge branch '2.4-develop' into feature/formatting-json-yaml

5f704db

engcom-Foxtrot requested a review from ihor-sviziev October 5, 2020 10:56

ghost added Progress: pending review and removed Progress: extended testing labels Oct 5, 2020

ihor-sviziev reviewed Oct 5, 2020

View reviewed changes

ihor-sviziev requested changes Oct 5, 2020

View reviewed changes

ghost added Progress: needs update and removed Progress: pending review labels Oct 5, 2020

engcom-Foxtrot requested a review from ihor-sviziev October 6, 2020 08:03

ghost added Progress: pending review and removed Progress: needs update labels Oct 6, 2020

ihor-sviziev approved these changes Oct 6, 2020

View reviewed changes

ghost added Progress: ready for testing and removed Progress: pending review labels Oct 6, 2020

ghost added Progress: extended testing and removed Progress: ready for testing labels Oct 7, 2020

engcom-Foxtrot added the QA: Ready to add to Regression Scope Should be analyzed and added to Regression Testing Scope(if applicable) label Oct 8, 2020

engcom-Alfa added QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope and removed QA: Ready to add to Regression Scope Should be analyzed and added to Regression Testing Scope(if applicable) labels Oct 8, 2020

ghost added Progress: accept and removed Progress: extended testing labels Oct 8, 2020

magento-engcom-team pushed a commit that referenced this pull request Oct 13, 2020

ENGCOM-8219: Feature/formatting json yaml #30062

5c30cdb

magento-engcom-team merged commit 13f7ec7 into magento:2.4-develop Oct 13, 2020

GrimLink deleted the feature/formatting-json-yaml branch October 14, 2020 13:38

DmitryFurs mentioned this pull request Dec 4, 2020

Adjust .editorconfig to correct the automatic formatting of db_schema_whitelist.json files #31166

Merged

5 tasks

m2-assistant bot mentioned this pull request Dec 4, 2020

[Issue] Adjust .editorconfig to correct the automatic formatting of db_schema_whitelist.json files #31171

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/formatting json yaml #30062

Feature/formatting json yaml #30062

GrimLink commented Sep 15, 2020 •

edited by ihor-sviziev

Loading

m2-assistant bot commented Sep 15, 2020

sidolov commented Sep 15, 2020

GrimLink commented Sep 15, 2020

ihor-sviziev commented Sep 16, 2020

ihor-sviziev left a comment

magento-engcom-team commented Sep 16, 2020

ihor-sviziev commented Sep 17, 2020

engcom-Foxtrot commented Oct 5, 2020

ihor-sviziev Oct 5, 2020

engcom-Foxtrot Oct 6, 2020 •

edited

Loading

ihor-sviziev left a comment

magento-engcom-team commented Oct 6, 2020

engcom-Alfa commented Oct 7, 2020

engcom-Foxtrot commented Oct 8, 2020

m2-assistant bot commented Oct 13, 2020

Feature/formatting json yaml #30062

Feature/formatting json yaml #30062

Conversation

GrimLink commented Sep 15, 2020 • edited by ihor-sviziev Loading

Description (*)

Fixed Issues (if relevant)

Manual testing scenarios (*)

Contribution checklist (*)

m2-assistant bot commented Sep 15, 2020

sidolov commented Sep 15, 2020

GrimLink commented Sep 15, 2020

ihor-sviziev commented Sep 16, 2020

ihor-sviziev left a comment

Choose a reason for hiding this comment

magento-engcom-team commented Sep 16, 2020

ihor-sviziev commented Sep 17, 2020

engcom-Foxtrot commented Oct 5, 2020

ihor-sviziev Oct 5, 2020

Choose a reason for hiding this comment

engcom-Foxtrot Oct 6, 2020 • edited Loading

Choose a reason for hiding this comment

ihor-sviziev left a comment

Choose a reason for hiding this comment

magento-engcom-team commented Oct 6, 2020

engcom-Alfa commented Oct 7, 2020

engcom-Foxtrot commented Oct 8, 2020

m2-assistant bot commented Oct 13, 2020

GrimLink commented Sep 15, 2020 •

edited by ihor-sviziev

Loading

engcom-Foxtrot Oct 6, 2020 •

edited

Loading