Setup::File::TextFragment - Insert/delete text fragment in a file (with undo support)
This document describes version 0.070 of Setup::File::TextFragment (from Perl distribution Setup-File-TextFragment), released on 2021-08-02.
Steven Haryanto <sharyanto@cpan.org>
Usage:
setup_text_fragment(%args) -> [$status_code, $reason, $payload, \%result_meta]
Insert/delete text fragment in a file (with undo support).
On do, will insert fragment to file (or delete, if should_exist is set to false). On undo, will restore old file.
should_exist
Unfixable state: file does not exist or not a regular file (directory and symlink included).
Fixed state: file exists, fragment already exists and with the same content (if should_exist is true) or fragment already does not exist (if should_exist is false).
Fixable state: file exists, fragment doesn't exist or payload is not the same (if should_exist is true) or fragment still exists (if should_exist is false).
This function is not exported by default, but exportable.
This function is idempotent (repeated invocations with same arguments has the same effect as single invocation). This function supports transactions.
Arguments ('*' denotes required arguments):
attrs => hash
Fragment attributes (only for inserting new fragment), passed to Text::Fragment.
comment_style => bool
Will be passed to Text::Fragment.
good_pattern => str
id* => str
Fragment ID.
label => str
path* => str
Path to file.
payload* => str
Fragment content.
replace_pattern => str
should_exist => bool (default: 1)
Whether fragment should exist.
top_style => bool
Special arguments:
-tx_action => str
For more information on transaction, see L<Rinci::Transaction>.
-tx_action_id => str
-tx_recovery => str
-tx_rollback => str
-tx_v => 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)
Please visit the project's homepage at https://metacpan.org/release/Setup-File-TextFragment.
Source repository is at https://github.com/perlancar/perl-Setup-File-TextFragment.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Setup-File-TextFragment
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.
A more general version of this: Setup::File::Edit.
A variation that adds/removes line to file: Setup::File::Line.
Backend for this module: Text::Fragment
The Setup framework: Setup
perlancar <perlancar@cpan.org>
This software is copyright (c) 2021, 2017, 2015, 2014, 2013, 2012 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.
To install Setup::File::TextFragment, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Setup::File::TextFragment
CPAN shell
perl -MCPAN -e shell install Setup::File::TextFragment
For more information on module installation, please visit the detailed CPAN module installation guide.