Coverage report for lib/src/formatter_options.dart

// Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file

// for details. All rights reserved. Use of this source code is governed by a

// BSD-style license that can be found in the LICENSE file.

library dart_style.src.formatter_options;

import 'dart:convert';

import 'dart:io';

import 'source_code.dart';

import 'style_fix.dart';

/// Global options that affect how the formatter produces and uses its outputs.

class FormatterOptions {

  /// The [OutputReporter] used to show the formatting results.

  final OutputReporter reporter;

  /// The number of spaces of indentation to prefix the output with.

  final int indent;

  /// The number of columns that formatted output should be constrained to fit

  /// within.

  final int pageWidth;

  /// Whether symlinks should be traversed when formatting a directory.

  final bool followLinks;

  /// The style fixes to apply while formatting.

  final Iterable<StyleFix> fixes;

      {this.indent: 0,

      this.pageWidth: 80,

      this.followLinks: false,

      this.fixes});

}

/// How the formatter reports the results it produces.

abstract class OutputReporter {

  /// Prints only the names of files whose contents are different from their

  /// formatted version.

  static final OutputReporter dryRun = new _DryRunReporter();

  /// Prints the formatted results of each file to stdout.

  static final OutputReporter print = new _PrintReporter();

  /// Prints the formatted result and selection info of each file to stdout as

  /// a JSON map.

  static final OutputReporter printJson = new _PrintJsonReporter();

  /// Overwrites each file with its formatted result.

  static final OutputReporter overwrite = new _OverwriteReporter();

  /// Describe the directory whose contents are about to be processed.

  /// Describe the symlink at [path] that wasn't followed.

  /// Describe the hidden [path] that wasn't processed.

  /// Called when [file] is about to be formatted.

  /// Describe the processed file at [path] whose formatted result is [output].

  ///

  /// If the contents of the file are the same as the formatted output,

  /// [changed] will be false.

  void afterFile(File file, String label, SourceCode output, {bool changed});

}

/// Prints only the names of files whose contents are different from their

/// formatted version.

class _DryRunReporter extends OutputReporter {

    // Only show the changed files.

  }

}

/// Prints the formatted results of each file to stdout.

class _PrintReporter extends OutputReporter {

  }

  }

  }

    // Don't add an extra newline.

  }

}

/// Prints the formatted result and selection info of each file to stdout as a

/// JSON map.

class _PrintJsonReporter extends OutputReporter {

    // TODO(rnystrom): Put an empty selection in here to remain compatible with

    // the old formatter. Since there's no way to pass a selection on the

    // command line, this will never be used, which is why it's hard-coded to

    // -1, -1. If we add support for passing in a selection, put the real

    // result here.

      "path": label,

      }

    }));

  }

}

/// Overwrites each file with its formatted result.

class _OverwriteReporter extends _PrintReporter {

    if (changed) {

      try {

      }

    } else {

    }

  }

}

/// Base clase for a reporter that decorates an inner reporter.

abstract class _ReporterDecorator implements OutputReporter {

  final OutputReporter _inner;

  }

  }

  }

  }

  }

}

/// A decorating reporter that reports how long it took for format each file.

class ProfileReporter extends _ReporterDecorator {

  /// The files that have been started but have not completed yet.

  ///

  /// Maps a file label to the time that it started being formatted.

  final Map<String, DateTime> _ongoing = {};

  /// The elapsed time it took to format each completed file.

  final Map<String, Duration> _elapsed = {};

  /// The number of files that completed so fast that they aren't worth

  /// tracking.

  int _elided = 0;

  /// Show the times for the slowest files to format.

    // Everything should be done.

    }

    }

  }

  /// Called when [file] is about to be formatted.

  }

  /// Describe the processed file at [path] whose formatted result is [output].

  ///

  /// If the contents of the file are the same as the formatted output,

  /// [changed] will be false.

    } else {

    }

  }

}

/// A decorating reporter that sets the exit code to 1 if any changes are made.

class SetExitReporter extends _ReporterDecorator {

  /// Describe the processed file at [path] whose formatted result is [output].

  ///

  /// If the contents of the file are the same as the formatted output,

  /// [changed] will be false.

  }

}