peanut 1.0.0

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 50

Do you ever want to pub build into another branch? This is your ticket.

Install

$ pub global activate peanut

Run

$ cd ~/my_dart_proj/
$ peanut

This will build your project into a temporary directory, and then it will update the local gh-pages branch with its contents.

Git tricks

The easiest way to push your gh-pages branch to github (without switching from your working branch) is:

$ git push origin --set-upstream gh-pages

To create (or update) your local gh-pages branch to match what's on the server.

$ git update-ref refs/heads/gh-pages origin/gh-pages

This is also useful if you want to undo a peanut run.

Options

$ peanut --help
-d, --directory    (defaults to "web")
-b, --branch       (defaults to "gh-pages")
-m, --message      (defaults to "Built <directory>")
-h, --help

1.0.0

  • Set exit code correctly on errors.

0.1.0

  • Tweak some things.
  • Update readme.

0.0.2

  • Add mode options, to allow pub build to run in debug mode.

0.0.1+2

  • Run pub with runInShell to make things work on Windows.

0.0.1+1

  • Added instructions to README.md.

0.0.1

1. Depend on it

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


dependencies:
  peanut: "^1.0.0"

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 packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:peanut/peanut.dart';
        
Version Uploaded Documentation Archive
1.0.0 Oct 20, 2017 Go to the documentation of peanut 1.0.0 Download peanut 1.0.0 archive
0.1.0 Oct 26, 2016 Go to the documentation of peanut 0.1.0 Download peanut 0.1.0 archive
0.0.2 Jan 15, 2016 Go to the documentation of peanut 0.0.2 Download peanut 0.0.2 archive
0.0.1+2 Jul 29, 2015 Go to the documentation of peanut 0.0.1+2 Download peanut 0.0.1+2 archive
0.0.1+1 Apr 12, 2015 Go to the documentation of peanut 0.0.1+1 Download peanut 0.0.1+1 archive
0.0.1 Apr 8, 2015 Go to the documentation of peanut 0.0.1 Download peanut 0.0.1 archive

Analysis

This feature is new.
We welcome feedback.
More details: scoring.

We analyzed this package, and provided a score, details, and suggestions below.

  • completed on Feb 3, 2018
  • Dart: 2.0.0-dev.20.0
  • pana: 0.10.1

Scores

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

Platforms

Detected platforms: Flutter, other

Primary library: package:peanut/peanut.dart with components: io.

Suggestions

  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Maintain an example.

    None of the files in your example/ directory matches a known example patterns. Common file name patterns include: main.dart, example.dart or you could also use peanut.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.9.0 <2.0.0
args >=0.13.0 <2.0.0 1.3.0
git ^0.4.3 0.4.4+3
path ^1.3.4 1.5.1
Transitive dependencies
bot 0.28.0
when 0.2.0
which 0.1.3