command 0.0.6

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 63

command

The Command package provides a Command class to enable generic execute/undo Command Pattern capabilities. The actual actions to be performed are implemented in any custom class that extends the CommandAction interface.

How do I get set up?

To add the published version of this package to your project, create a dependency for command in your pubspec.yaml file:

dependencies:
  command: ^0.0.6

The most recent development version is available on BitBucket. You can access it with the following git dependency:

dependencies:
  command:
    git:
      url: https://bitbucket.org/porcupinesupernova/dart_packages.git
      path: command

A simple usage example:

import 'package:command\command.dart';

class CustomCommandAction extends CommandAction{
  String get key => "CustomAction";
  action(){
    //Custom action code here
  }

  undoAction(){
    //Code to undo the action
  }
}

main(){
  var command = new Command(
    new CustomCommandAction(),
  );

  command.execute();
  command.undo();
}

Submitting issues

Submit issues in the issue tracker

Changelog

0.0.6

  • Child commands now undo before their parent

0.0.4

  • Added the ability to chain commands together

0.0.3

  • Change SDK dependency to remove upper limit

0.0.2

  • Readme and other documentation tweaks

0.0.1

  • Initial version, created by tlarsen

Use this package as a library

1. Depend on it

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


dependencies:
  command: ^0.0.6

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:command/command.dart';
  
Version Uploaded Documentation Archive
0.0.6 Mar 13, 2018 Go to the documentation of command 0.0.6 Download command 0.0.6 archive
0.0.5 Mar 13, 2018 Go to the documentation of command 0.0.5 Download command 0.0.5 archive
0.0.4 Mar 13, 2018 Go to the documentation of command 0.0.4 Download command 0.0.4 archive
0.0.3 Feb 27, 2018 Go to the documentation of command 0.0.3 Download command 0.0.3 archive
0.0.2 Dec 29, 2017 Go to the documentation of command 0.0.2 Download command 0.0.2 archive
0.0.1 Dec 29, 2017 Go to the documentation of command 0.0.1 Download command 0.0.1 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
41
Health:
Code health derived from static analysis. [more]
90
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
63
Learn more about scoring.

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

  • Dart: 2.1.0
  • pana: 0.12.7

Platforms

Detected platforms: Flutter, web, other

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

Health issues and suggestions

Document public APIs (-10 points)

13 out of 13 API elements (library, class, field or method) have no adequate dartdoc content. Good documentation improves code readability and discoverability through search.

Format lib/command.dart.

Run dartfmt to format lib/command.dart.

Maintenance suggestions

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

Package is pre-v0.1 release. (-10 points)

While there is nothing inherently wrong with versions of 0.0.*, it usually means that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.20.1 <3.0.0
Dev dependencies
test ^0.12.0