command 0.0.6

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

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

  • Dart: 2.4.0
  • pana: 0.12.19

Platforms

Detected platforms: Flutter, web, other

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

Health issues and suggestions

Document public APIs. (-1 points)

15 out of 15 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Fix lib/command.dart. (-1 points)

Analysis of lib/command.dart reported 2 hints:

line 18 col 7: DO use curly braces for all flow control structures.

line 30 col 7: DO use curly braces for all flow control structures.

Maintenance issues and suggestions

Homepage URL doesn't exist. (-20 points)

At the time of the analysis the homepage field https://bitbucket.org/porcupinesupernova/dart_packages/src/master/command/ was unreachable.

Package is getting outdated. (-44.11 points)

The package was last published 75 weeks ago.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and command.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

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

While nothing is inherently wrong with versions of 0.0.*, it might mean 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