Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 1.92 KB

formatting.md

File metadata and controls

60 lines (43 loc) · 1.92 KB
title description
Code formatting
Flutter's code formatter formats your code following recommended style guidelines.

While your code might follow any preferred style—in our experience—teams of developers might find it more productive to:

  • Have a single, shared style, and
  • Enforce this style through automatic formatting.

The alternative is often tiring formatting debates during code reviews, where time might be better spent on code behavior rather than code style.

Automatically formatting code in VS Code

Install the Flutter extension (see Editor setup) to get automatic formatting of code in VS Code.

To automatically format the code in the current source code window, right-click in the code window and select Format Document. You can add a keyboard shortcut to this VS Code Preferences.

To automatically format code whenever you save a file, set the editor.formatOnSave setting to true.

Automatically formatting code in Android Studio and IntelliJ

Install the Dart plugin (see Editor setup) to get automatic formatting of code in Android Studio and IntelliJ. To format your code in the current source code window:

  • In macOS, press Cmd + Option + L.
  • In Windows and Linux, press Ctrl + Alt + L.

Android Studio and IntelliJ also provide a checkbox named Format code on save on the Flutter page in Preferences on macOS or Settings on Windows and Linux. This option corrects formatting in the current file when you save it.

Automatically formatting code with the dart command

To correct code formatting in the command line interface (CLI), run the dart format command:

$ dart format path1 path2 [...]

To learn more about the Dart formatter, check out the dart.dev docs on dart format.