Home

Awesome

redpen-validator

Javascript拡張を利用したRedPenのValidatorです。

Code Climate

使い方

RedPenのコンフィグファイルに以下を追記します。

<validator name="JavaScript" >
    <property name="script-path" value="/Path/to/this/repo/on/your/env" />
</validator>

各ファイルが対応する検査項目

ファイル名検査項目参考文献
use-joyo-Kanji.js常用漢字を使っているかJTF 日本語標準スタイルガイド（翻訳用） 2.1.2
katakana-must-be-two-byte.js全角のカタカナを使っているかJTF 日本語標準スタイルガイド（翻訳用） 2.1.5
numeral-must-be-hankaku.js半角の算用数字を使っているかJTF 日本語標準スタイルガイド（翻訳用） 2.1.8
alphabet-must-be-one-byte.js半角のアルファベットを使っているかJTF 日本語標準スタイルガイド（翻訳用） 2.1.9
use-hiragana-and-kanji-properly.jsひらがなと漢字の使い分けJTF 日本語標準スタイルガイド（翻訳用） 2.2.1
use-numeral-properly.js算用数字と漢数字の使い分け　　JTF 日本語標準スタイルガイド（翻訳用） 2.2.2
ka-is-written-in-hiragana.js助数詞にともなう「か」の表記JTF 日本語標準スタイルガイド（翻訳用） 2.2.3
symbol.js記号の使い方が適切かJTF 日本語標準スタイルガイド（翻訳用） 4.2 & 4.3
use-assertive-style.js断定を避ける表現use-assertive-style.js内に記載
use-literary-style.js　　　口語表現use-literary-style.js内に記載
dont-use-kosoado.jsこそあど言葉dont-use-kosoado.js内に記載
dont-use-can-do.jsすることができるdont-use-can-do.js内に記載
custom-pattern.js自分で登録した規則が含まれているか　なし

custom-pattern.js

自分で表記の規則を登録して利用する拡張です。terms配列に登録されている表記の規則を利用して、文章に規則から外れた表現が含まれているかを検査します。検査方法は正規表現と形態素解析の二つをサポートしています。

正規表現による検査

正規表現による検査を行う場合、terms配列に以下パラメータを持ったオブジェクトを登録します。

{
    'pattern':'ではないだろうか',
    'message':'断定を避ける表現です。断定系を使ってください。',
}

形態素解析による検査

形態素解析による検査を行う場合、terms配列に以下プロパティを持ったオブジェクトを登録します。

{
    'pattern':'考えられる',
    'message':'断定を避ける表現です。断定系を使ってください。',
    'tokens':[
        {
            'tags0':'動詞',
            'tags1':'自立',
            'tags6':'考える'
        },
        {
            'tags0':'動詞',
            'tags1':'接尾',
            'tags6':'られる'
        }
    ]
},

tokensプロパティには、kuromojiによる形態素解析の結果を登録します。各項目とkuromojiによる形態素解析の結果は、以下の通り紐づいています。kuromojiによる形態素解析の結果はkuromojiのデモサイトで取得するのが簡単です。

項目登録内容
tags0Part-of-Speechの1つ目（kuromojiが生成するTokenに含まれるFeatureの1つ目）
tags1Part-of-Speechの2つ目（kuromojiが生成するTokenに含まれるFeatureの2つ目）
tags6Base form（kuromojiが生成するTokenに含まれるFeatureの7つ目）

謝辞

use-joyo-Kanji.jsの作成にあたっては、以下のサイトを参考にさせていただきました。感謝します。