flutter-stylizer installs statistics

flutter-stylizer README

Flutter Stylizer is a VSCode extension that organizes your Flutter classes in an opinionated and consistent manner.

Note that as of release 0.1.1, there is now a standalone version of flutter-stylizer (with identical output to this plugin) that is available here:

• https://github.com/gmlewis/go-flutter-stylizer

Features

Flutter Stylizer organizes the class(es) within a *.dart file in the following manner (with a blank line separating these parts):

• The main (possibly factory) constructor is listed first, if it exists.
  • (public-constructor in configuration)
• Any named constructors are listed next, in sorted order.
  • (named-constructors in configuration)
• Any static (class) variables are listed next, in sorted order.
  • (public-static-variables in configuration)
• Any instance variables are listed next, in sorted order. (As of version v0.1.8, a new option flag affects this section; see below.)
  • (public-instance-variables in configuration)
• Any @override variables are listed next, in sorted order.
  • (public-override-variables in configuration)
• Any private static (class) variables are listed next, in sorted order.
  • (private-static-variables in configuration)
• Any private instance variables are listed next, in sorted order.
  • (private-instance-variables in configuration)
• Any @override methods are listed next, in sorted order.
  • (public-override-methods in configuration)
• Any other methods are listed next in their original (unchanged) order. (As of version v0.0.19, two new option flags affect this section; see below.)
  • (public-other-methods in configuration)
• If private-other-methods is (optionally) specified, these will be sorted separately from public-other-methods.
• The build method is listed last.
  • (build-method in configuration)

I have found that developer productivity increases when all code in large projects follows a consistent and opinionated style.

Additionally, bringing new developers into a team with a large code base is easier when the code is consistently written and therefore easier to navigate and understand.

Without tooling to enforce a consistent style, developing code is less fun. Having an automated tool to do this ugly work for you, however, makes coding a lot more enjoyable, as you don't have to worry about the rules, but can just run the plugin on file save, and the rules are automatically enforced. Note that this plugin doesn't natively support format-on-save, but you could use another extension... possibly something like this: https://marketplace.visualstudio.com/items?itemName=emeraldwalk.RunOnSave or you could use the stand-alone [Go flutter-stylizer] in your GitHub Actions or CI pipeline to perform this action for you.

Configuration

To override the default order of the stylizer, add a section to your VSCode User Preferences (Control/Cmd-,) like this:

  "flutterStylizer": {
    "groupAndSortGetterMethods": false,
    "groupAndSortVariableTypes": false,
    "memberOrdering": [
      "public-constructor",
      "named-constructors",
      "public-static-variables",
      "public-instance-variables",
      "public-override-variables",
      "private-static-variables",
      "private-instance-variables",
      "public-override-methods",
      "public-other-methods",
      "private-other-methods",
      "build-method",
    ],
    "processEnumsLikeClasses": false,
    "sortClassesWithinFile": false,
    "sortOtherMethods": false,
  }

And then rearrange member names as desired.

Other option flags

Note that as of v0.0.19, two new option flags were added to modify the behavior of the "public-other-methods" as requested in #18:

• groupAndSortGetterMethods (default: false)

  • Whether to group getters separately (before 'public-other-methods') and sort them within their group.

• sortOtherMethods (default: false)

  • Whether to sort the 'public-other-methods' within their group.

As of v0.1.5, a new private-other-methods field was added. If not specified, private methods will continue to be grouped within the public-other-methods section.

As of v0.1.8, a new option flag was added:

• groupAndSortVariableTypes (default: false)
  • Whether to group public variables separately by type and sort them within their groups. Types are: "final", "optional" (?), and "normal".

As of v0.1.12, a new option flag was added:

• sortClassesWithinFile (default: false)
  • Whether to sort multiple classes within each file.

As of v0.1.15, a new option flag was added:

• processEnumsLikeClasses (default: false)
  • Whether to process enums identically to how classes are processed.

These features are experimental and should be used with caution. Please file any bugs you find on the [GitHub issue tracker].

Run Flutter Stylizer on all files - Option 1

If you want a super-fast way to process all files in a very large project, and aren't averse to the command-line terminal (:smile:) please remember to check out the stand-alone command-line companion tool: https://github.com/gmlewis/go-flutter-stylizer

Run Flutter Stylizer on all files - Option 2

If you install the Command on All Files VSCode extension, you can then run the Flutter Stylizer on all files within your project.

To do so, edit your VSCode settings.json file and add this section:…