initial commit

Author: azu

.babelrc

@@ -0,0 +1,4 @@
+{
+  "presets": ["es2015"],
+  "plugins": ["add-module-exports"]
+}

.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

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.

README.md

@@ -0,0 +1,58 @@
+# textlint-rule-alex
+
+[textlint](https://github.com/textlint/textlint "textlint") rule for [ALEX](http://alexjs.com/ "ALEX").
+
+> Whether your own or someone else’s writing, alex helps you find gender favouring, polarising, race related, religion inconsiderate, or other unequal phrasing.  
+> -- [wooorm/alex: Catch insensitive, inconsiderate writing](https://github.com/wooorm/alex#alexvalue-allow "wooorm/alex: Catch insensitive, inconsiderate writing")
+
+## Installation
+
+    npm install textlint-rule-alex
+
+## Usage
+
+Via `.textlintrc`(Recommended)
+
+```json
+{
+    "rules": {
+        "alex": {
+            "allow": []
+        }
+    }
+}
+```
+
+Via CLI
+
+## Options
+
+### `allow`
+
+See Alex's document: [Ignoring messages](https://github.com/wooorm/alex#ignoring-messages "Ignoring messages")
+
+```json
+{
+    "rules": {
+        "alex": {
+             "allow": ["boogeyman-boogeywoman"]
+        }
+    }
+}
+```
+
+## Tests
+
+    npm test
+
+## Contributing
+
+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
+
+## License
+
+MIT

package.json

@@ -0,0 +1,46 @@
+{
+  "name": "textlint-rule-alex",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/azu/textlint-rule-alex.git"
+  },
+  "author": "azu",
+  "email": "[email protected]",
+  "homepage": "https://github.com/azu/textlint-rule-alex",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/azu/textlint-rule-alex/issues"
+  },
+  "version": "1.0.0",
+  "description": "textlint rule for alex",
+  "main": "lib/textlint-rule-alex.js",
+  "files": [
+    "lib",
+    "src"
+  ],
+  "directories": {
+    "test": "test"
+  },
+  "scripts": {
+    "build": "babel src --out-dir lib --source-maps",
+    "watch": "babel src --out-dir lib --watch --source-maps",
+    "prepublish": "npm run --if-present build",
+    "test": "mocha"
+  },
+  "keywords": [
+    "textlint",
+    "alex"
+  ],
+  "devDependencies": {
+    "babel-cli": "^6.5.1",
+    "babel-plugin-add-module-exports": "^0.1.2",
+    "babel-preset-es2015": "^6.5.0",
+    "babel-register": "^6.5.2",
+    "mocha": "^2.4.5",
+    "textlint-tester": "^0.4.1"
+  },
+  "dependencies": {
+    "alex": "^2.0.1",
+    "textlint-rule-helper": "^1.1.5"
+  }
+}

src/textlint-rule-alex.js

@@ -0,0 +1,44 @@
+// LICENSE : MIT
+"use strict";
+import {RuleHelper} from "textlint-rule-helper";
+import alex from "alex";
+const defaultOptions = {
+    allow: []
+};
+export default function textlintRuleAlex(context, options = {}) {
+    const {Syntax, RuleError, report, getSource} = context;
+    const helper = new RuleHelper(context);
+    const allowWords = options.allow || defaultOptions.allow;
+    /*
+    { [1:5-1:14: `boogeyman` may be insensitive, use `boogey` instead]
+    message: '`boogeyman` may be insensitive, use `boogey` instead',
+    name: '1:5-1:14',
+    file: '',
+    reason: '`boogeyman` may be insensitive, use `boogey` instead',
+    line: 1,
+    column: 5,
+    location: Position { start: [Object], end: [Object] },
+    fatal: false,
+    ruleId: 'boogeyman-boogeywoman',
+    source: 'retext-equality' }
+     */
+    const reportError = (node, result) => {
+        const ruleError = new RuleError(`[${result.ruleId}] ${result.message}`, {
+            line: result.line - 1,
+            column: result.column - 1
+        });
+        report(node, ruleError);
+    };
+    return {
+        [Syntax.Str](node){
+            if (helper.isChildNode(node, [Syntax.Link, Syntax.Image, Syntax.BlockQuote, Syntax.Emphasis])) {
+                return;
+            }
+            const text = getSource(node);
+            const messages = alex.text(text, allowWords).messages;
+            messages.forEach((result) => {
+                reportError(node, result);
+            });
+        }
+    }
+}

test/mocha.opts

@@ -0,0 +1 @@
+--compilers js:babel-register

test/textlint-rule-alex-test.js

@@ -0,0 +1,25 @@
+// LICENSE : MIT
+"use strict";
+var TextLintTester = require("textlint-tester");
+// rules
+var rule = require("../src/textlint-rule-alex");
+var tester = new TextLintTester();
+// ruleName, rule, expected[]
+tester.run("alex", rule, {
+    valid: [
+        "This is a pen",
+        "男女"
+    ],
+    invalid: [
+        {
+            text: "The boogeyman",
+            errors: [
+                {
+                    message: "[boogeyman-boogeywoman] `boogeyman` may be insensitive, use `boogey` instead",
+                    line: 1,
+                    column: 5
+                }
+            ]
+        }
+    ]
+});