Textlint

.circleci/config.yml

@@ -88,6 +88,17 @@ jobs:
             - danger/vendor/bundle
           key: v1-danger-dependencies-{{ checksum "danger/Gemfile.lock" }}
 
+      - restore_cache:
+          keys:
+            - v1-danger-yarn-{{ checksum "yarn.lock" }}
+            - v1-danger-yarn
+      - run:
+          command: yarn install
+      - save_cache:
+          key: v1-danger-yarn-{{ checksum "yarn.lock" }}
+          paths:
+            - node_modules
+
       - run:
           # git rootで動かす必要がある
           command: bundle exec danger --verbose --dangerfile=danger/Dangerfile

.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+yarn-debug.log*
+yarn-error.log*

.textlintrc

@@ -0,0 +1,14 @@
+{
+    "rules": {
+        "preset-ja-technical-writing": true,
+        "spellcheck-tech-word": true
+    },
+    "filters": {
+        "comments": true,
+        "whitelist": {
+          "allow": [
+               // ....
+          ]
+        }
+    }
+}

danger/Dangerfile

@@ -14,3 +14,5 @@ fail("fit left in tests") if `grep -r fit specs/ `.length > 1
 
 # rubocop
 rubocop.lint inline_comment: true
+
+textlint.lint

danger/Gemfile

@@ -2,6 +2,7 @@ source 'https://rubygems.org'
 
 gem "danger"
 gem "danger-rubocop"
+gem "danger-textlint"
 gem "onkcop"
 gem "pry"
 gem "pry-byebug"

danger/Gemfile.lock

@@ -26,9 +26,13 @@ GEM
       no_proxy_fix
       octokit (~> 4.7)
       terminal-table (~> 1)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
     danger-rubocop (0.6.0)
       danger
       rubocop
+    danger-textlint (1.2.1)
+      danger-plugin-api (~> 1.0)
     faraday (0.15.2)
       multipart-post (>= 1.2, < 3)
     faraday-http-cache (1.3.1)
@@ -82,6 +86,7 @@ PLATFORMS
 DEPENDENCIES
   danger
   danger-rubocop
+  danger-textlint
   onkcop
   pry
   pry-byebug

package.json

@@ -0,0 +1,10 @@
+{
+  "name": "danger-sample-danger",
+  "dependencies": {
+    "textlint": "^11.0.0",
+    "textlint-filter-rule-comments": "^1.2.2",
+    "textlint-filter-rule-whitelist": "^2.0.0",
+    "textlint-rule-preset-ja-technical-writing": "^3.1.0",
+    "textlint-rule-spellcheck-tech-word": "^5.0.0"
+  }
+}

sample-project/README.md

@@ -22,3 +22,5 @@ Things you may want to cover:
 * Deployment instructions
 
 * ...
+
+インターフェース