refactor(radme): remove introduction and update readme

azu · azu · commit ece4d7414845 · 2016-06-03T21:26:35.000+09:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,9 +1,52 @@
-# Contributeのやりかた
+# Contribute
+
+## Installation
+
+インストールにはNode.jsが必要です
+
+    git clone https://github.com/azu/JavaScript-Plugin-Architecture.git
+    cd JavaScript-Plugin-Architecture
+    npm install
+
+## Usage
+
+この書籍は[GitBook](https://github.com/GitbookIO/gitbook "GitBook")を使い書かれています。
+
+### 表示の確認
+
+`npm start`でGitBookのローカルサーバを立ち上げて表示を確認出来ます。
+
+    npm start
+
+### テスト
+
+`npm test`でコードや文章の単語チェックを行えます
+
+    npm test
+
+### 文章カバレッジ
+
+[textlint](https://github.com/textlint/textlint "textlint")と[textlint-formatter-codecov](https://github.com/azu/textlint-formatter-codecov "textlint-formatter-codecov")を使って出してる文章に対するカバレッジ
+
+100％を理想的目標として、それに対する現実的な値をカバレッジの％として表現しています。
+
+[![codecov.io](https://codecov.io/github/azu/JavaScript-Plugin-Architecture/coverage.svg?branch=master)](https://codecov.io/github/azu/JavaScript-Plugin-Architecture?branch=master)
+
+![coverage graph](https://codecov.io/github/azu/JavaScript-Plugin-Architecture/branch.svg?branch=master)
+
+現在の文章カバレッジは以下のコマンドでも確認することができます。
+
+```
+npm run textlint:coverage
+```
+
+## Contributeのやりかた
 
 この書籍ではJavaScriptにおけるプラグインアーキテクチャを色々なライブラリやツールを元に紹介する形をとっています。
 
 Contributeは大きく分けて、既存の文章の修正や執筆とProposalの提案などがあります。
 
+
 ## 文章の修正
 
 typoなどを見つけた場合は、1文字の修正からでも問題無いので、Pull Requestを送っていただけると助かります。
diff --git a/ORGANIZATION.md b/ORGANIZATION.md
@@ -1,34 +0,0 @@
-# この書籍の内容について
-
-## [Introduction](ja/introduction/README.md)
-
-この書籍の目的について書かれています。
-なぜプラグインアーキテクチャを学ぶ必要があるのか、どのようにして学ぶことができるのかについて書かれています。
-
-## [jQuery](ja/jQuery/README.md)
-
-jQueryのプラグインについて解説しています。
-`<script>`タグをベースとしたプラグインアーキテクチャについて解説しています。
-
-## [ESLint](ja/ESLint/README.md)
-
-ESLintのルールを拡張する仕組みについて解説しています。
-ESLintではJavaScriptのコードをパースして作成されたASTを元にコードのLintを行います。
-実際にESLintのルールを解釈できる小さな実装を作りながらプラグインの仕組みについて学びます。
-
-## [Connect](ja/connect/README.md)
-
-Connectの **middleware** と呼ばれるプラグインアーキテクチャについて解説しています。
-Node.js以外においても_Rack_などHTTPサーバーでよく見られるプラグインを使った階層構造について学びます。
-
-## [gulp](ja/gulp/README.md)
-
-**タスク自動化ツール** であるgulpのプラグインアーキテクチャについて解説しています。
-gulpではデータの流れとして既存のNode.js Streamを使い、そこで流すデータとしてvinylオブジェクトを利用します。
-実際にgulpプラグインを書きながら、gulpのプラグインの仕組みについて学びます。
-
-## [Redux](ja/Redux/README.md)
-
-アプリケーションのStateを管理するライブラリであるReduxのプラグインアーキテクチャについて解説しています。
-Reduxでは **Middleware** と呼ばれる拡張の仕組みを持っていますが、Connectとの類似点や相違点があります。
-小さなReduxの実装を作りながら **Middleware** の仕組みについて学びます。
diff --git a/README.md b/README.md
@@ -6,58 +6,59 @@
 
 JavaScriptの世界では1つの大きなライブラリよりも小さいなものを組み合わせていくようなスタイルが多く見られます。
 
-小さなものを組み合わせて使えるようなエコシステムの土台となるものを書く際には、プラグインアーキテクチャが重要になると言えます。
+小さなものを組み合わせて使えるようなエコシステムの土台を作るには、プラグインアーキテクチャが重要になると言えます。
 
-> ソフトウェアの構造に「プラグイン機構」を設け、ユーザコミュニティから開発者コミュニティへの質的な転換を図るのは、ソフトウェア設計からエコシステム設計へとつながる
+> ソフトウェアの構造に「プラグイン機構」を設け、ユーザコミュニティから開発者コミュニティへの質的な転換を図るのは、ソフトウェア設計からエコシステム設計へとつながる  
 > -- [OSS開発の活発さの維持と良いソフトウェア設計の間には緊張関係があるのだろうか? - t-wadaのブログ](http://t-wada.hatenablog.jp/entry/active-oss-development-vs-simplicity "OSS開発の活発さの維持と良いソフトウェア設計の間には緊張関係があるのだろうか? - t-wadaのブログ")
 
-この書籍では、そのプラグインアーキテクチャ、そのエコシステムを形成してるライブラリやツールなどの実装を学ぶことが目的となっています。
+この書籍では、JavaScriptにおけるプラグインアーキテクチャ、そのエコシステムを形成してるライブラリやツールなどの実装を学ぶことが目的となっています。
 
-## Installation
-
-    npm install
-
-## Usage
-
-この書籍は[GitBook](https://github.com/GitbookIO/gitbook "GitBook")を使い書かれています。
+## Contributing
 
-### 表示の確認
+この書籍は無料で読みことができ、同時に修正や新しいページを書く権利があります。
 
-`npm start`でGitBookのローカルサーバを立ち上げて表示を確認出来ます。
+[CONTRIBUTING.md](https://github.com/azu/JavaScript-Plugin-Architecture/blob/master/CONTRIBUTING.md)に、書籍で扱うべきプラグインアーキテクチャのProposalの書き方や
+Pull Request、コミットのやりかたなどが書かれています。
 
-    npm start
+間違いやライブラリのアップデートへの追従など何かあれば、IssueやPull Requestをよろしくお願いします。
 
-### テスト
+ソースコードは全てGitHubに公開されています。
 
-`npm test`でコードや文章の単語チェックを行えます
+- [azu/JavaScript-Plugin-Architecture](https://github.com/azu/JavaScript-Plugin-Architecture)
 
-    npm test
+## License
 
-### 文章カバレッジ
+MIT/CC BY-NC © azu
 
-[textlint](https://github.com/textlint/textlint "textlint")と[textlint-formatter-codecov](https://github.com/azu/textlint-formatter-codecov "textlint-formatter-codecov")を使って出してる文章に対するカバレッジ
+- コードはMITライセンスで利用できます
+- 文章は[CC BY-NC 4.0](http://creativecommons.org/licenses/by-nc/4.0/ "CC BY-NC 4.0")で利用できます
 
-100％を理想的目標として、それに対する現実的な値をカバレッジの％として表現しています。
+## この書籍の内容について
 
-[![codecov.io](https://codecov.io/github/azu/JavaScript-Plugin-Architecture/coverage.svg?branch=master)](https://codecov.io/github/azu/JavaScript-Plugin-Architecture?branch=master)
+### [jQuery](ja/jQuery/README.md)
 
-![coverage graph](https://codecov.io/github/azu/JavaScript-Plugin-Architecture/branch.svg?branch=master)
+jQueryのプラグインについて解説しています。
+`<script>`タグをベースとしたプラグインアーキテクチャについて解説しています。
 
-現在の文章カバレッジは以下のコマンドでも確認することができます。
+### [ESLint](ja/ESLint/README.md)
 
-```
-npm run textlint:coverage
-```
+ESLintのルールを拡張する仕組みについて解説しています。
+ESLintではJavaScriptのコードをパースして作成されたASTを元にコードのLintを行います。
+実際にESLintのルールを解釈できる小さな実装を作りながらプラグインの仕組みについて学びます。
 
-## Contributing
+### [Connect](ja/connect/README.md)
 
-[CONTRIBUTING.md](./CONTRIBUTING.md)に、書籍で扱うべきプラグインアーキテクチャのProposalの書き方や
-Pull Request、コミットのやりかたなどが書かれています。
+Connectの **middleware** と呼ばれるプラグインアーキテクチャについて解説しています。
+Node.js以外においても_Rack_などHTTPサーバーでよく見られるプラグインを使った階層構造について学びます。
 
-## License
+### [gulp](ja/gulp/README.md)
 
-© azu
+**タスク自動化ツール** であるgulpのプラグインアーキテクチャについて解説しています。
+gulpではデータの流れとして既存のNode.js Streamを使い、そこで流すデータとしてvinylオブジェクトを利用します。
+実際にgulpプラグインを書きながら、gulpのプラグインの仕組みについて学びます。
 
-コードはMITライセンスで利用できます。
-文章は[CC BY-NC 4.0](http://creativecommons.org/licenses/by-nc/4.0/ "CC BY-NC 4.0")で利用できます。
+### [Redux](ja/Redux/README.md)
 
+アプリケーションのStateを管理するライブラリであるReduxのプラグインアーキテクチャについて解説しています。
+Reduxでは **Middleware** と呼ばれる拡張の仕組みを持っていますが、Connectとの類似点や相違点があります。
+小さなReduxの実装を作りながら **Middleware** の仕組みについて学びます。
diff --git a/ja/introduction/README.md b/ja/introduction/README.md
diff --git a/ja/jQuery/README.md b/ja/jQuery/README.md
@@ -110,7 +110,7 @@ calculator.fn = calculator.prototype;
 
 ## まとめ
 
-ここではjQueryプラグインの仕組みや実装について学びました。
+ここではjQueryのプラグインアーキテクチャについて学びました。
 
 - jQueryプラグインは `jQuery.fn` を拡張する
 - `jQuery.fn` は `jQuery.prototype` と同じである
diff --git a/test/keywords-test.js b/test/keywords-test.js
@@ -10,7 +10,7 @@ import isUnist from "unist-util-is";
 import nlcstToString  from "nlcst-to-string";
 
 const rootDir = path.join(__dirname, "..");
-const OrganizationText = fs.readFileSync(path.join(rootDir, "ORGANIZATION.md"), "utf-8");
+const OrganizationText = fs.readFileSync(path.join(rootDir, "README.md"), "utf-8");
 function isNotContain(content, keywords) {
     // 含んでないものだけを返す
     return keywords.filter(keyword => {
@@ -57,9 +57,11 @@ function getKeywordsOfParagraphsAsync(paragraphs) {
 }
 function checkKeyword(text) {
     let ast = remark.parse(text);
-    let headerLinks = select(parents(ast), "heading link[href]");
-    let paragraphList = headerLinks.map(link => {
-        let filePath = path.resolve(rootDir, link.href);
+    let headerLinks = select(parents(ast), "heading link[url]");
+    let paragraphList = headerLinks.filter(link => {
+        return /ja/.test(link.url);
+    }).map(link => {
+        let filePath = path.resolve(rootDir, link.url);
         let paragraphs = findAllAfter(ast, link.parent.node, "paragraph");
         return getKeywordsOfParagraphsAsync(paragraphs).then(keywords => {
             return {
