initial commit

azu · azu · commit 632ab624153d · 2016-06-30T23:02:42.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,91 @@
+# textlint-rule-ja-no-mixed-period
+
+文末の句点(。)の統一 OR 抜けをチェックするtextlintルール
+
+```
+OK: これは問題ない文章です。
+NG: これは問題ある文章です
+```
+パラグラフの末尾に必ず句点記号を付けていることをチェックするルールです。
+
+
+## Install
+
+Install with [npm](https://www.npmjs.com/):
+
+    npm install textlint-rule-ja-no-mixed-period
+
+## Usage
+
+Via `.textlintrc`(Recommended)
+
+```json
+{
+    "rules": {
+        "ja-no-mixed-period": true
+    }
+}
+```
+
+Via CLI
+
+```
+textlint --rule ja-no-mixed-period README.md
+```
+
+## Options
+
+- `periodMark`(string):
+    - 文末に使用する句点文字
+    - デフォルト: "。"
+
+```json
+{
+    "rules": {
+        "ja-no-mixed-period": {
+            "periodMark": "。"
+        }
+    }
+}
+```
+
+## 参考情報
+
+- [句点 - Wikipedia](https://ja.wikipedia.org/wiki/%E5%8F%A5%E7%82%B9 "句点 - Wikipedia")
+- [小説家になろう Hint&Tips - 区切り符号について](http://ncode.syosetu.com/n8977bb/12/ "小説家になろう Hint&amp;Tips - 区切り符号について")
+
+末尾に`。`がない場合でも、代わりに感嘆符や疑問符、括弧などがある場合は例外として扱います。
+
+> これは問題ない文章ですか！？
+> 「会話文は括弧で括れば末尾に。がなくても問題ありません」
+
+## Changelog
+
+See [Releases page](https://github.com/azu/textlint-rule-ja-no-mixed-period/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-ja-no-mixed-period/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](https://twitter.com/azu_re)
+
+## License
+
+MIT © azu
diff --git a/package.json b/package.json
@@ -0,0 +1,43 @@
+{
+  "name": "textlint-rule-ja-no-mixed-period",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/azu/textlint-rule-ja-no-mixed-period.git"
+  },
+  "author": "azu",
+  "email": "azuciao@gmail.com",
+  "homepage": "https://github.com/azu/textlint-rule-ja-no-mixed-period",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/azu/textlint-rule-ja-no-mixed-period/issues"
+  },
+  "files": [
+    "src/",
+    "lib/"
+  ],
+  "version": "1.0.0",
+  "description": "文末の句点(。)の統一 OR 抜けをチェックするtextlintルール",
+  "main": "lib/textlint-rule-ja-no-mixed-period.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.10.1",
+    "babel-preset-es2015": "^6.9.0",
+    "babel-preset-jsdoc-to-assert": "^2.0.1",
+    "babel-preset-power-assert": "^1.0.0",
+    "babel-register": "^6.9.0",
+    "mocha": "^2.5.3",
+    "power-assert": "^1.4.1",
+    "textlint-tester": "^2.0.0"
+  }
+}
diff --git a/src/textlint-rule-ja-no-mixed-period.js b/src/textlint-rule-ja-no-mixed-period.js
@@ -0,0 +1,53 @@
+// LICENSE : MIT
+"use strict";
+const exceptionMarkRegExp = /[!?！？\)）」 』]/;
+const defaultPeriodMark = /[。\.]/;
+const defaultOptions = {
+    // 優先する句点文字
+    periodMark: "。"
+};
+const reporter = (context, options = {}) => {
+    const {Syntax, RuleError, report, fixer, getSource} = context;
+    const periodMark = options.periodMark || defaultOptions.periodMark;
+    return {
+        [Syntax.Paragraph](node){
+            const lastNode = node.children[node.children.length - 1];
+            if (lastNode === undefined || lastNode.type !== Syntax.Str) {
+                return;
+            }
+            const lastStrText = getSource(lastNode);
+            const lastIndex = lastStrText.length - 1;
+            const lastChar = lastStrText[lastIndex];
+            if (lastChar === undefined) {
+                return;
+            }
+            // 例外: 感嘆符
+            // 例外: 「」 () （）『』
+            // http://ncode.syosetu.com/n8977bb/12/
+            // https://ja.wikipedia.org/wiki/%E7%B5%82%E6%AD%A2%E7%AC%A6
+            if (exceptionMarkRegExp.test(lastChar)) {
+                return;
+            }
+            if (lastChar === periodMark) {
+                return;
+            }
+
+            let fix = null;
+            if (defaultPeriodMark.test(lastChar)) {
+                fix = fixer.replaceTextRange([lastIndex, lastIndex + 1], periodMark);
+            } else {
+                fix = fixer.replaceTextRange([lastIndex + 1, lastIndex + 1], periodMark);
+            }
+            report(lastNode, new RuleError(`文末が"${periodMark}"で終わっていません。`, {
+                index: lastIndex,
+                fix
+            }));
+
+        }
+    }
+};
+
+module.exports = {
+    linter: reporter,
+    fixer: reporter
+};
diff --git a/test/mocha.opts b/test/mocha.opts
@@ -0,0 +1 @@
+--compilers js:babel-register
diff --git a/test/textlint-rule-ja-no-mixed-period-test.js b/test/textlint-rule-ja-no-mixed-period-test.js
@@ -0,0 +1,71 @@
+const TextLintTester = require("textlint-tester");
+const tester = new TextLintTester();
+import rule from "../src/textlint-rule-ja-no-mixed-period";
+tester.run("textlint-rule-ja-no-mixed-period", rule, {
+    valid: [
+        "これは問題ないです。",
+        "1行目。\n2行目。\n3行目。",
+        "1行目。  \nHard Breakを入れるパターン。",
+        "1行目  空白はあるけど末尾に句点はある。",
+        // 感嘆符などが末尾にある場合は問題なし
+        "末尾に句点はある!"
+    ],
+    invalid: [
+        // single match
+        {
+            text: "これは句点がありません",
+            output: "これは句点がありません。",
+            errors: [
+                {
+                    message: `文末が"。"で終わっていません。`,
+                    line: 1,
+                    column: 11
+                }
+            ]
+        },
+        // multiple match in multiple lines
+        {
+            text: "これは句点がありません\n\nこれは句点がありません",
+            output: "これは句点がありません。\n\nこれは句点がありません。",
+            errors: [
+                {
+                    message: `文末が"。"で終わっていません。`,
+                    line: 1,
+                    column: 11
+                },
+                {
+                    message: `文末が"。"で終わっていません。`,
+                    line: 3,
+                    column: 11
+                }
+            ]
+        },
+        // multiple hit items in a line
+        {
+            text: "これは句点がありません、これは句点がありません",
+            output: "これは句点がありません、これは句点がありません。",
+            errors: [
+                {
+                    message: `文末が"。"で終わっていません。`,
+                    line: 1,
+                    column: 23
+                }
+            ]
+        },
+        // options
+        {
+            text: "This is error",
+            output: "This is error.",
+            options: {
+                periodMark: "."
+            },
+            errors: [
+                {
+                    message: `文末が"."で終わっていません。`,
+                    line: 1,
+                    column: 13
+                }
+            ]
+        }
+    ]
+});

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"`