Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaz-utashiro/app-greple-tee
Greple module to replace matched text by the external command result
https://github.com/kaz-utashiro/app-greple-tee
Last synced: 8 days ago
JSON representation
Greple module to replace matched text by the external command result
- Host: GitHub
- URL: https://github.com/kaz-utashiro/app-greple-tee
- Owner: kaz-utashiro
- License: other
- Created: 2023-02-19T10:29:02.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-08T08:14:28.000Z (3 months ago)
- Last Synced: 2024-11-08T07:17:11.185Z (2 months ago)
- Language: Perl
- Size: 319 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.JA.md
- Changelog: Changes
- License: LICENSE
Awesome Lists containing this project
README
# NAME
App::Greple::tee - マッチしたテキストを外部コマンドの結果に置き換えるモジュール
# SYNOPSIS
greple -Mtee command -- ...
# VERSION
Version 1.01
# DESCRIPTION
Greple の **-Mtee** モジュールは、マッチしたテキスト部分を指定されたフィルタコマンドに送り、その結果で置き換えます。このアイデアは、**teip**というコマンドから派生したものです。これは、外部のフィルタコマンドに部分的なデータをバイパスするようなものである。
Filterコマンドはモジュール宣言(`-Mtee`)に続き、2つのダッシュ(`--`)で終了する。例えば、次のコマンドは、データ中の一致した単語に対して、`a-z A-Z` の引数を持つコマンド `tr` コマンドを呼び出します。
greple -Mtee tr a-z A-Z -- '\w+' ...
上記のコマンドは、マッチした単語をすべて小文字から大文字に変換する。**greple**は**--cm**オプションでより効果的に同じことができるので、実はこの例自体はあまり意味がない。
デフォルトでは、コマンドは1つのプロセスとして実行され、マッチしたデー タはすべて混在してプロセスに送られる。マッチしたテキストが改行で終わっていない場合は、送信前に追加され、受信後に削除される。入力データと出力データは行ごとにマップされるので、入力と出力の行数は同じでなければならない。
**--discrete**オプションを使うと、マッチしたテキスト・エリアごとにコマンドが呼び出されます。この違いは以下のコマンドでわかる。
greple -Mtee cat -n -- copyright LICENSE
greple -Mtee cat -n -- copyright LICENSE --discrete
**--discrete**オプションを使用する場合、入出力データの行数は同一である必要はありません。
# OPTIONS
- **--discrete**
一致した部品に対して、個別に新しいコマンドを起動する。
- **--bulkmode**
<--discrete>オプションをつけると、各コマンドはオンデマンドで実行される。このオプションは
<--bulkmode> option causes all conversions to be performed at once.
- **--crmode**
このオプションは、各ブロックの途中にある改行文字をすべてキャリッジリターン文字に置き換える。コマンドの実行結果に含まれるキャリッジリターンは改行文字に戻される。このように、複数行からなるブロックは、**--discrete**オプションを使わずに一括して処理することができる。
- **--fillup**
一連の空白でない行を1行にまとめてからフィルターコマンドに渡す。幅の広い文字の間の改行文字は削除され、その他の改行文字はスペースに置き換えられる。
- **--squeeze**
2つ以上の連続する改行文字を1つにまとめる。
- **-Mline** **--offload** _command_
[teip(1)](http://man.he.net/man1/teip)の**--offload**オプションは、別のモジュール**-Mline**に実装されている。
greple -Mtee cat -n -- -Mline --offload 'seq 10 20'
また、**-line** モジュールを使って、次のように偶数行だけを処理することもできる。
greple -Mtee cat -n -- -Mline 2::2
# LEGACIES
**--blocks**オプションは、**--stretch** (**-S**)オプションが**greple**に実装されたので、必要なくなりました。単純に以下のように実行すればよい。
greple -Mtee cat -n -- --all -SE foo
**--blocks**は将来廃止される可能性があるので、使用することは推奨されない。
- **--blocks**
通常、指定された検索パターンにマッチする領域が外部コマンドに送られる。このオプションが指定されると、マッチした領域ではなく、それを含むブロック全体が処理される。
例えば、パターン`foo`を含む行を外部コマンドに送るには、行全体にマッチするパターンを指定する必要がある：
greple -Mtee cat -n -- '^.*foo.*\n' --all
しかし、**--blocks** オプションを使えば、次のように簡単にできる：
greple -Mtee cat -n -- foo --blocks
**--blocks** オプションをつけると、このモジュールは [teip(1)](http://man.he.net/man1/teip) の **-g** オプションに似た挙動をする。**--blocks** オプションを使うと、このモジュールはより [teip(1)](http://man.he.net/man1/teip) の **-g** オプションに近い動作をする。
**--blocks** を **--all** オプションと一緒に使わないでください。
# WHY DO NOT USE TEIP
まず第一に、**teip**コマンドでできることは、いつでもそれを使ってください。これは優れたツールで、**greple**よりずっと速いです。
**greple**は文書ファイルの処理を目的としているため、マッチエリアの制御など、それに適した機能を多く持っています。それらの機能を活用するために、**greple**を使う価値はあるかもしれません。
また、**teip**は複数行のデータを1つの単位として扱うことができませんが、**greple**は複数行からなるデータチャンクに対して個別のコマンドを実行することが可能です。
# EXAMPLE
次のコマンドは，Perlモジュールファイルに含まれる[perlpod(1)](http://man.he.net/man1/perlpod)スタイルドキュメント内のテキストブロックを検索します。
greple --inside '^=(?s:.*?)(^=cut|\z)' --re '^([\w\pP].+\n)+' tee.pm
このように**Mtee**モジュールと組み合わせて**deepl**コマンドを呼び出すと、DeepLサービスによって翻訳することができます。
greple -Mtee deepl text --to JA - -- --fillup ...
ただし、この場合は専用モジュール [App::Greple::xlate::deepl](https://metacpan.org/pod/App%3A%3AGreple%3A%3Axlate%3A%3Adeepl) の方が効果的です。実は、**tee**モジュールの実装のヒントは**xlate**モジュールからきています。
# EXAMPLE 2
次に、LICENSE文書にインデントされた部分があります。
greple --re '^[ ]{2}[a-z][)] .+\n([ ]{5}.+\n)*' -C LICENSE
a) distribute a Standard Version of the executables and library files,
together with instructions (in the manual page or equivalent) on where to
get the Standard Version.
b) accompany the distribution with the machine-readable source of the Package
with your modifications.
この部分は**tee**モジュールと**ansifold**コマンドで整形することができます。
greple -Mtee ansifold -rsw40 --prefix ' ' -- --discrete --re ...
a) distribute a Standard Version of
the executables and library files,
together with instructions (in the
manual page or equivalent) on where
to get the Standard Version.
b) accompany the distribution with the
machine-readable source of the
Package with your modifications.
discreteオプションは複数のプロセスを起動するので、プロセスの実行に時間がかかる。そのため、`--separate ' \r'`オプションと`ansifold`を併用すると、NLの代わりにCR文字を使って1行にすることができます。
greple -Mtee ansifold -rsw40 --prefix ' ' --separate '\r' --
その後、[tr(1)](http://man.he.net/man1/tr)コマンドなどでCRをNLに変換する。
... | tr '\r' '\n'
# EXAMPLE 3
ヘッダ行以外から文字列を grep したい場合を考えてみましょう。例えば、`docker image ls`コマンドからDockerイメージ名を検索したいが、ヘッダ行は残したいとします。以下のコマンドで可能です。
greple -Mtee grep perl -- -Mline -L 2: --discrete --all
オプション`-Mline -L 2:`は2行目から最後の行を検索し、`grep perl`コマンドに送ります。入出力の行数が変わるので-discreteオプションが必要だが、コマンドは一度しか実行されないので性能上の欠点はない。
**teip**コマンドで同じことをしようとすると、`teip -l 2- -- grep`は出力行数が入力行数より少ないのでエラーになる。しかし、得られる結果に問題はない。
# INSTALL
## CPANMINUS
$ cpanm App::Greple::tee
# SEE ALSO
[App::Greple::tee](https://metacpan.org/pod/App%3A%3AGreple%3A%3Atee), [https://github.com/kaz-utashiro/App-Greple-tee](https://github.com/kaz-utashiro/App-Greple-tee)
[https://github.com/greymd/teip](https://github.com/greymd/teip)
[App::Greple](https://metacpan.org/pod/App%3A%3AGreple), [https://github.com/kaz-utashiro/greple](https://github.com/kaz-utashiro/greple)
[https://github.com/tecolicom/Greple](https://github.com/tecolicom/Greple)
[App::Greple::xlate](https://metacpan.org/pod/App%3A%3AGreple%3A%3Axlate)
# BUGS
`--fillup` オプションは、韓国語テキストを連結する際に、ハングル文字間の空白を削除する。
# AUTHOR
Kazumasa Utashiro
# LICENSE
Copyright © 2023-2024 Kazumasa Utashiro.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.