Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samcv/perl6-git-log
Gets git-log as a Perl 6 object
https://github.com/samcv/perl6-git-log
git git-log log perl6
Last synced: 2 months ago
JSON representation
Gets git-log as a Perl 6 object
- Host: GitHub
- URL: https://github.com/samcv/perl6-git-log
- Owner: samcv
- License: artistic-2.0
- Created: 2018-08-24T16:00:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-20T13:34:04.000Z (about 6 years ago)
- Last Synced: 2024-10-11T21:40:48.097Z (3 months ago)
- Topics: git, git-log, log, perl6
- Language: Perl 6
- Homepage:
- Size: 29.3 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
NAME
====Git::Log
AUTHOR
======Samantha McVey (samcv)
SYNOPSIS
========Gets the git log as a Perl 6 object
DESCRIPTION
===========The first argument is the command line args wanted to be passed into `git log`. Optionally you can also get the files changes as well as the number of lines added or deleted.
Returns an array of hashes in the following format: `ID => "df0c229ad6ba293c67724379bcd3d55af6ea47a0", AuthorName => "Author's Name", AuthorEmail => "[email protected]" ...` If the option :get-changes is used (off by default) it will also add a 'changes' key in the following format: `changes => { $[ { filename => 'myfile.txt', added => 10, deleted => 5 }, ... ] }`
If there is a field that you need that is not offered, then you can supply an array, :@fields. Format is an array of pairs: `ID => '%H', AuthorName => '%an' ...` you can look for more [here](https://git-scm.com/docs/pretty-formats).
These are the default fields:
```perl6
my @fields-default =
'ID' => '%H',
'AuthorName' => '%an',
'AuthorEmail' => '%ae',
'AuthorDate' => '%aI',
'Subject' => '%s',
'Body' => '%b'
;
```EXAMPLES
========```perl6
# Gets the git log for the specified repository, from versions 2018.06 to master
git-log(:path($path.IO), '2018.06..master')
# Gets the git log for the current directory, and does I get the files
# changed in that commit
git-log(:!get-changes)
```LICENSE
=======This is free software; you can redistribute it and/or modify it under the Artistic License 2.0.
### sub git-log
```perl6
sub git-log(
*@args,
:@fields = { ... },
IO::Path :$path,
Bool:D :$get-changes = Bool::False,
Bool:D :$date-time = Bool::False
) returns Mu
```git-log's first argument is an array that is passed to C and optionally you can provide a path so a directory other than the current are used.