NAME

Text::Safer - Convert text with one of several available methods, usually to a safer/more restricted encoding, e.g. for filenames

VERSION

This document describes version 0.003 of Text::Safer (from Perl distribution Text-Safer), released on 2025-06-14.

SYNOPSIS

use Text::Safer qw(encode_safer);

my $safer1 = encode_safer("Foo bar. baz!!!");                       # "foo-bar-baz", default encoding is "alphanum_kebab_nodashend_lc"
my $safer2 = encode_safer("Foo bar!!!", "alphanum_snake");          # "Foo_bar_"
my $safer3 = encode_safer("Foo bar!!!", "alphanum_snake", {lc=>1}); # "foo_bar_"

DESCRIPTION

FUNCTIONS

encode_safer

Usage:

my $result = encode_safer($text [ , $encoding [ , \%encoding_args ] ]);

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Text-Safer.

SOURCE

Source repository is at https://github.com/perlancar/perl-Text-Safer.

SEE ALSO

CLI interface: safer from App::safer.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2025 by perlancar <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.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Text-Safer

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.