code_buffer 1.0.0

  • README.md
  • Installing
  • Versions
  • 65

code_buffer

Pub build status

An advanced StringBuffer geared toward generating code, and source maps.

Installation

In your pubspec.yaml:

dependencies:
  code_buffer: ^1.0.0

Usage

Use a CodeBuffer just like any regular StringBuffer:

String someFunc() {
    var buf = new CodeBuffer();
    buf
      ..write('hello ')
      ..writeln('world!');
    return buf.toString();
}

However, a CodeBuffer supports indentation.

void someOtherFunc() {
  var buf = new CodeBuffer();
  // Custom options...
  var buf = new CodeBuffer(newline: '\r\n', space: '\t', trailingNewline: true);
  
  // Any following lines will have an incremented indentation level...
  buf.indent();
  
  // And vice-versa:
  buf.outdent();
}

CodeBuffer instances keep track of every SourceSpan they create. This makes them useful for codegen tools, or to-JS compilers.

void someFunc(CodeBuffer buf) {
  buf.write('hello');
  expect(buf.lastLine.text, 'hello');
  
  buf.writeln('world');
  expect(buf.lastLine.lastSpan.start.column, 5);
}

1. Depend on it

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


dependencies:
  code_buffer: "^1.0.0"

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 packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:code_buffer/code_buffer.dart';
        
Version Uploaded Documentation Archive
1.0.0 Sep 21, 2017 Go to the documentation of code_buffer 1.0.0 Download code_buffer 1.0.0 archive

Analysis

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

  • Dart: 2.0.0-dev.49.0
  • pana: 0.10.6

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
39 / 100
Health:
Code health derived from static analysis. [more]
99 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80 / 100
Overall score:
Weighted score of the above. [more]
65
Learn more about scoring.

Platforms

Detected platforms: Flutter, web, other

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

Suggestions

  • Maintain CHANGELOG.md.

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

  • Maintain an example.

    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 code_buffer.dart.

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 1 hint.

    Run dartfmt to format lib/code_buffer.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.8.0
charcode ^1.0.0 1.1.1
source_span ^1.0.0 1.4.0
Transitive dependencies
path 1.5.1
Dev dependencies
test ^0.12.0