1Parse::Gitignore(3)   User Contributed Perl Documentation  Parse::Gitignore(3)
2
3
4

NAME

6       Parse::Gitignore - parse .gitignore files
7

SYNOPSIS

9       produces output
10
11       (This example is included as synopsis.pl
12       <https://fastapi.metacpan.org/source/BKB/Parse-
13       Gitignore-0.04/examples/synopsis.pl> in the distribution.)
14

VERSION

16       This documents Parse::Gitignore version 0.04 corresponding to git
17       commit eef29c685b26d8cd9b28ff74e5e2388e751fd23e
18       <https://github.com/benkasminbullock/parse-
19       gitignore/commit/eef29c685b26d8cd9b28ff74e5e2388e751fd23e> released on
20       Mon Oct 9 14:00:13 2017 +0900.
21

DESCRIPTION

23       Parse a .gitignore file and check whether a file matches it.
24

METHODS

26   new
27           my $pg = Parse::Gitignore->new ('./.gitignore');
28
29   ignored
30           if ($pg->ignored ('./Makefile')) {
31               print "Makefile is ignored.\n";
32           }
33
34       Check whether a file matches a .gitignore.
35
36   read_gitignore
37           $pg->read_gitignore ('.gitignore');
38
39       Read a .gitignore file. You can read as many as you like and they are
40       accumulated.
41
42   excludesfile
43           $pg->excludesfile ('/home/user/.gitignore');
44
45       Read an excludesfile which is applied to all directories where .git is
46       found.
47

DEPENDENCIES

49       Path::Tiny
50

HISTORY

52       I wrote this because I wanted to have a way to ignore generated files
53       for a desktop file search application.
54

AUTHOR

56       Ben Bullock, <bkb@cpan.org>
57

59       This package and associated files are copyright (C) 2016-2017 Ben
60       Bullock.
61
62       You can use, copy, modify and redistribute this package and associated
63       files under the Perl Artistic Licence or the GNU General Public
64       Licence.
65
66
67
68perl v5.34.0                      2022-01-21               Parse::Gitignore(3)
Impressum