1.0.2 • Published 6 years ago
kanjilint v1.0.2
kanjilint
概要
入力から常用漢字以外の漢字を出力するNodeJSのAPI/CLIです。「漢字の利用規則を統一し、コンテンツの品質を高めること」を目的としています。
具体的には以下の漢字を検出します。
- 非常用漢字
- 常用漢字の旧字体
- 削除された常用漢字
- 新聞常用漢字で追加された非常用漢字
- 新聞常用漢字で削除された常用漢字
詳細
- 文化庁の開示している常用漢字表（平成22年内閣告示第2号）はPDFであるため解析が難しく、代わりにWikipediaの「常用漢字一覧」ページを解析、利用しています。つまりWikipediaの内容に問題がある場合、当プログラムの挙動にも問題が発生します。
- 新聞常用漢字についても、Wikipediaの「新聞常用漢字表」ページを参考にしています。
- いわゆる教育漢字については、すべての教育漢字が常用漢字であるかどうかがわからないため、学年別漢字配当表は考慮していません。
- 検出対象となるのは漢字そのものだけであり、音訓などは考慮していません。
- ここでの漢字とは、Unicodeにおける4E00から9FA5（
一-龥）を指します。他の文字は処理の対象になりません。 - バイナリファイルは処理の対象になりません。
インストール
グローバルで使いたい場合は、
$ npm i -g kanjilint
$ kanjilint -vローカルで使いたい場合は、
$ npm i --save-dev kanjilint
$ npx kanjilint -v使用例
$ kanjilint -vバージョンを表示します。$ kanjilint sample.txtsample.txtを処理します（標準出力に結果を表示します）。$ kanjilint "components/**/*.vue"componentsフォルダ以下のすべての.vueファイルを処理します。
パスの指定についてはglobを参照してください。
また、globの記法に準拠する場合、パスをクォーテーションで囲む必要があるかもしれません。$ kanjilint "**/*.html" -e node_modules -o result.txt -q 64オプション（後述）を付けて処理します。
オプション
-v, --versionバージョンを表示します。-e, --exclude <s>この文字列を含むファイルパスは処理されません。-p, --press <b>新聞常用漢字も検出するかどうか指定します（デフォルトでtrue）。-o, --output <s>出力ファイルのパスを指定します（デフォルトで標準出力）。-f, --format <s>出力フォーマットをjsonとtextから指定します（デフォルトでtext）。-q, --quotation <n>出力に記載する引用文の長さを指定します（デフォルトで32）。0で記載しません。-h, --helpヘルプを表示します。
API
現状2つの関数があります。
const kanjilint = require('kanjilint');make(output)
処理の判断基準となる list.json ファイルを生成します。
常用漢字が更新され、かつ、前述のWikipediaも更新された場合、 npm run make を起動してください。同ページをスクレイピングし、 list.json ファイルを再生成します。
この際、新聞常用漢字の情報を記した lib/press.json の内容も list.json に反映されます。
parse(text, isPress = true)
文字列から非常用漢字などを抽出し、結果を返します。npm test もしくは RunKitで以下のコードをお試しください。
const kanjilint = require('kanjilint');
const results = kanjilint.parse('私が良く使うフォントは游ゴシックです。\n好きな植物は櫻です。');
console.log(results);更新履歴
1.0.2
- 新聞常用漢字に対応。
1.0.1
bin/cli.js→bin/kanjilintlist.jsonの出力先を変更。lib/make.jsをAPIに移行。関連してnpm run makeを追加。
1.0.0
- リリース。