The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

PERLANCAR / App-FileModifyUtils-0.002 / README 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

              
NAME
    App::FileModifyUtils - Utilities related to modifying files
VERSION
    This document describes version 0.002 of App::FileModifyUtils (from Perl
    distribution App-FileModifyUtils), released on 2021-08-02.
DESCRIPTION
    This distribution provides the following command-line utilities:
    *   add-line-to-file
    *   remove-line-from-file
FUNCTIONS
  add_line_to_file
    Usage:
     add_line_to_file(%args) -> [$status_code, $reason, $payload, \%result_meta]
    Add line to file.
    Uses Setup::File::Line which supports undo, but the undo feature is not
    used. See App::FileModifyUtils::Undoable for file-modifying CLIs which
    support undo.
    This function is not exported by default, but exportable.
    Arguments ('*' denotes required arguments):
    *   file* => *filename*
    *   line* => *str*
    *   top_style => *bool*
    Returns an enveloped result (an array).
    First element ($status_code) is an integer containing HTTP-like status
    code (200 means OK, 4xx caller error, 5xx function error). Second
    element ($reason) is a string containing error message, or something
    like "OK" if status is 200. Third element ($payload) is the actual
    result, but usually not present when enveloped result is an error
    response ($status_code is not 2xx). Fourth element (%result_meta) is
    called result metadata and is optional, a hash that contains extra
    information, much like how HTTP response headers provide additional
    metadata.
    Return value: (any)
  remove_line_from_file
    Usage:
     remove_line_from_file(%args) -> [$status_code, $reason, $payload, \%result_meta]
    Remove all occurrences of a line from file.
    Uses Setup::File::Line which supports undo, but the undo feature is not
    used. See App::FileModifyUtils::Undoable for file-modifying CLIs which
    support undo.
    This function is not exported by default, but exportable.
    Arguments ('*' denotes required arguments):
    *   case_insensitive => *bool*
    *   file* => *filename*
    *   line* => *str*
    Returns an enveloped result (an array).
    First element ($status_code) is an integer containing HTTP-like status
    code (200 means OK, 4xx caller error, 5xx function error). Second
    element ($reason) is a string containing error message, or something
    like "OK" if status is 200. Third element ($payload) is the actual
    result, but usually not present when enveloped result is an error
    response ($status_code is not 2xx). Fourth element (%result_meta) is
    called result metadata and is optional, a hash that contains extra
    information, much like how HTTP response headers provide additional
    metadata.
    Return value: (any)
HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/App-FileModifyUtils>.
SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-App-FileModifyUtils>.
BUGS
    Please report any bugs or feature requests on the bugtracker website
    <https://rt.cpan.org/Public/Dist/Display.html?Name=App-FileModifyUtils>
    When submitting a bug or request, please include a test-file or a patch
    to an existing test-file that illustrates the bug or desired feature.
SEE ALSO
    Other similar distributions: App::FileRenameUtils,
    App::FileRemoveUtilities.
AUTHOR
    perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
    This software is copyright (c) 2021 by perlancar@cpan.org.
    This is free software; you can redistribute it and/or modify it under
    the same terms as the Perl 5 programming language system itself.