initial commit

azu · azu · commit 3fcd31a454b0 · 2016-05-04T23:47:49.000+09:00
diff --git a/.babelrc b/.babelrc
@@ -0,0 +1,13 @@
+{
+  "presets": [
+    "es2015"
+  ],
+  "env": {
+    "development": {
+      "presets": [
+        "jsdoc-to-assert",
+        "power-assert"
+      ]
+    }
+  }
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,85 @@
+### https://raw.github.com/github/gitignore/608690d6b9a78c2a003affc792e49a84905b3118/Node.gitignore
+
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
+node_modules
+
+# Debug log from npm
+npm-debug.log
+
+
+### https://raw.github.com/github/gitignore/608690d6b9a78c2a003affc792e49a84905b3118/Global/JetBrains.gitignore
+
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm
+
+*.iml
+
+## Directory-based project format:
+.idea/
+# if you remove the above rule, at least ignore the following:
+
+# User-specific stuff:
+# .idea/workspace.xml
+# .idea/tasks.xml
+# .idea/dictionaries
+
+# Sensitive or high-churn files:
+# .idea/dataSources.ids
+# .idea/dataSources.xml
+# .idea/sqlDataSources.xml
+# .idea/dynamic.xml
+# .idea/uiDesigner.xml
+
+# Gradle:
+# .idea/gradle.xml
+# .idea/libraries
+
+# Mongo Explorer plugin:
+# .idea/mongoSettings.xml
+
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+
+
+/lib
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,3 @@
+sudo: false
+language: node_js
+node_js: "stable"
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2016 azu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,97 @@
+# textlint-rule-max-kanji-continuous-len
+
+[textlint](https://textlint.github.io/ "textlint") rule that limit max continuous length of kanji(漢字).
+
+漢字が連続する最大文字数を制限する[textlint](https://textlint.github.io/ "textlint")ルールです。
+
+## Install
+
+Install with [npm](https://www.npmjs.com/):
+
+    npm install textlint-rule-max-kanji-continuous-len
+
+## Usage
+
+Via `.textlintrc`(Recommended)
+
+
+```json
+{
+    "rules": {
+        "max-kanji-continuous-len": true
+    }
+}
+```
+
+Via CLI
+
+```
+textlint --rule max-kanji-continuous-len README.md
+```
+
+## Options
+
+- `max`
+    - default: 5
+    - `一二三四五六`は6文字なのでエラーとなります。
+    - 最大の漢字長
+    
+
+```json
+{
+    "rules": {
+        "max-kanji-continuous-len": {
+            // 最大の漢字長
+            // Allow max continuous length of kanji
+            // If {current} > max(5), report Error.
+            max: 5
+        }
+    }
+}
+```
+
+## Further Reading
+
+デフォルト値である漢字の連続調が6文字以上だとエラーとする根拠は今のところありません。
+
+> 漢字連続長はこの印象に影響が無かったことから、漢字連続長を短くすることで「子ども向けの文章」という印象を与えず、先行研究で指摘される読みやすい文章が実現できると示唆された。
+> -- [日本心理学会第79回大会 漢字含有率と漢字連続長が文章の印象に与える影響](http://www.myschedule.jp/jpa2015/search/detail_program/id:602)
+
+漢字の連続長が長くしすぎないことが、読みやすさに繋がることは既存研究にて実証されています。
+
+おおまかに4文字と5文字に壁があり、そこにバッファをもたせて6文字以上は、デフォルトではエラーとしています。
+
+- [日本心理学会第79回大会 漢字含有率と漢字連続長が文章の印象に与える影響](http://www.myschedule.jp/jpa2015/search/detail_program/id:602)
+- [漢字含有率と漢字連続長が文章の印象に与える影響.pdf](http://www.myschedule.jp/jpa2015/img/figure/90737.pdf)
+- [02Shibasaki.pdf](http://www.jels.info/REPL/02/02Shibasaki.pdf)
+- [signl136.PDF - signl136-slides.pdf](http://www.nori.jp/publications/SIGNL136/signl136-slides.pdf)
+
+## Changelog
+
+See [Releases page](https://github.com/azu/textlint-rule-max-kanji-continuous-len/releases).
+
+## Running tests
+
+Install devDependencies and Run `npm test`:
+
+    npm i -d && npm test
+
+## Contributing
+
+Pull requests and stars are always welcome.
+For bugs and feature requests, [please create an issue](https://github.com/azu/textlint-rule-max-kanji-continuous-len/issues).
+
+1. Fork it!
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Submit a pull request :D
+
+## Author
+
+- [github/azu](https://github.com/azu)
+- [twitter/azu_re](http://twitter.com/azu_re)
+
+## License
+
+MIT © azu
diff --git a/package.json b/package.json
@@ -0,0 +1,47 @@
+{
+  "name": "textlint-rule-max-kanji-continuous-len",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/azu/textlint-rule-max-kanji-continuous-len.git"
+  },
+  "author": "azu",
+  "email": "azuciao@gmail.com",
+  "homepage": "https://github.com/azu/textlint-rule-max-kanji-continuous-len",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/azu/textlint-rule-max-kanji-continuous-len/issues"
+  },
+  "files": [
+    "src/",
+    "lib/"
+  ],
+  "version": "1.0.0",
+  "description": "textlint rule that limit max continuous length of kanji(漢字).",
+  "main": "lib/textlint-rule-max-kanji-continuous-len.js",
+  "directories": {
+    "test": "test"
+  },
+  "scripts": {
+    "test": "mocha test/",
+    "build": "NODE_ENV=production babel src --out-dir lib --source-maps",
+    "watch": "babel src --out-dir lib --watch --source-maps",
+    "prepublish": "npm run --if-present build"
+  },
+  "keywords": [
+    "textlint"
+  ],
+  "devDependencies": {
+    "babel-cli": "^6.8.0",
+    "babel-preset-es2015": "^6.6.0",
+    "babel-preset-jsdoc-to-assert": "^1.0.1",
+    "babel-preset-power-assert": "^1.0.0",
+    "babel-register": "^6.8.0",
+    "mocha": "^2.4.5",
+    "power-assert": "^1.3.1",
+    "textlint-tester": "^1.2.0"
+  },
+  "dependencies": {
+    "match-index": "^1.0.1",
+    "textlint-rule-helper": "^1.1.5"
+  }
+}
diff --git a/src/textlint-rule-max-kanji-continuous-len.js b/src/textlint-rule-max-kanji-continuous-len.js
@@ -0,0 +1,35 @@
+// LICENSE : MIT
+"use strict";
+import {RuleHelper} from "textlint-rule-helper";
+import {matchCaptureGroupAll} from "match-index"
+
+const KanjiRegExp = /((?:[々〇〻\u3400-\u9FFF\uF900-\uFAFF]|[\uD840-\uD87F][\uDC00-\uDFFF])+)/g;
+const defaultOptions = {
+    // 最大の漢字長
+    // Allow max continuous length of kanji
+    // If {current} > max(5), report Error.
+    max: 5
+};
+
+module.exports = function reporter(context, options = defaultOptions) {
+    const {Syntax, RuleError, report, fixer, getSource} = context;
+    const helper = new RuleHelper(context);
+    const maxLength = options.max || defaultOptions.max;
+    return {
+        [Syntax.Str](node){
+            if (helper.isChildNode(node, [Syntax.Link, Syntax.Image, Syntax.BlockQuote, Syntax.Emphasis])) {
+                return;
+            }
+            const text = getSource(node);
+            matchCaptureGroupAll(text, KanjiRegExp).forEach(({text, index}) => {
+                // max より 大きい場合はエラー
+                if (text.length > maxLength) {
+                    const ruleError = new RuleError(`漢字が${maxLength + 1}つ以上連続しています: ${text}`, {
+                        index
+                    });
+                    report(node, ruleError);
+                }
+            });
+        }
+    }
+};
diff --git a/test/mocha.opts b/test/mocha.opts
@@ -0,0 +1 @@
+--compilers js:babel-register
diff --git a/test/textlint-rule-max-kanji-continuous-len-test.js b/test/textlint-rule-max-kanji-continuous-len-test.js
@@ -0,0 +1,74 @@
+const TextLintTester = require("textlint-tester");
+const tester = new TextLintTester();
+// rule
+import rule from "../src/textlint-rule-max-kanji-continuous-len";
+// ruleName, rule, { valid, invalid }
+tester.run("max-kanji-continuous-len", rule, {
+    valid: [
+        // no match
+        "漢字",
+        "漢字連続調",
+        {
+            text: "一二三四五六",
+            options: {
+                max: 6 // 6 is ok, 7 is ng
+            }
+        }
+    ],
+    invalid: [
+        {
+            text: "漢字連続調複雑性が高い",
+            errors: [
+                {
+                    message: "漢字が6つ以上連続しています: 漢字連続調複雑性",
+                    line: 1,
+                    column: 1
+                }
+            ]
+        },
+        {
+            text: `＃一二三四五六`,
+            errors: [
+                {
+                    message: "漢字が6つ以上連続しています: 一二三四五六",
+                    line: 1,
+                    column: 2
+                }
+            ]
+        },
+        // multiple match in multiple lines
+        {
+            text: `一二三四五六です。一二三四五六です。`,
+            errors: [
+                {
+                    message: "漢字が6つ以上連続しています: 一二三四五六",
+                    line: 1,
+                    column: 1
+                },
+
+                {
+                    message: "漢字が6つ以上連続しています: 一二三四五六",
+                    line: 1,
+                    column: 10
+                }
+            ]
+        },
+        // multiple hit items in a line
+        {
+            text: `一二三四五六\n一二三四五六`,
+            errors: [
+                {
+                    message: "漢字が6つ以上連続しています: 一二三四五六",
+                    line: 1,
+                    column: 1
+                },
+
+                {
+                    message: "漢字が6つ以上連続しています: 一二三四五六",
+                    line: 2,
+                    column: 1
+                }
+            ]
+        }
+    ]
+});

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+sudo: false`
	`2`	`+language: node_js`
	`3`	`+node_js: "stable"`