ProofLeader

カレントディレクトリより深い位置にある Markdown ファイルの句読点や整数表記を修正します。

** (変換例) **

，は、に変換されます。
．は。に変換されます。
100111000は100,111,000に変換されます。
abc, defは変換されません。
aは123ですは a は 123 ですに変換されます。

文章表現のミスや変な箇所の修正を警告します(設定は手動)。
特定の文字列を探索します(設定は手動)。

使用方法

起動コマンド

python src/proofLeader.py
または
python src/proofLeader.py -f <FOLDER_NAME>

ただし、 alias を設定することで不特定のディレクトリから実行することも可能です。

alias ProofLeader="python /path/to/src/proofLeader.py"
ProofLeader -f <FOLDER_NAME>

起動テスト

python test/test.py

コマンドラインオプション

Usage:
    {f} [-h | --help] [-v | --version] [-s | --search]
        [-t | --test <FOLDER_NAME>]
    {f} -h | --help
Options:
    -h --help                       ヘルプを表示
    -f --file <FOLDER_NAME> ファイル/フォルダを指定して実行
    -v --version                    ProofLeaderのバージョンを表示
    -s --search                     特定の文字列を探索

期待される出力例

folder_a/folder_b/README.md : OK
folder_c/README.md : OK
converter : ALL OK
CHECK!! -> https://competent-morse-3888be.netlify.app/

英単語・数値の体裁修正機能

，は、に変換します。(ですが，あ→ですが、あ)
．は。に変換します。(です．→です。)
数値は前後にスペースを入れます。(あいう123あいう→あいう 123 あいう)
数値は 3 けたごとにカンマを入れます。(1234→1,234)
英単語は前後にスペースを入れます。(あwordあ→あ word あ)
ただし、英単語または数値の前後にすでにスペースが入っている場合、スペースは追加しません。( word あ→ word あ)
<pre></pre>または```または<code></code>で囲われている内側の文字に関しては変換されません。

文章表現警告機能

文章表現の警告機能(ver1.4 で書式が変更になりました) /ProofLeader にword_list.csvファイルを作り、以下のように記述します。

After1,Before1
After2,Before2_1,Before2_2,Before2_3
After3,Before3_1,Before3_2

すると以下のようにBeforeが文章に入っていた場合Afterにした方がいいと警告します。出力例は以下のようになります(Web ページ上で文字色黄色は見えにくいので背景色を黒にしています)。


WARNING: ファイル名:行数:行頭から何文字目: (致します) => (いたします)

またBeforeは OR 指定ができます。

A,(B|C)

上記のように記述すると、 B または C のとき警告します。

補足

<pre></pre>または```または<code></code>で囲われている内側の文字に関して、変換はされません。ですが、警告は出します。ただし、入れ子構造にするとエラーが発生する場合がございます。

(例)

<pre>
123456 // 123,456 にはならない
</pre>
<code>11111</code> // <code>11,111</code> にはならない

<pre>
致します // WARNING が表示されます。
</pre>
<code>致します</code> // WARNING が表示されます。

除外ファイルの設定

本プログラムは実行ディレクトリ内のすべてのファイルに対して校閲します。ですが、/srcにexclusion_list.csvファイルを作り、以下のように記述することで校閲対象から除外することができます。なお、正規表現は使えません。

SampleFolder/ex_list.md
src/README.md

文字列の探索

WARNING を出すほどでもないけど、全ファイルから特定の文字列を探索したい場合に使用します。コマンドラインオプションは-sまたは--searchです。

python src/proofLeader.py - s

/srcにfind_list.csvファイルを作り、以下のように記述することで校閲対象から除外することができます。なお、正規表現は使えません。

探索したい単語 1
探索したい単語 2

出力は以下のようになります。

FOUND!!: ファイル名:行数:行頭から何文字目: (探索したい単語1)
FOUND!!: ファイル名:行数:行頭から何文字目: (探索したい単語2)