ghooks 0.0.1

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • new50

dart ghooks

A library to easily use git hooks from Dart

Install

To start using ghooks, add it to your dev_dependencies and run pub get

To install hooks in your project, run:

$ pub run ghooks install
    

Add your hook to pubspec.yaml

Example:

    ghooks:
        pre-commit: ./lint.sh && ./test.sh

Install options

Option/Flagabbreviationdescription
--precommit-samplenoneIf flag is passed it will create a sample pre commit Dart script. Defaults to false
--hook <hook-name>-kCreates a bash script for the hook passed, supports passing multiple hooks. Defaults to all scripts. Example: -k pre-commit -k commit-msg

Remove

To remove all hooks in your project, run:

$ pub run ghooks remove

Or if you want to remove a specific hook:

$ pub run ghooks remove -k pre-commit -k commit-msg

Git Hooks

Git hooks are scripts that run automatically every time a particular event occurs in a Git repository. ghooks supports all git hooks (https://git-scm.com/docs/githooks)

Features and bugs

Please file feature requests and bugs at the issue tracker.

Changelog

0.0.1

  • Rework Hanzo to use sh inside pubspec.yaml

Use this package as a library

1. Depend on it

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


dependencies:
  ghooks: "^0.0.1"

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:ghooks/ghooks.dart';
  
Version Uploaded Documentation Archive
0.0.1 Jun 13, 2018 Go to the documentation of ghooks 0.0.1 Download ghooks 0.0.1 archive

Analysis

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

  • Dart: 2.0.0-dev.63.0
  • pana: 0.11.3

Scores

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

Platforms

Detected platforms: Flutter, other

Primary library: package:ghooks/ghooks.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.

  • Package is pre-v1 release.

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

  • Maintain an example.

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

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 1 hint.

    Run dartfmt to format lib/ghooks.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.20.1 <2.0.0
args ^0.13.7 0.13.7 1.4.3
command_wrapper ^0.2.0 0.2.0
Transitive dependencies
path 1.6.1
when 0.2.0
which 0.1.3
Dev dependencies
grinder ^0.8.0+3
test ^0.12.0