Skip to content
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.

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

Adjust repo config for VS Code formatting #122758

Merged
merged 7 commits into from
Apr 14, 2023

Conversation

guidezpl
Copy link
Member

@guidezpl guidezpl commented Mar 15, 2023

If someone's user settings include the following, the current workspace level formatting settings don't apply since they aren't as specific.

"[dart]": {
  "editor.formatOnSave": true,
  "editor.formatOnType": true,
}

This PR handles this by turning off auto-formatting specifically for Dart files.

This PR also adds "files.trimTrailingWhitespace": true to simplify contribution guide.

Fixes #122050. This change is test-exempt.

Pre-launch Checklist

  • I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
  • I read the [Tree Hygiene] wiki page, which explains my responsibilities.
  • I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
  • I signed the [CLA].
  • I listed at least one issue that this PR fixes in the description above.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is [test-exempt].
  • All existing and new tests are passing.

@guidezpl guidezpl requested a review from timsneath March 15, 2023 21:31
@flutter-dashboard
Copy link

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat (don't just cc him here, he won't see it! He's on Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

@guidezpl guidezpl requested a review from DanTup March 15, 2023 21:31
@guidezpl
Copy link
Member Author

@DanTup is my understanding of user vs. workspace settings + language-specific settings correct?

Copy link
Contributor

@DanTup DanTup left a comment

Choose a reason for hiding this comment

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

Yes, you're right - I overlooked this in the last review 🙈

We should also add editor.formatOnPaste. That's what I meant to include in the comment at #122048 (comment) but apparently just included formatOnSave again.

@goderbauer goderbauer added the team Infra upgrades, team productivity, code health, technical debt. See also team: labels. label Mar 15, 2023
.vscode/settings.json Outdated Show resolved Hide resolved
Copy link
Contributor

@timsneath timsneath left a comment

Choose a reason for hiding this comment

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

LGTM!

@Hixie
Copy link
Contributor

Hixie commented Mar 16, 2023

test-exempt: configuration change

@timsneath
Copy link
Contributor

@guidezpl I also noticed this:
https://github.com/flutter/flutter/wiki/Setting-up-the-Framework-development-environment#set-up-your-environment

which suggests the following config change:

    "files.trimTrailingWhitespace": true

If we can add that one also, I think we can delete the wiki VSCode configuration section, which will reduce additional configuration toil for contributors. Any chance you can add this to this PR?

@guidezpl
Copy link
Member Author

If we can add that one also, I think we can delete the wiki VSCode configuration section, which will reduce additional configuration toil for contributors. Any chance you can add this to this PR?

Nice, I'll add it and edit the wiki.

@guidezpl guidezpl changed the title Be more specific with turning off Dart formatting Adjust repo config for VS Code formatting Apr 14, 2023
@guidezpl guidezpl merged commit a0b7a6b into flutter:master Apr 14, 2023
31 of 32 checks passed
@guidezpl guidezpl deleted the fix-vscode-formatting branch April 14, 2023 10:35
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 14, 2023
auto-submit bot pushed a commit to flutter/packages that referenced this pull request Apr 14, 2023
flutter/flutter@be45eb2...f740544

2023-04-14 engine-flutter-autoroll@skia.org Roll Flutter Engine from b7b2e7b742aa to 4b96e38c9275 (1 revision) (flutter/flutter#124856)
2023-04-14 6655696+guidezpl@users.noreply.github.com Adjust repo config for VS Code formatting (flutter/flutter#122758)
2023-04-14 engine-flutter-autoroll@skia.org Roll Flutter Engine from 4f86a05ac932 to b7b2e7b742aa (4 revisions) (flutter/flutter#124845)
2023-04-14 engine-flutter-autoroll@skia.org Roll Flutter Engine from 00bef00f64a7 to 4f86a05ac932 (5 revisions) (flutter/flutter#124841)
2023-04-14 engine-flutter-autoroll@skia.org Roll Flutter Engine from ad222b0c93b9 to 00bef00f64a7 (1 revision) (flutter/flutter#124837)
2023-04-14 andrewrkolos@gmail.com [flutter_tools] Reorganize android_studio_test.dart (flutter/flutter#124834)
2023-04-14 engine-flutter-autoroll@skia.org Roll Flutter Engine from ce7be0093399 to ad222b0c93b9 (1 revision) (flutter/flutter#124832)
2023-04-14 magder@google.com Remove Finder extended attributes in build target before code signing iOS frameworks (flutter/flutter#123896)
2023-04-14 kevmoo@users.noreply.github.com flutter-tool, web: update HTML template serviceWorkerVersion to be const (flutter/flutter#124826)
2023-04-14 tessertaha@gmail.com Fix `CupertinoContextMenu` throws exception on route animation (flutter/flutter#124785)
2023-04-14 kevmoo@users.noreply.github.com flutter-tool: enum cleanup (flutter/flutter#124760)
2023-04-14 engine-flutter-autoroll@skia.org Roll Flutter Engine from 1289f4b513ef to ce7be0093399 (1 revision) (flutter/flutter#124825)
2023-04-13 49699333+dependabot[bot]@users.noreply.github.com Bump actions/checkout from 3.5.1 to 3.5.2 (flutter/flutter#124822)
2023-04-13 engine-flutter-autoroll@skia.org Roll Flutter Engine from 2ff14d733daa to 1289f4b513ef (2 revisions) (flutter/flutter#124824)
2023-04-13 engine-flutter-autoroll@skia.org Roll Flutter Engine from eb3e7d52ebbc to 2ff14d733daa (1 revision) (flutter/flutter#124820)
2023-04-13 reidbaker@google.com i123643 print java version gradle (flutter/flutter#123644)
2023-04-13 engine-flutter-autoroll@skia.org Roll Flutter Engine from 496543715bdb to eb3e7d52ebbc (3 revisions) (flutter/flutter#124816)
2023-04-13 fluttergithubbot@gmail.com Roll pub packages (flutter/flutter#124709)
2023-04-13 21270878+elliette@users.noreply.github.com [flutter_tools] Disable flaky `output_web_test` test case (flutter/flutter#124257)
2023-04-13 engine-flutter-autoroll@skia.org Roll Flutter Engine from 26eddb64e8ea to 496543715bdb (1 revision) (flutter/flutter#124812)
2023-04-13 tessertaha@gmail.com Refactor `SliverAppBar.medium` & `SliverAppBar.large` to fix several issues (flutter/flutter#122542)
2023-04-13 jmccandless@google.com Improve the docs around the TextSelectionHandleControls deprecations (flutter/flutter#123827)
2023-04-13 engine-flutter-autoroll@skia.org Roll Packages from fe5615f to d01f4ea (5 revisions) (flutter/flutter#124795)
2023-04-13 engine-flutter-autoroll@skia.org Roll Flutter Engine from 81a57d24e62a to 26eddb64e8ea (1 revision) (flutter/flutter#124794)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages
Please CC bmparr@google.com,rmistry@google.com,stuartmorgan@google.com on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
exaby73 pushed a commit to NevercodeHQ/flutter that referenced this pull request Apr 17, 2023
If someone's user settings include the following, the current workspace
level formatting settings don't apply since they aren't as specific.
```
"[dart]": {
  "editor.formatOnSave": true,
  "editor.formatOnType": true,
}
```

This PR handles this by turning off auto-formatting specifically for
Dart files.

This PR also adds `"files.trimTrailingWhitespace": true` to simplify
[contribution
guide](https://github.com/flutter/flutter/wiki/Setting-up-the-Framework-development-environment#set-up-your-environment).

Fixes flutter#122050. This change is
test-exempt.

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] All existing and new tests are passing.
nploi pushed a commit to nploi/packages that referenced this pull request Jul 16, 2023
…r#3713)

flutter/flutter@be45eb2...f740544

2023-04-14 engine-flutter-autoroll@skia.org Roll Flutter Engine from b7b2e7b742aa to 4b96e38c9275 (1 revision) (flutter/flutter#124856)
2023-04-14 6655696+guidezpl@users.noreply.github.com Adjust repo config for VS Code formatting (flutter/flutter#122758)
2023-04-14 engine-flutter-autoroll@skia.org Roll Flutter Engine from 4f86a05ac932 to b7b2e7b742aa (4 revisions) (flutter/flutter#124845)
2023-04-14 engine-flutter-autoroll@skia.org Roll Flutter Engine from 00bef00f64a7 to 4f86a05ac932 (5 revisions) (flutter/flutter#124841)
2023-04-14 engine-flutter-autoroll@skia.org Roll Flutter Engine from ad222b0c93b9 to 00bef00f64a7 (1 revision) (flutter/flutter#124837)
2023-04-14 andrewrkolos@gmail.com [flutter_tools] Reorganize android_studio_test.dart (flutter/flutter#124834)
2023-04-14 engine-flutter-autoroll@skia.org Roll Flutter Engine from ce7be0093399 to ad222b0c93b9 (1 revision) (flutter/flutter#124832)
2023-04-14 magder@google.com Remove Finder extended attributes in build target before code signing iOS frameworks (flutter/flutter#123896)
2023-04-14 kevmoo@users.noreply.github.com flutter-tool, web: update HTML template serviceWorkerVersion to be const (flutter/flutter#124826)
2023-04-14 tessertaha@gmail.com Fix `CupertinoContextMenu` throws exception on route animation (flutter/flutter#124785)
2023-04-14 kevmoo@users.noreply.github.com flutter-tool: enum cleanup (flutter/flutter#124760)
2023-04-14 engine-flutter-autoroll@skia.org Roll Flutter Engine from 1289f4b513ef to ce7be0093399 (1 revision) (flutter/flutter#124825)
2023-04-13 49699333+dependabot[bot]@users.noreply.github.com Bump actions/checkout from 3.5.1 to 3.5.2 (flutter/flutter#124822)
2023-04-13 engine-flutter-autoroll@skia.org Roll Flutter Engine from 2ff14d733daa to 1289f4b513ef (2 revisions) (flutter/flutter#124824)
2023-04-13 engine-flutter-autoroll@skia.org Roll Flutter Engine from eb3e7d52ebbc to 2ff14d733daa (1 revision) (flutter/flutter#124820)
2023-04-13 reidbaker@google.com i123643 print java version gradle (flutter/flutter#123644)
2023-04-13 engine-flutter-autoroll@skia.org Roll Flutter Engine from 496543715bdb to eb3e7d52ebbc (3 revisions) (flutter/flutter#124816)
2023-04-13 fluttergithubbot@gmail.com Roll pub packages (flutter/flutter#124709)
2023-04-13 21270878+elliette@users.noreply.github.com [flutter_tools] Disable flaky `output_web_test` test case (flutter/flutter#124257)
2023-04-13 engine-flutter-autoroll@skia.org Roll Flutter Engine from 26eddb64e8ea to 496543715bdb (1 revision) (flutter/flutter#124812)
2023-04-13 tessertaha@gmail.com Refactor `SliverAppBar.medium` & `SliverAppBar.large` to fix several issues (flutter/flutter#122542)
2023-04-13 jmccandless@google.com Improve the docs around the TextSelectionHandleControls deprecations (flutter/flutter#123827)
2023-04-13 engine-flutter-autoroll@skia.org Roll Packages from fe5615f to d01f4ea (5 revisions) (flutter/flutter#124795)
2023-04-13 engine-flutter-autoroll@skia.org Roll Flutter Engine from 81a57d24e62a to 26eddb64e8ea (1 revision) (flutter/flutter#124794)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages
Please CC bmparr@google.com,rmistry@google.com,stuartmorgan@google.com on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
gnprice added a commit to gnprice/zulip-flutter that referenced this pull request Jul 19, 2023
The details here are largely borrowed from the Flutter repo,
and in particular the subtleties most recently added there:
  flutter/flutter#122758

This config does the job in my testing.

Note that it doesn't affect any of the things the editor does to
simply augment your typing: adding indentation when you hit enter,
adding a close-paren when you type an open-parent, and so on.
Those are perfectly fine -- most of all because they only affect the
code you actually intended to edit, but also because they generally
get things right -- and continue operating as usual.

Fixes: zulip#229
chrisbobbe pushed a commit to zulip/zulip-flutter that referenced this pull request Jul 20, 2023
The details here are largely borrowed from the Flutter repo,
and in particular the subtleties most recently added there:
  flutter/flutter#122758

This config does the job in my testing.

Note that it doesn't affect any of the things the editor does to
simply augment your typing: adding indentation when you hit enter,
adding a close-paren when you type an open-parent, and so on.
Those are perfectly fine -- most of all because they only affect the
code you actually intended to edit, but also because they generally
get things right -- and continue operating as usual.

Fixes: #229
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team Infra upgrades, team productivity, code health, technical debt. See also team: labels.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Disable dart format on save for VSCode contributors
5 participants