文書校正textlint,RedPenをPHPと連携させて使いたい

Question

PHPで文書校正をするウェブシステム制作

PHPで文書校正をするウェブシステムを作りたいと思っています。
文書校正に使えるものを探していたらtextlintとRedPenを見つけましたが、これらのものはウェブのシステムとして組み込んで使えますか？
また、他に適したものがあれば教えていただきたいです。

#追記

前提・実現したいこと

PHPの中でtextlintの文章校正をするウェブシステムを作っています。
入力フォームから文章のデータを飛ばして、exec()でコマンドを実行して文章校正をして表示させたい。

発生している問題・エラーメッセージ

チェックしてみましょう実行結果：1
Array ( [0] => [1] => == No rules found, textlint hasn’t done anything == [2] => [3] => Possible reasons: [4] => * Your textlint config file has no rules. [5] => * You have no config file and you aren’t passing rules via command line. [6] => * Your textlint config has a syntax error. [7] => [8] => => How to set up rules? [9] => https://github.com/textlint/textlint/blob/master/docs/configuring.md [10] => )

該当のソースコード

<?php
print 'チェックしてみましょう';
$cmd = 'npx textlint docs/sample.txt';
echo exec($cmd, $opt, $return_ver);
echo '実行結果：'.$return_ver;
print_r($opt);

?>

試したこと

textlintをコマンドラインで実行してみた所、満足ができる範囲の文章校正はすることができました。
今はその実行コマンドをPHPの中に組み込んでいるだけなので、エラーが出てくるのは当たり前だと思いますがそもそもデータをどうやって参照したらいいのか不明。
データの参照が上手くいっていないのかなと思い、調べてみましたがわからず。

Comments

[m.ts10806]

見つけたのでしたら、ドキュメント読んで試してみられては…

[tiki-]

わかりました。一度読んだんですが、連携させるための情報が見当たらなかったので質問させていただきました。もう一度確認してみようと思います。

Answer 1

文書校正に使えるものを探していたらtextlintとRedPenを見つけましたが、これらのものはウェブのシステムとして組み込んで使えますか？

技術的にはコマンドラインから実行できるものなので、PHPからexec()やshell_exec()で叩いてやれば連携出来るでしょうね。
（もっと簡単に出来るライブラリも存在するかもしれませんが）

Comments

[tiki-]

回答ありがとうございます。確かにexec()やshell_exec()を使って連携ができそうですね。
ただ、まだまだ勉強不足な所もありイメージはついたんですが、具体的なやり方がさっぱりです(笑)

[tanat]

具体的なやり方まで作る前からイメージ出来る人は既にプロなので、まずは作ってみるのが良いかと思いますよ。
わからない所が具体的にならないと調べる事もできません。

ポイントとしては、分割出来るところは分割して最小限の構成でそれぞれ動くものを作ってみることです。

今回のケースだと、コマンドラインで連携出来る事は分かっている訳なので、
1. 単に手動でコマンドラインから文章を渡して結果を取得し、その使い方を把握する
2. webのフォームから文章を受け取ってexecに渡して結果を受け取る

の2点をクリア出来ればあとは普通のwebアプリケーションと同じ作りで作れます。

[tiki-]

確かにそうですね。少しずつ進めながらやってみようと思います！
すごくわかりやすいアドバイスありがとうございます。

[tiki-]

1. 単に手動でコマンドラインから文章を渡して結果を取得し、その使い方を把握する
まず、textlintを使ってみました。一通り試してみて、満足できる設定での文章校正はコマンドライン上でできるようになりました。
2. webのフォームから文章を受け取ってexecに渡して結果を受け取る
これがまだできていない状態です。
まずexecの動きだけで試してみました。コマンドの実行まではできましたが、結果は『No rules found,textlint hasn’t done anything』というエラーで上手く動けていない状態です。
.txtのファイルからどうやって文章のデータをもってくるのか、ルールを書いたデータはどうやって関連づけるのか。謎な部分が少しずつ見えてきました。

[tanat]

進んでる様で良かったです。

課題が具体的になっているのでそれぞれ解決出来そうですね。

今躓いている部分と関係するか分かりませんが、exec()はパス周りで躓きやすいので、PHPから渡すコマンドとその引数のパスは常にフルパスで渡す様にすると失敗が減ります。

どうしても解決出来なければ、
具体的なコードとエラー、考えたアプローチの方向性を整理して質問を新たに立てると的確な回答が得られると思います(整理してる途中で解決することも多いです)