1Shipwright::Util(3)   User Contributed Perl Documentation  Shipwright::Util(3)
2
3
4

LIST

6   General Helpers
7       load_yaml, load_yaml_file, dump_yaml, dump_yaml_file
8
9       they are just dropped in from YAML::Tiny
10
11       confess_or_die
12
13       parent_dir
14
15       return the dir's parent dir, the arg must be a dir path
16
17       run_cmd
18
19       a wrapper of run3 sub in IPC::Run3.
20
21       select_fh
22
23       wrapper for the select in core
24
25       find_module
26
27       Takes perl modules name space and name of a module in the space.  Finds
28       and returns matching module name using case insensitive search, for
29       example:
30
31           find_module('Shipwright::Backend', 'svn');
32           # returns 'Shipwright::Backend::SVN'
33
34           find_module('Shipwright::Backend', 'git');
35           # returns 'Shipwright::Backend::Git'
36
37       Returns undef if there is no module matching criteria.
38
39   PATHS
40       shipwright_root
41
42       Returns the root directory that Shipwright has been installed into.
43       Uses %INC to figure out where Shipwright.pm is.
44
45       share_root
46
47       Returns the 'share' directory of the installed Shipwright module. This
48       is currently only used to store the initial files in project.
49
50       user_home
51
52       return current user's home directory
53
54       shipwright_user_root
55
56       the user's own shipwright root where we put internal files in.  it's
57       ~/.shipwright by default.  it can be overwritten by
58       $ENV{SHIPWRIGHT_USER_ROOT}
59

NAME

61       Shipwright::Util - Util
62

AUTHOR

64       sunnavy  "<sunnavy@bestpractical.com>"
65

67       Copyright 2007-2015 Best Practical Solutions.
68
69       This program is free software; you can redistribute it and/or modify it
70       under the same terms as Perl itself.
71
72
73
74perl v5.34.0                      2022-01-21               Shipwright::Util(3)
Impressum