/ 
App-CSVUtils-0.046
River stage one • 3 direct dependents • 4 total dependents
/ csv-replace-newline

NAME

csv-replace-newline - Replace newlines in CSV values

VERSION

This document describes version 0.046 of csv-replace-newline (from Perl distribution App-CSVUtils), released on 2022-10-25.

SYNOPSIS

csv-replace-newline --help (or -h, -?)

csv-replace-newline --version (or -v)

csv-replace-newline [--escape-char=str] [--format=name|--json] [--header|--input-header|--no-header|--noheader] [--(no)naked-res] [--output-escape-char=str] [--output-header|--no-output-header|--nooutput-header] [--output-quote-char=str] [--output-sep-char=str] [--output-tsv|--no-output-tsv|--nooutput-tsv] [--overwrite|-O|--no-overwrite|--nooverwrite] [--page-result[=program]|--view-result[=program]] [--quote-char=str] [--sep-char=str] [--tsv|--input-tsv|--no-tsv|--notsv] [--with=str|--with-backslash-n|--with-nothing|--with-space] -- <filename> [output_filename]

DESCRIPTION

Some CSV parsers or applications cannot handle multiline CSV values. This utility can be used to convert the newline to something else. There are a few choices: replace newline with space (--with-space, the default), remove newline (--with-nothing), replace with encoded representation (--with-backslash-n), or with characters of your choice (--with 'blah').

Common notes for the utilities

Encoding: The utilities in this module/distribution accept and emit UTF8 text.

OPTIONS

* marks required options.

Main options

--with-backslash-n

Alias for --with.

See --with.

--with-nothing

Alias for --with.

See --with.

--with-space

Alias for --with.

See --with.

--with=s

Default value:

" "

Input options

--escape-char=s

Specify character to escape value in field in input CSV, will be passed to Text::CSV_XS.

Defaults to \\ (backslash). Overrides --tsv option.

--filename=s*

Input CSV file or URL.

Use - to read from stdin, use clipboard: to read from clipboard.

Can also be specified as the 1st command-line argument.

--no-header, --input-header

By default (--header), the first row of the CSV will be assumed to contain field names (and the second row contains the first data row). When you declare that CSV does not have header row (--no-header), the first row of the CSV is assumed to contain the first data row. Fields will be named field1, field2, and so on.

--quote-char=s

Specify field quote character in input CSV, will be passed to Text::CSV_XS.

Defaults to " (double quote). Overrides --tsv option.

--sep-char=s

Specify field separator character in input CSV, will be passed to Text::CSV_XS.

Defaults to , (comma). Overrides --tsv option.

--tsv, --input-tsv

Inform that input file is in TSV (tab-separated) format instead of CSV.

Overriden by --sep-char, --quote-char, --escape-char options. If one of those options is specified, then --tsv will be ignored.

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

undef

Output can be displayed in multiple formats, and a suitable default format is chosen depending on the application and/or whether output destination is interactive terminal (i.e. whether output is piped). This option specifically chooses an output format.

--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

[200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use --naked-res so you just get:

[1,2,3]
--output-escape-char=s

Specify character to escape value in field in output CSV, will be passed to Text::CSV_XS.

This is like --escape-char option but for output instead of input.

Defaults to \\ (backslash). Overrides --output-tsv option.

--output-filename=s, -o

Output filename or URL.

Use - to output to stdout (the default if you don't specify this option), use clipboard: to write to clipboard.

Can also be specified as the 2nd command-line argument.

--output-header

Whether output CSV should have a header row.

By default, a header row will be output if input CSV has header row. Under --output-header, a header row will be output even if input CSV does not have header row (value will be something like "col0,col1,..."). Under --no-output-header, header row will not be printed even if input CSV has header row. So this option can be used to unconditionally add or remove header row.

--output-quote-char=s

Specify field quote character in output CSV, will be passed to Text::CSV_XS.

This is like --quote-char option but for output instead of input.

Defaults to " (double quote). Overrides --output-tsv option.

--output-sep-char=s

Specify field separator character in output CSV, will be passed to Text::CSV_XS.

This is like --sep-char option but for output instead of input.

Defaults to , (comma). Overrides --output-tsv option.

--output-tsv

Inform that output file is TSV (tab-separated) format instead of CSV.

This is like --tsv option but for output instead of input.

Overriden by --output-sep-char, --output-quote-char, --output-escape-char options. If one of those options is specified, then --output-tsv will be ignored.

--overwrite, -O

Whether to override existing output file.

--page-result

Filter output through a pager.

This option will pipe the output to a specified pager program. If pager program is not specified, a suitable default e.g. less is chosen.

--view-result

View output using a viewer.

This option will first save the output to a temporary file, then open a viewer program to view the temporary file. If a viewer program is not chosen, a suitable default, e.g. the browser, is chosen.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C csv-replace-newline csv-replace-newline

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete csv-replace-newline 'p/*/`csv-replace-newline`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/perlancar/perl-App-CSVUtils.

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) 2022, 2021, 2020, 2019, 2018, 2017, 2016 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=App-CSVUtils

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.