Skip to content

Latest commit

 

History

History
221 lines (157 loc) · 6.21 KB

README.md

File metadata and controls

221 lines (157 loc) · 6.21 KB
Raw

English | 中文

This is a fork of the dart_style package that is slightly modified for my own needs. Current changes are:

  • 4 space indentation instead of 2 space one.
  • Removed space between closing bracket and colon in the constructor:
class BN {
    final int a;
    final int b;
    BN({
        required int a,
        required int b,
    }): a = a,  // was })  : a = a ,
        b = b;
}

Inspired by this repository's ideas.

Building your own formatter

  1. Clone this repository
  2. Compile the package.
dart pub get
dart compile exe bin/format.dart -o build/my_dartfmt
  1. Move the executable tp the directory in PATH. I personally use my own ~/bin
mv build/my_dartfmt ~/bin   # any directory in PATH, I use my own `~/bin`

Enable the new formatter in VSCode

  1. Install the Custom Local Formatters extension
  2. Add to VSCode's settings JSON (global, workspace, folder - at your choice):
"dart.enableSdkFormatter": false,
   
"[dart]": {
    // ...
    "editor.defaultFormatter": "jkillian.custom-local-formatters",
    "editor.tabSize": 4,
    // ... 
},

"customLocalFormatters.formatters": [
    {
        "command": "my_dartfmt -l 120",
        "languages": ["dart"]
    }
],

Precautions

This branch only modified the following two files. It is recommended not to use VSCode for modifications to this project, as VSCode's modified code formatting tool will reformat these two files, which may cause merge conflicts when executing the Sync Fork command in the future.

lib/src/constants.dart
lib/src/short/source_visitor.dart

Original README text below...

The dart_style package defines an automatic, opinionated formatter for Dart code. It replaces the whitespace in your program with what it deems to be the best formatting for it. Resulting code should follow the Dart style guide but, moreso, should look nice to most human readers, most of the time.

The formatter handles indentation, inline whitespace, and (by far the most difficult) intelligent line wrapping. It has no problems with nested collections, function expressions, long argument lists, or otherwise tricky code.

The formatter turns code like this:

// BEFORE formatting
if (tag=='style'||tag=='script'&&(type==null||type == TYPE_JS
      ||type==TYPE_DART)||
  tag=='link'&&(rel=='stylesheet'||rel=='import')) {}

into:

// AFTER formatting
if (tag == 'style' ||
  tag == 'script' &&
      (type == null || type == TYPE_JS || type == TYPE_DART) ||
  tag == 'link' && (rel == 'stylesheet' || rel == 'import')) {}

The formatter will never break your code—you can safely invoke it automatically from build and presubmit scripts.

Style fixes

The formatter can also apply non-whitespace changes to make your code consistently idiomatic. You must opt into these by passing either --fix which applies all style fixes, or any of the --fix--prefixed flags to apply specific fixes.

For example, running with --fix-named-default-separator changes this:

greet(String name, {String title: "Captain"}) {
  print("Greetings, $title $name!");
}

into:

greet(String name, {String title = "Captain"}) {
  print("Greetings, $title $name!");
}

Using the formatter

The formatter is part of the unified dart developer tool included in the Dart SDK, so most users get it directly from there. That has the latest version of the formatter that was available when the SDK was released.

IDEs and editors that support Dart usually provide easy ways to run the formatter. For example, in WebStorm you can right-click a .dart file and then choose Reformat with Dart Style.

Here's a simple example of using the formatter on the command line:

$ dart format test.dart

This command formats the test.dart file and writes the result to the file.

dart format takes a list of paths, which can point to directories or files. If the path is a directory, it processes every .dart file in that directory or any of its subdirectories.

By default, it formats each file and write the formatting changes to the files. If you pass --output show, it prints the formatted code to stdout.

You may pass a -l option to control the width of the page that it wraps lines to fit within, but you're strongly encouraged to keep the default line length of 80 columns.

Validating files

If you want to use the formatter in something like a presubmit script or commit hook, you can pass flags to omit writing formatting changes to disk and to update the exit code to indicate success/failure:

$ dart format --output=none --set-exit-if-changed .

Running other versions of the formatter CLI command

If you need to run a different version of the formatter, you can globally activate the package from the dart_style package on pub.dev:

$ pub global activate dart_style
$ pub global run dart_style:format ...

Using the dart_style API

The package also exposes a single dart_style library containing a programmatic API for formatting code. Simple usage looks like this:

import 'package:dart_style/dart_style.dart';

main() {
  final formatter = DartFormatter();

  try {
    print(formatter.format("""
    library an_entire_compilation_unit;

    class SomeClass {}
    """));

    print(formatter.formatStatement("aSingle(statement);"));
  } on FormatterException catch (ex) {
    print(ex);
  }
}

Other resources

  • Before sending an email, see if you are asking a frequently asked question.

  • Before filing a bug, or if you want to understand how work on the formatter is managed, see how we track issues.