This repository has been archived by the owner on Oct 7, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 91330b7
Showing
5 changed files
with
120 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
{ | ||
"filters": {}, | ||
"rules": { | ||
"preset-ja-technical-writing":{ | ||
"max-ten":{ | ||
"touten":",", | ||
"kuten":"。" | ||
}, | ||
"max-kanji-continuous-len":{ | ||
"max":6, | ||
"allow":[] | ||
} | ||
}, | ||
"@textlint-ja/morpheme-match": { | ||
"dictionaryPathList": ["node_modules/textlint-rule-ja-official-documents/src/dictionary.js"] | ||
}, | ||
"prh":{ | ||
"rulePaths":["node_modules/textlint-rule-ja-official-documents/dict/prh.yml"] | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# textlint-lancher4ja | ||
textlint導入・実行ツール | ||
## Features | ||
- textlint環境(ルール・プリセット,config)の構築 | ||
- textlintのD&D実行 | ||
- 初期設定 | ||
日本語の学会予稿集や卒論・修論などの`*.docx`ファイルを校正させるケースを想定 | ||
- [textlint-rule-ja-official-documents](https://github.com/atsuyaw/textlint-rule-ja-official-documents?organization=atsuyaw&organization=atsuyaw) | ||
- [textlint-rule-preset-ja-engineering-paper](https://github.com/kn1cht/textlint-rule-preset-ja-engineering-paper) | ||
- [textlint-rule-preset-ja-technical-writing](https://github.com/textlint-ja/textlint-rule-preset-ja-technical-writing) | ||
- max-ten: 句読点を,。に設定 | ||
- max-kanji-continuous-len: maxを6に設定 | ||
|
||
## Installation | ||
### 指示されてtextlintを使う人 | ||
1. 予め[node.jsをインストールして](https://nodejs.org/ja/download/)おく。 | ||
1. `./install_textlint_plugins.bat`を実行する。 | ||
*SmartScreenによってブロックされたら`[詳細情報] > [実行]`を選択する。 | ||
1. 校正したいファイルを`./run_textlint.bat`にD&Dすると校正結果がコンソールに表示される。 | ||
*若干時間が掛かります。 | ||
|
||
### マネージャー | ||
1. releaseから`.zip`をダウンロードする。 | ||
1. 通常のtextlintの環境を展開する。 | ||
1. `npm i -D textract`を実行する。 | ||
1. 初めにダウンロードしたファイルの`package.json`を作成された`package.json`に差し替える。 | ||
1. フォルダを配布する。 | ||
|
||
## Background of development | ||
後輩のドキュメントを事前に校正しておいてほしい。 | ||
私はtextlintを使うのですが,後輩は知らない。 | ||
|
||
それで後輩のPC上にtextlintの環境を構築してCUI操作なしで校正させるツールが必要になりました。 | ||
同様の用途を想定したツールとして[GUIで動作する文書校正ツール GUI tool for textlinting.](https://github.com/gecko655/proofreading-tool)があります。 | ||
GUIもきれいで便利なのですが,ruleの導入をやろうとすると自前でbuildすることになり,ちょっとハードルでした。 | ||
現状においてはtextlintを使うというところに辿り着くのは,マネージャーがtextlintをCUIで使えるという状況が大半であり,後輩とか部下は詳しいことを知らないけど校正は掛けておいてほしい,という感じではないでしょうか。 | ||
|
||
その際に普段通りの設定作業をすれば配布も簡単で環境構築にはCUI操作が不要ということが求められる機能です。 | ||
つまり,`package.json`をマネージャーが設定し,CUIなしでこれをインストールできればそれで十分というわけです。 | ||
結局やっていることは前述のツールと全く同じで`textract`と`textlint`が走っているだけですが。 | ||
|
||
`npm desktop manager`とか`npm-gui`を使えばマネージャーの操作もCUIレスでできるようになるかも… | ||
まァ誰か詳しい人がいる環境で使うべき,という気はしますが。 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
echo off | ||
chcp 65001 | ||
echo. | ||
echo =========== | ||
echo. | ||
echo textlint-installer4ja | ||
echo by @atsuyaw | ||
echo. | ||
echo =========== | ||
echo. | ||
echo インストールを中止するにはこのウィンドウを終了してください。 | ||
echo To cancel setup, please close this window now. | ||
echo 事前にnode.jsがインストールされていることを確認してください。 | ||
echo node | ||
echo は認識されていませんというエラーが出ます。 | ||
echo Before run this installer, please confirm node.js is installed. | ||
echo. | ||
pause | ||
npm i -D | ||
pause |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
{ | ||
"name": "textlint-lancher4ja", | ||
"version": "1.0.0", | ||
"main": "index.js", | ||
"scripts": { | ||
"test": "echo \"Error: no test specified\" && exit 1" | ||
}, | ||
"keywords": [], | ||
"author": "atsuyaw", | ||
"license": "MIT", | ||
"description": "", | ||
"devDependencies": { | ||
"@textlint-ja/textlint-rule-morpheme-match": "^2.0.0", | ||
"textlint": "^12.0.0", | ||
"textlint-rule-ja-official-documents": "github:atsuyaw/textlint-rule-ja-official-documents", | ||
"textlint-rule-preset-ja-engineering-paper": "^1.0.2", | ||
"textlint-rule-preset-ja-technical-writing": "^6.0.0", | ||
"textlint-rule-prh": "^5.3.0", | ||
"textract": "^2.5.0" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
echo off | ||
chcp 65001 | ||
color 1f | ||
echo. | ||
echo =========== | ||
echo. | ||
echo textlint-lancher4ja | ||
echo by @atsuyaw | ||
echo. | ||
echo =========== | ||
echo. | ||
pause | ||
echo on | ||
npx textract %1 | npx textlint --stdin | ||
pause |