Grinder

Dart workflows, automated.

Grinder consists of a library to define project tasks (e.g. test, build, doc), and a command-line tool to run them.

Getting Started

To start using grinder, add it to your dev_dependencies.

Defining Tasks

Tasks are defined entirely by Dart code allowing you to take advantage of the whole Dart ecosystem to write and debug them. Task definitions reside in a tool/grind.dart script. To create a simple grinder script, run:

pub run grinder:init

In general, grinder scripts look something like this:

import 'package:grinder/grinder.dart';

main(args) => grind(args);

@Task('Test stuff.')
test() {
  new PubApp.local('test').run([]);
}

@DefaultTask('Build the project.')
@Depends(test)
build() {
  log("Building...");
}

@Task('Generate docs.')
@Depends(test)
doc() {
  log("Generating docs...");
}

Any task dependencies (see @Depends above), are run before the dependent task.

Grinder contains a variety of convenience APIs for common task definitions, such as PubApp referenced above. See the API Documentation for full details.

Running Tasks

First install the grind executable:

pub global activate grinder

then use it to run desired tasks:

grind test
grind build doc

or to run a default task (see @DefaultTask above):

grind

or to display a list of available tasks and their dependencies:

grind -h

or to tab-complete your tasks (thanks to unscripted):

grind --completion install
. ~/.bashrc

grind [TAB][TAB]
build  test   doc

grind b[TAB]
grind build

You can also bypass installing grind, and instead use pub run grinder:grinder, or in Dart SDK 1.10, simply pub run grinder.

Disclaimer

This is not an official Google product.

grinder.dart changes

0.7.1+3 (2015/5/24)

Fix bug with Dart.run/runAsync. Args were swapped.

0.7.1+2 (2015/5/24)

Add a Dart.runAsync static method.

0.7.1+1 (2015/5/19)

Add a files param to TestRunner.test.

0.7.1 (2015/5/19)

Added grind --completion install command to install tab-completion for task names and options in grind.
Improved grind -h (help) output.
Dart.run now takes an optional vmArgs, a list of arguments passed to the Dart VM.
Added downgrade method do Pub.
Introduce RunOptions to support all Process.run/Process.start parameters. The workingDirectory parameter is now deprecated in all methods, use RunOptions.workingDirectory instead.
Added PubApp.runAsync.
In Dart.run, deprecate the vmNewGenHeapMB and vmOldGenHeapMB options.
Added support for passing lists of files or directories to DartFmt.format().
Analyzer.analyzeFiles is deprecated in favor of Analyzer.analyze.
Added a Pub.global.list() method to list the installed applications.
added a TestRunner class - a wrapper around the new test package.

0.7.0 (2015/4/20)

Big changes! Task definitions are now primarily annotation based; see the readme for more information and an example
The GrinderContext arg is no longer expected in task functions. Instead, the context variable (and the log and fail functions) are available as global variables. They're injected into the zone running the current task.
pub [global] run grinder:grind no longer work, use pub [global] run grinder instead. Add :grinder if using pub run in Dart SDK < 1.10.
copyFile and copyDirectory and deprecated in favor of a new copy method
deleteEntity is deprecated in favor of a new delete method
Renamed runProcess/runProcessAsync/runDartScript to run/runAsync/Dart.run. Process result info (stdout, stderr, exitCode) is now exposed by these methods and some others which call them.
Added a wrapper class around pub global activate/run/pub run applications - PubApp
Grinder can now create a simple starter script for a project - run pub run grinder:init

0.6.5 (2015/1/13)

added defaultInit() and defaultClean() methods, for common tasks
added methods for Pub.global.activate and Pub.global.run
added an optional workingDirectory argument to more methods
added a --version command line flag
have the version command check to see if there's a newer version of grinder available
the dart2js compile tasks now create the output directory if it doesn't exist

0.6.4 (2014/12/18)

clarify that users should put their build scripts in tools/grind.dart
add a getSdkDir method

0.6.2 (2014/11/13)

widen the version constraint on quiver

0.6.1 (2014/10/12)

widen the version constraint on args

0.6.0 (2014/09/22)

The convenience API is now more terse:

the defineTask() method has been renamed to task()
instead of named parameters, the task() function now uses optional positional parameters

Added two new entrypoint files in bin/: grind.dart and grinder.dart. These let you run grinder via:

pub run grinder test

They look for a corresponding grinder script in the tool directory (bin/grind.dart looks for tool/grind.dart and bin/grinder.dart looks for tool/grinder.dart). If they find a corresponding script they run it in a new Dart VM process. This means that projects will no longer have to have a grind.sh script in the root of each project.

PubTool's build methods now take an optional workingDirectory argument.

Removed runSdkBinary and runSdkBinaryAsync, and they are no longer needed. Use runProcess and runProcessAsync instead.

The methods on PubTools and Dart2jsTools are now static - you no longer need to create an instance to use them. Also, PubTools was renamed to Pub and Dart2jsTools was renamed to Dart2js. And a new utility class for dartanalyzer - Analyzer - was created.

0.5.7 (2014/07/28)

added runProcessAsync() and related async methods (such as PubTools.buildAsync(...))
removed duplicated stack traces when the build fails with exceptions
throw an exception when running SDK binaries, and we are not able to locate the Dart SDK

Use this package as an executable

1. Install it

You can install the package from the command line:


$ pub global activate grinder

2. Use it

The package has the following executables:


$ grind

Use this package as a library

1. Depend on it

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


dependencies:
  grinder: ^0.7.1+3

2. Install it

You can install packages from the command line:

with pub:


$ pub get

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

3. Import it

Now in your Dart code, you can use:


import 'package:grinder/grinder.dart';

Version	Uploaded	Documentation	Archive
0.8.3	Jul 20, 2018
0.8.2	May 10, 2018
0.8.1	Dec 19, 2017
0.8.0+3	Oct 16, 2016
0.8.0+2	Jan 27, 2016
0.8.0+1	Nov 13, 2015
0.8.0	Oct 29, 2015
0.7.2	Jul 9, 2015
0.7.1+3	May 24, 2015
0.7.1+2	May 24, 2015

All 46 versions...

Popularity: Describes how popular the package is relative to other packages. [more]	75
Health: Code health derived from static analysis. [more]	--
Maintenance: Reflects how tidy and up-to-date the package is. [more]	--
Overall: Weighted score of the above. [more]	37

Learn more about scoring.

This package version is not analyzed, because it is more than two years old. Check the latest stable version for its analysis.

The package version is not analyzed, because it does not support Dart 2. Until this is resolved, the package will receive a health and maintenance score of 0.

Maintenance issues and suggestions

Running dartdoc failed. (-10 points)

Make sure dartdoc runs without any issues.

Dependencies

Package	Constraint	Resolved	Available
Direct dependencies
Dart SDK	>=1.8.0 <2.0.0

Dart pub

grinder 0.7.1+3