bwu_grinder_tasks 0.1.0

  • Readme
  • Changelog
  • Installing
  • 0

BWU Grinder Tasks #

Star this Repo Pub Package Build Status Coverage Status

A set of common reusable Grinder tasks.

Usage #

Simplest case #

Add a dependency to the packages grinder and bwu_grinder_tasks to your dependencies in pubspec.yaml and add the file tool/grind.dart with the following content to your project:

export 'package:bwu_grinder_tasks/bwu_grinder_tasks.dart';

Then you can run it from your project root directory with

# or
grind check
# or
grind format
# ...

Customize (hide tasks) #

If you just want to use a few of the tasks but not all you can hide tasks you don't want to use and also add your own tasks. The following example suppresses browser tests. If you want to customize the tasks, you always need to implement your own main() method (and hide the provided main()).

library bwu_dart_archive_downloader.tool.grind;

export 'package:bwu_utils_dev/grinder/default_tasks.dart' hide main, lint, check, 
import 'package:bwu_utils_dev/grinder/default_tasks.dart' show grind;

main(List<String> args) {

@Task('some task')
some() => print('did something');

What doesn't work is to hide a task which is a dependency for another task. You also need to hide the task which depends on the task you want to hide. In the example above we hide the lint task and also need to hide check and travis which depend on lint.

Customize (provide custom implementation) #

Instead of hiding and reimplementing a task you can just assign a custom implementation to a task.

The provided tasks are split in three parts.

  • The delaration with the @Task(), @DefaultTask and @Depends() annotation,
  • A variable which is referenced by a task and itself references the implementation of the task.
  • The implementation of a task
@Task('Run lint checks')
lint() => lintTask();
Function lintTask = lintTaskImpl;
lintTaskImpl() => new'linter')
    .run(['--stats', '-ctool/lintcfg.yaml']..addAll(existingSourceDirs));

If you want to change or extend the behavior of the lint task you can do this like:

library bwu_dart_archive_downloader.tool.grind;

export 'package:bwu_utils_dev/grinder/default_tasks.dart' hide main;
import 'package:bwu_utils_dev/grinder/default_tasks.dart'
    show grind, lintTask, lintTaskImpl;

main(List<String> args) {
  lintTask = () {
    print('before linting');
    print('after linting');

Changelog #

0.1.0 #

  • move Grinder tasks from bwu_utils_dev
  • remove direct dependency on bwu_archive_downloader and use pub global run instead.

Use this package as a library

1. Depend on it

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

  bwu_grinder_tasks: ^0.1.0

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:bwu_grinder_tasks/bwu_grinder_tasks.dart';
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

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.

Analysis issues and suggestions

Support Dart 2 in pubspec.yaml.

The SDK constraint in pubspec.yaml doesn't allow the Dart 2.0.0 release. For information about upgrading it to be Dart 2 compatible, please see


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