code_buffer 1.0.1

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);
}

You can copy a CodeBuffer into another, heeding indentation rules:

void yetAnotherFunc(CodeBuffer a, CodeBuffer b) {
  b.copyInto(a);
}

1.0.1 #

  • Added CodeBuffer.noWhitespace().

example/main.dart

import 'package:code_buffer/code_buffer.dart';
import 'package:test/test.dart';

/// 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...
  // ignore: unused_local_variable
  var customBuf = new CodeBuffer(newline: '\r\n', space: '\t', trailingNewline: true);

  // Without whitespace..
  // ignore: unused_local_variable
  var minifyingBuf = new CodeBuffer.noWhitespace();

  // 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 yetAnotherOtherFunc(CodeBuffer buf) {
  buf.write('hello');
  expect(buf.lastLine.text, 'hello');

  buf.writeln('world');
  expect(buf.lastLine.lastSpan.start.column, 5);
}

/// You can copy a `CodeBuffer` into another, heeding indentation rules:
void yetEvenAnotherFunc(CodeBuffer a, CodeBuffer b) {
  b.copyInto(a);
}

Use this package as a library

1. Depend on it

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


dependencies:
  code_buffer: ^1.0.1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub 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';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
46
Health:
Code health derived from static analysis. [more]
98
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
77
Overall:
Weighted score of the above. [more]
68
Learn more about scoring.

We analyzed this package on Sep 20, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.0
  • pana: 0.12.21

Platforms

Detected platforms: Flutter, web, other

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

Health suggestions

Fix lib/code_buffer.dart. (-1.99 points)

Analysis of lib/code_buffer.dart reported 4 hints:

line 23 col 18: Use = to separate a named parameter from its default value.

line 24 col 19: Use = to separate a named parameter from its default value.

line 25 col 27: Use = to separate a named parameter from its default value.

line 196 col 55: DO use curly braces for all flow control structures.

Maintenance suggestions

Package is getting outdated. (-22.74 points)

The package was last published 64 weeks ago.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.8.0 <3.0.0
charcode ^1.0.0 1.1.2
source_span ^1.0.0 1.5.5
Transitive dependencies
path 1.6.4
term_glyph 1.1.0
Dev dependencies
test ^0.12.0