Skip to content

Commit d9b4571

Browse files
committed
Revert "GitBook: [master] 14 pages and 6 assets modified"
This reverts commit 4e94151.
1 parent 4e94151 commit d9b4571

14 files changed

+980
-871
lines changed

contributing.md CONTRIBUTING.md

+32-33
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
# CONTRIBUTING
1+
# Contribute
22

33
## Installation
44

55
インストールにはNode.jsが必要です
66

7-
```text
8-
git clone https://github.com/azu/JavaScript-Plugin-Architecture.git
9-
cd JavaScript-Plugin-Architecture
10-
npm install
11-
```
7+
git clone https://github.com/azu/JavaScript-Plugin-Architecture.git
8+
cd JavaScript-Plugin-Architecture
9+
npm install
1210

1311
## Usage
1412

@@ -18,29 +16,25 @@ npm install
1816

1917
`npm start`[HonKit](https://github.com/honkit/honkit)のローカルサーバを立ち上げて表示を確認できます。
2018

21-
```text
22-
npm start
23-
```
19+
npm start
2420

2521
### テスト
2622

2723
`npm test`でコードや文章の単語チェックを行えます
2824

29-
```text
30-
npm test
31-
```
25+
npm test
3226

3327
### 文章カバレッジ
3428

35-
[textlint](https://github.com/textlint/textlint)[textlint-formatter-codecov](https://github.com/azu/textlint-formatter-codecov)を使って出してる文章に対するカバレッジ
29+
[textlint](https://github.com/textlint/textlint "textlint")[textlint-formatter-codecov](https://github.com/azu/textlint-formatter-codecov "textlint-formatter-codecov")を使って出してる文章に対するカバレッジ
3630

3731
100%を理想的目標として、それに対する現実的な値をカバレッジの%として表現しています。
3832

39-
* [https://codecov.io/github/azu/JavaScript-Plugin-Architecture?branch=master](https://codecov.io/github/azu/JavaScript-Plugin-Architecture?branch=master)
33+
- https://codecov.io/github/azu/JavaScript-Plugin-Architecture?branch=master
4034

4135
現在の文章カバレッジは次のコマンドでも確認できます。
4236

43-
```text
37+
```
4438
npm run textlint:coverage
4539
```
4640

@@ -50,27 +44,31 @@ npm run textlint:coverage
5044

5145
Contributeは大きく分けて、既存の文章の修正や執筆とProposalの提案などがあります。
5246

47+
5348
## 文章の修正
5449

5550
typoなどを見つけた場合は、1文字の修正からでも問題無いので、Pull Requestを送っていただけると助かります。
5651

5752
表記揺れを発見した場合は単純にIssueを立ててもらうか、Pull Requestでの修正をいただけると嬉しいです。
5853

59-
また、この書籍では[test/prh-rule.yaml](https://github.com/azu/javaScript-plugin-architecture/tree/ba76aad2d15c478071fdb7e0a9702d120f1da575/test/prh-rule.yaml)で定義した辞書を使い表記揺れを辞書でテストできるようにしています。 辞書による表記揺れの検知が可能なら、そちらも合わせてご指摘いただけるとありがたいです。
54+
また、この書籍では[test/prh-rule.yaml](test/prh-rule.yaml)で定義した辞書を使い表記揺れを辞書でテストできるようにしています。
55+
辞書による表記揺れの検知が可能なら、そちらも合わせてご指摘いただけるとありがたいです。
6056

61-
* [textlint + prhで表記ゆれを検出する \| Web Scratch](http://efcl.info/2015/09/14/textlint-rule-prh/)
57+
- [textlint + prhで表記ゆれを検出する | Web Scratch](http://efcl.info/2015/09/14/textlint-rule-prh/ "textlint + prhで表記ゆれを検出する | Web Scratch")
6258

6359
## 新しいプラグインの仕組みを書く
6460

6561
この書籍に載せたいプラグインアーキテクチャがある場合は、Issueを立ててください。
6662

67-
たとえば、XXXというライブラリ/ツールのアーキテクチャについてのIssueを立てる場合、 次のようなことが1行とかでもいいので書かれているとよさそうです。
63+
たとえば、XXXというライブラリ/ツールのアーキテクチャについてのIssueを立てる場合、
64+
次のようなことが1行とかでもいいので書かれているとよさそうです。
6865

69-
仕組みについて調べるのが大変な場合は、あとで調べれば問題ないため空欄で問題ありません。 JavaScriptはとにかく柔軟な言語なので、こういうプラグインの形式を取ってるというのを知らせるだけでも有用だと思います。
66+
仕組みについて調べるのが大変な場合は、あとで調べれば問題ないため空欄で問題ありません。
67+
JavaScriptはとにかく柔軟な言語なので、こういうプラグインの形式を取ってるというのを知らせるだけでも有用だと思います。
7068

7169
新しいプラグインの仕組みについて書く場合は、次のテンプレートを参照してください。
7270

73-
```text
71+
```
7472
# XXXのアーキテクチャ
7573
7674
## どう書ける?
@@ -111,33 +109,33 @@ typoなどを見つけた場合は、1文字の修正からでも問題無いの
111109

112110
以下からこのテンプレートで使ったIssueを立てることができます。
113111

114-
* [新しいProposalを書く](https://github.com/azu/JavaScript-Plugin-Architecture/issues/new?assignees=&labels=Status%3A+Proposal&template=proposal.md&title=)
112+
- [新しいProposalを書く](https://github.com/azu/JavaScript-Plugin-Architecture/issues/new?assignees=&labels=Status%3A+Proposal&template=proposal.md&title=)
115113

116114
### Proposalの具体例
117115

118116
現在ある[Proposal一覧](https://github.com/azu/JavaScript-Plugin-Architecture/labels/proposal)を参考にしてみるとよいかもしれません。
119117

120-
* [jQuery Plugin · Issue \#8 · azu/JavaScript-Plugin-Architecture](https://github.com/azu/JavaScript-Plugin-Architecture/issues/8)
118+
- [jQuery Plugin · Issue #8 · azu/JavaScript-Plugin-Architecture](https://github.com/azu/JavaScript-Plugin-Architecture/issues/8 "jQuery Plugin · Issue #8 · azu/JavaScript-Plugin-Architecture")
121119

122120
## テスト
123121

124122
`$ npm test` を実行するとコードや文章に対するテストが実行されます。
125123

126-
```bash
124+
```sh
127125
npm test
128126
```
129127

130-
文章は[textlint](https://github.com/azu/textlint)による単語のチェックが行われます。
128+
文章は[textlint](https://github.com/azu/textlint "textlint")による単語のチェックが行われます。
131129

132130
## コミットメッセージ
133131

134132
AngularJSのGit Commit Guidelinesをベースとしています。
135133

136-
* [conventional-changelog/angular.md at master · ajoslin/conventional-changelog](https://github.com/ajoslin/conventional-changelog/blob/master/conventions/angular.md)
134+
- [conventional-changelog/angular.md at master · ajoslin/conventional-changelog](https://github.com/ajoslin/conventional-changelog/blob/master/conventions/angular.md "conventional-changelog/angular.md at master · ajoslin/conventional-changelog")
137135

138-
次のような形で1行目に概要、3行目から本文、最後に関連するIssue\(任意\)を書きます。
136+
次のような形で1行目に概要、3行目から本文、最後に関連するIssue(任意)を書きます。
139137

140-
```text
138+
```
141139
feat(ngInclude): add template url parameter to events
142140
143141
The `src` (i.e. the url of the template to load) is now provided to the
@@ -148,7 +146,8 @@ Closes #8453
148146
Closes #8454
149147
```
150148

151-
```text
149+
150+
```
152151
scope commit title
153152
154153
commit type / /
@@ -165,14 +164,14 @@ Closes #8454
165164

166165
1行の`feat``fix`といったcommit typeは、迷ったらとりあえず`chore`と書いて、`scope`も省略して問題ないので次のような形でも問題ありません。
167166

168-
```text
167+
```
169168
chore: コミットメッセージ
170169
```
171170

172-
このコミットメッセージの規約は[conventional-changelog](https://github.com/ajoslin/conventional-changelog)による自動生成のためでもありますが、 取り込むときに調整できるので無視してもらっても問題はありません。
171+
このコミットメッセージの規約は[conventional-changelog](https://github.com/ajoslin/conventional-changelog "conventional-changelog")による自動生成のためでもありますが、
172+
取り込むときに調整できるので無視してもらっても問題はありません。
173173

174174
以下を見てみるとよいかもしれません。
175175

176-
* [良いChangeLog、良くないChangeLog \| Web Scratch](http://efcl.info/2015/06/18/good-changelog/)
177-
* [われわれは、いかにして変更点を追うか](http://azu.github.io/slide/cto/changelog.html)
178-
176+
- [良いChangeLog、良くないChangeLog | Web Scratch](http://efcl.info/2015/06/18/good-changelog/ "良いChangeLog、良くないChangeLog | Web Scratch")
177+
- [われわれは、いかにして変更点を追うか](http://azu.github.io/slide/cto/changelog.html "われわれは、いかにして変更点を追うか")

README.md

+49-33
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,100 @@
1-
# この書籍について
2-
3-
{% hint style="danger" %}
4-
この書籍は [https://azu.github.io/JavaScript-Plugin-Architecture/](https://azu.github.io/JavaScript-Plugin-Architecture/) に移行しました。
5-
6-
このページは更新されていません。
7-
{% endhint %}
1+
# JavaScript Plugin Architecture [![Actions Status: test](https://github.com/azu/JavaScript-Plugin-Architecture/workflows/test/badge.svg)](https://github.com/azu/JavaScript-Plugin-Architecture/actions?query=workflow%3A"test")
82

93
この書籍はJavaScriptのライブラリやツールにおけるプラグインアーキテクチャについて見ていくことを目的としたものです。
104

115
次の形式で読むことができます。
126

13-
* [Web版](https://azu.github.io/JavaScript-Plugin-Architecture/)
14-
* [PDF形式](https://azu.github.io/JavaScript-Plugin-Architecture/JavaScript-Plugin-Architecture.pdf)
15-
* [ePub形式](https://azu.github.io/JavaScript-Plugin-Architecture/JavaScript-Plugin-Architecture.epub)
16-
* [Mobi形式](https://azu.github.io/JavaScript-Plugin-Architecture/JavaScript-Plugin-Architecture.mobi)
7+
- [Web版](https://azu.github.io/JavaScript-Plugin-Architecture/)
8+
- [PDF形式](https://azu.github.io/JavaScript-Plugin-Architecture/JavaScript-Plugin-Architecture.pdf)
9+
- [ePub形式](https://azu.github.io/JavaScript-Plugin-Architecture/JavaScript-Plugin-Architecture.epub)
10+
- [Mobi形式](https://azu.github.io/JavaScript-Plugin-Architecture/JavaScript-Plugin-Architecture.mobi)
1711

1812
この書籍のソースコードは、次のGitHubリポジトリに公開されています。
1913

20-
* [azu/JavaScript-Plugin-Architecture: JavaScriptプラグインアーキテクチャの本](https://github.com/azu/JavaScript-Plugin-Architecture)
14+
- [azu/JavaScript-Plugin-Architecture: JavaScriptプラグインアーキテクチャの本](https://github.com/azu/JavaScript-Plugin-Architecture)
2115

22-
Twitterのハッシュタグは[\#js\_plugin\_book](https://twitter.com/search?f=tweets&q=%23js_plugin_book&src=typd)
16+
Twitterのハッシュタグは[#js_plugin_book](https://twitter.com/search?f=tweets&q=%23js_plugin_book&src=typd "Twitter #js_plugin_book")
2317

2418
更新情報は[RSS](https://github.com/azu/JavaScript-Plugin-Architecture/releases.atom)[リリースノート](https://github.com/azu/JavaScript-Plugin-Architecture/releases)から見ることができます。
2519

20+
21+
<!-- textlint-disable -->
22+
23+
{% if output.name != "ebook" %}
24+
25+
<a aria-label="Star azu/JavaScript-Plugin-Architecture on GitHub" href="https://github.com/azu/JavaScript-Plugin-Architecture" class="github-button"><img src="https://monosnap.com/file/MZsfLjZNkSNwTJ33apkwpBjlBZLbSh.png" alt="GitHub"></a> <a href="http://b.hatena.ne.jp/entry/https://github.com/azu/JavaScript-Plugin-Architecture" class="hatena-bookmark-button" data-hatena-bookmark-title="JavaScript Plugin Architecture" data-hatena-bookmark-layout="standard-balloon" data-hatena-bookmark-lang="ja" title="はてなブックマークに追加"><img src="https://b.st-hatena.com/images/entry-button/[email protected]" alt="はてなブックマークに追加" width="20" height="20" style="border: none;" /></a>
26+
27+
{% endif %}
28+
29+
<!-- textlint-enable -->
30+
31+
2632
## はじめに
2733

28-
JavaScriptの世界では1つの大きなライブラリよりも小さなライブラリを組み合わせていくようなスタイルが多く見られます。 小さなものを組み合わせて作るためには、プラグインと呼ばれる拡張の仕組みが必要となります。 またそのようなプラグインがたくさんあるエコシステムの土台を作るには、プラグインアーキテクチャが重要になるといえます。
34+
JavaScriptの世界では1つの大きなライブラリよりも小さなライブラリを組み合わせていくようなスタイルが多く見られます。
35+
小さなものを組み合わせて作るためには、プラグインと呼ばれる拡張の仕組みが必要となります。
36+
またそのようなプラグインがたくさんあるエコシステムの土台を作るには、プラグインアーキテクチャが重要になるといえます。
2937

3038
> ソフトウェアの構造に「プラグイン機構」を設け、ユーザコミュニティから開発者コミュニティへの質的な転換を図るのは、ソフトウェア設計からエコシステム設計へとつながる
31-
> -- [OSS開発の活発さの維持と良いソフトウェア設計の間には緊張関係があるのだろうか? - t-wadaのブログ](http://t-wada.hatenablog.jp/entry/active-oss-development-vs-simplicity)
39+
> -- [OSS開発の活発さの維持と良いソフトウェア設計の間には緊張関係があるのだろうか? - t-wadaのブログ](http://t-wada.hatenablog.jp/entry/active-oss-development-vs-simplicity "OSS開発の活発さの維持と良いソフトウェア設計の間には緊張関係があるのだろうか? - t-wadaのブログ")
3240
3341
この書籍では、JavaScriptにおけるプラグインアーキテクチャやそのエコシステムを形成してるライブラリやツールなどの実装を学ぶことが目的となっています。
3442

3543
JavaScriptの基本的な文法などについては解説していないため、次の書籍を参照してください。
3644

37-
* [JavaScript Primer - 迷わないための入門書 \#jsprimer](https://jsprimer.net/)
45+
- [JavaScript Primer - 迷わないための入門書 #jsprimer](https://jsprimer.net/)
3846

3947
## この書籍の内容について
4048

41-
### [jQuery](jquery.md)
49+
### [jQuery](ja/jQuery/README.md)
4250

43-
jQueryのプラグインについて解説しています。 `<script>`タグをベースとしたプラグインアーキテクチャについて解説しています。
51+
jQueryのプラグインについて解説しています。
52+
`<script>`タグをベースとしたプラグインアーキテクチャについて解説しています。
4453

45-
### [ESLint](eslint.md)
54+
### [ESLint](ja/ESLint/README.md)
4655

47-
ESLintのルールを拡張する仕組みについて解説しています。 ESLintではJavaScriptのコードをパースして作成されたASTを元にコードのLintを行います。 実際にESLintのルールを解釈できる小さな実装を作りながらプラグインの仕組みについて学びます。
56+
ESLintのルールを拡張する仕組みについて解説しています。
57+
ESLintではJavaScriptのコードをパースして作成されたASTを元にコードのLintを行います。
58+
実際にESLintのルールを解釈できる小さな実装を作りながらプラグインの仕組みについて学びます。
4859

49-
### [Connect](connect.md)
60+
### [Connect](ja/connect/README.md)
5061

51-
Connectの **middleware** と呼ばれるプラグインアーキテクチャについて解説しています。 Node.js以外においても_Rack_などHTTPサーバーでよく見られるプラグインを使った階層構造について学びます。
62+
Connectの **middleware** と呼ばれるプラグインアーキテクチャについて解説しています。
63+
Node.js以外においても_Rack_などHTTPサーバーでよく見られるプラグインを使った階層構造について学びます。
5264

53-
### [gulp](gulp.md)
65+
### [gulp](ja/gulp/README.md)
5466

55-
**タスク自動化ツール**として知られるgulpのプラグインアーキテクチャについて解説しています。 gulpではデータの流れとして既存のNode.js Streamを使い、そこで流すデータとしてvinylオブジェクトを利用します。 実際にgulpプラグインを書きながら、gulpのプラグインの仕組みについて学びます。
67+
**タスク自動化ツール**として知られるgulpのプラグインアーキテクチャについて解説しています。
68+
gulpではデータの流れとして既存のNode.js Streamを使い、そこで流すデータとしてvinylオブジェクトを利用します。
69+
実際にgulpプラグインを書きながら、gulpのプラグインの仕組みについて学びます。
5670

57-
### [Redux](redux.md)
71+
### [Redux](ja/Redux/README.md)
5872

59-
アプリケーションのStateを管理ライブラリのReduxのプラグインアーキテクチャについて解説しています。 Reduxでは **middleware** と呼ばれる拡張の仕組みを持っていますが、Connectとの類似点や相違点があります。 小さなReduxの実装を作りながら **middleware** の仕組みについて学びます。
73+
アプリケーションのStateを管理ライブラリのReduxのプラグインアーキテクチャについて解説しています。
74+
Reduxでは **middleware** と呼ばれる拡張の仕組みを持っていますが、Connectとの類似点や相違点があります。
75+
小さなReduxの実装を作りながら **middleware** の仕組みについて学びます。
6076

6177
## Contributing
6278

6379
この書籍は無料で読むことができ、同時に修正や新しいページを書く権利があります。
6480

65-
[CONTRIBUTING.md](https://github.com/azu/JavaScript-Plugin-Architecture/blob/master/CONTRIBUTING.md)に、書籍で扱うべきプラグインアーキテクチャのProposalの書き方や Pull Request、コミットのやりかたなどが書かれています。
81+
[CONTRIBUTING.md](https://github.com/azu/JavaScript-Plugin-Architecture/blob/master/CONTRIBUTING.md)に、書籍で扱うべきプラグインアーキテクチャのProposalの書き方や
82+
Pull Request、コミットのやりかたなどが書かれています。
6683

6784
間違いやライブラリのアップデートへの追従など何かあれば、IssueやPull Requestをよろしくお願いします。
6885

6986
ソースコードはすべてGitHubに公開されています。
7087

71-
* [azu/JavaScript-Plugin-Architecture](https://github.com/azu/JavaScript-Plugin-Architecture)
88+
- [azu/JavaScript-Plugin-Architecture](https://github.com/azu/JavaScript-Plugin-Architecture)
7289

7390
## Author
7491

75-
* [github/azu](https://github.com/azu)
76-
* [twitter/azu\_re](https://twitter.com/azu_re)
92+
- [github/azu](https://github.com/azu)
93+
- [twitter/azu_re](https://twitter.com/azu_re)
7794

7895
## License
7996

8097
MIT/CC BY-NC © azu
8198

82-
* コードはMITライセンスで利用できます
83-
* 文章は[CC BY-NC 4.0](http://creativecommons.org/licenses/by-nc/4.0/)で利用できます
84-
99+
- コードはMITライセンスで利用できます
100+
- 文章は[CC BY-NC 4.0](http://creativecommons.org/licenses/by-nc/4.0/ "CC BY-NC 4.0")で利用できます

SUMMARY.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
# Table of contents
2-
3-
* [この書籍について](README.md)
4-
* [jQuery](jquery.md)
5-
* [ESLint](eslint.md)
6-
* [Connect](connect.md)
7-
* [gulp](gulp.md)
8-
* [Redux](redux.md)
9-
* [CONTRIBUTING](contributing.md)
1+
# Summary
102

3+
* [この書籍について](./README.md)
4+
* [jQuery](ja/jQuery/README.md)
5+
* [ESLint](ja/ESLint/README.md)
6+
* [Connect](ja/connect/README.md)
7+
* [gulp](ja/gulp/README.md)
8+
* [Redux](ja/Redux/README.md)
9+
* [CONTRIBUTING](./CONTRIBUTING.md)

0 commit comments

Comments
 (0)