indenting_buffer 1.0.1

  • README.md
  • Installing
  • Versions
  • 35

indenting_buffer

Pub build status

A StringBuffer derivative that supports indentation.

Usage

Example of writing a nicely-formatted function:

main() {  
    var js = new IndentingBuffer()..writeln('function main() {');
    js.indent()
      ..writeln('var x = "Hello, world!";')
      ..writeln('window.alert(x);');
    js.outdent().writeln('}');
    print(js);
}

Output:

function main() {
  var x = "Hello, world!";
  window.alert(x);
}

You can write text that ignores indentation:

direct() => buf.withoutIndentation('<some-text>');

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  indenting_buffer: ^1.0.1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:indenting_buffer/indenting_buffer.dart';
  
Version Uploaded Documentation Archive
1.0.1 Jul 22, 2017 Go to the documentation of indenting_buffer 1.0.1 Download indenting_buffer 1.0.1 archive
1.0.0 Jul 22, 2017 Go to the documentation of indenting_buffer 1.0.0 Download indenting_buffer 1.0.0 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
23
Overall:
Weighted score of the above. [more]
35
Learn more about scoring.

We analyzed this package on Oct 10, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0
  • pana: 0.12.4

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:indenting_buffer/indenting_buffer.dart.

Maintenance issues and suggestions

Maintain CHANGELOG.md. (-20 points)

Changelog entries help clients to follow the progress in your code.

Add SDK constraint in pubspec.yaml. (-5 points)

For information about setting SDK constraint, please see https://www.dartlang.org/tools/pub/pubspec#sdk-constraints.

Package is getting outdated. (-21.64 points)

The package was released 63 weeks ago.

The description is too short. (-20 points)

Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use indenting_buffer.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
charcode >1.0.0 <=2.0.0 1.1.2
Dev dependencies
test >=0.12.0 <0.13.0