Скачать или смотреть How to Stop Visual Studio Code from Automatically Reformatting Your Dart Code

Discover how to prevent Visual Studio Code from automatically reformatting your Dart code files by adjusting your settings.json file.
---
This video is based on the question https://stackoverflow.com/q/62906192/ asked by the user 'dak' ( https://stackoverflow.com/u/1074660/ ) and on the answer https://stackoverflow.com/a/62906877/ provided by the user 'Georgy' ( https://stackoverflow.com/u/4753661/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: vs code 1.47.1 automatically reformatting dart code files

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Understanding the Problem: Automatic Code Reformatting in VS Code

Many developers who use Visual Studio Code (VS Code) enjoy its powerful features and user-friendly interface. However, sometimes it can inadvertently cause frustrations, especially when it comes to automatic code reformatting. A recent issue arose with a user facing this very problem after agreeing to a VS Code prompt for a settings change. Upon editing Dart code, they noticed that the code was automatically reformatted in a way that led to larger modifications— including changing whitespace and inserting additional lines of code.

If you find yourself in a similar predicament, where your well-structured code has turned into a complicated mess, don't worry! There is a straightforward solution to regain control of your formatting preferences.

Identifying the Culprit: settings.json

First, let's talk about the settings.json file. This file contains various user-defined settings for VS Code, including how your code should be formatted. Because modifications are made here, the first step is to locate the settings.json file and review its contents for any changes that might be causing automatic reformatting.

To open your settings.json file:

Open VS Code.

Navigate to File Preferences Settings.

Click on the icon to open the JSON view (usually an icon with {} or a similar notation).

Recognizing the Problematic Settings

In the context of Dart development, two specific settings are most likely responsible for the unexpected automatic formatting:

editor.formatOnSave

editor.formatOnType

Here's an excerpt of the relevant sections from a typical settings.json file:

[[See Video to Reveal this Text or Code Snippet]]

When both of these settings are enabled, VS Code will automatically reformat your Dart code each time you save or type—leading to possible unwanted changes as described.

Steps to Revert the Formatting Behavior

Now that we've identified the source of the issue, here’s how you can revert the formatting behavior to suit your personal preferences:

In your settings.json file, locate the Dart configuration section where you see the formatting settings.

Change the values for editor.formatOnSave and editor.formatOnType to false:

[[See Video to Reveal this Text or Code Snippet]]

By setting these values to false, you will stop VS Code from automatically reformatting your Dart files each time they are saved or when you are typing.

Optional Adjustments

Depending on your preferences for code consistency and cleanliness:

If you still want help with formatting, consider using a code linter or formatter manually instead of automatic options.

You can choose to keep one setting enabled while disabling the other based on your workflow.

Conclusion

Automatic formatting can be a double-edged sword, especially for those who have specific coding styles. By altering your settings.json file in Visual Studio Code and toggling the editor.formatOnSave and editor.formatOnType settings, you can regain control over how your Dart code is formatted.

Now you can code with confidence, knowing that your styles and structures will remain intact until you decide to update them!

If you have other questions or face further issues with VS Code or Dart, feel free to ask. Happy coding!