Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robrwo/text-minify-xs
Simple text minification
https://github.com/robrwo/text-minify-xs
perl5 text-minification
Last synced: 11 days ago
JSON representation
Simple text minification
- Host: GitHub
- URL: https://github.com/robrwo/text-minify-xs
- Owner: robrwo
- Created: 2020-12-09T13:21:20.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-10T12:27:14.000Z (7 months ago)
- Last Synced: 2024-10-11T21:56:26.990Z (about 1 month ago)
- Topics: perl5, text-minification
- Language: Perl
- Homepage: https://metacpan.org/release/Text-Minify-XS
- Size: 439 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: Changes
Awesome Lists containing this project
README
# NAME
Text::Minify::XS - Remove indentation and trailing whitespace from multi-line text
# VERSION
version v0.7.5
# SYNOPSIS
```perl
use Text::Minify::XS qw/ minify /;
my $out = minify( $in );
```
# DESCRIPTION
This is a simple and fast text minifier that quickly removes extra
whitespace from multi-line text.
# EXPORTS
None by default.
## minify
```perl
my $out = minify( $in );
```
This is a quick-and-dirty text minifier that removes indentation and
trailing whitespace from a multi-line text document in a single pass.
It does the following:
- removes leading whitespace (indentation),
- removes trailing whitespace,
- collapses multiple newlines,
- and changes carriage returns to newlines.
It does not recognise any form of markup, comments or text quoting.
Nor does it remove extra whitespace in the middle of the line.
Because it does not recognise any markup, newlines are not removed
since they may be significant.
## minify\_utf8
This is an alias for ["minify"](#minify). It was added in v0.5.3.
## minify\_ascii
This is a version of ["minify"](#minify) that works on ASCII text. It was added in v0.5.3.
If you are only processing 8-bit text, then it should be faster.
(Rudimentary benchmarks show it is twice as fast as ["minify"](#minify).)
Unlike the ["minify"](#minify), if the input string has the UTF-8 flag set, the
resulting string will not. You should ensure the string is properly
encoded.
# SUPPORT FOR OLDER PERL VERSIONS
Since v0.7.0, this module requires Perl v5.14 or later.
Future releases may only support Perl versions released in the last ten years.
If you need this module on Perl v5.9.3, please use one of the v0.6.x
versions of this module. Significant bug or security fixes may be
backported to those versions.
# KNOWN ISSUES
## Malformed UTF-8
Malformed UTF-8 characters may be be mangled or omitted from the
output. In extreme cases it may throw an exception in order to avoid
memory overflows. You should ensure that the input string is properly
encoded as UTF-8.
# SEE ALSO
There are many string trimming and specialised whitespace/comment-removal modules on CPAN.
It is not practical to include such a list.
# SOURCE
The development version is on github at [https://github.com/robrwo/Text-Minify-XS](https://github.com/robrwo/Text-Minify-XS)
and may be cloned from [git://github.com/robrwo/Text-Minify-XS.git](git://github.com/robrwo/Text-Minify-XS.git)
# BUGS
Please report any bugs or feature requests on the bugtracker website
[https://github.com/robrwo/Text-Minify-XS/issues](https://github.com/robrwo/Text-Minify-XS/issues)
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.
# AUTHOR
Robert Rothenberg
# COPYRIGHT AND LICENSE
This software is Copyright (c) 2020-2024 by Robert Rothenberg.
This is free software, licensed under:
```
The Artistic License 2.0 (GPL Compatible)
```