Skip to content

Commit 80b7742

Browse files
authored
docs: fix heading level (#2074)
1 parent 693a95b commit 80b7742

25 files changed

+101
-101
lines changed

docs/guide/testing.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
The main parts we want to unit test in Vuex are mutations and actions.
66

7-
### Testing Mutations
7+
## Testing Mutations
88

99
Mutations are very straightforward to test, because they are just functions that completely rely on their arguments. One trick is that if you are using ES2015 modules and put your mutations inside your `store.js` file, in addition to the default export, you should also export the mutations as a named export:
1010

@@ -49,7 +49,7 @@ describe('mutations', () => {
4949
})
5050
```
5151

52-
### Testing Actions
52+
## Testing Actions
5353

5454
Actions can be a bit more tricky because they may call out to external APIs. When testing actions, we usually need to do some level of mocking - for example, we can abstract the API calls into a service and mock that service inside our tests. In order to easily mock dependencies, we can use webpack and [inject-loader](https://github.com/plasticine/inject-loader) to bundle our test files.
5555

@@ -146,7 +146,7 @@ describe('actions', () => {
146146
})
147147
```
148148

149-
### Testing Getters
149+
## Testing Getters
150150

151151
If your getters have complicated computation, it is worth testing them. Getters are also very straightforward to test for the same reason as mutations.
152152

@@ -193,11 +193,11 @@ describe('getters', () => {
193193
})
194194
```
195195

196-
### Running Tests
196+
## Running Tests
197197

198198
If your mutations and actions are written properly, the tests should have no direct dependency on Browser APIs after proper mocking. Thus you can simply bundle the tests with webpack and run it directly in Node. Alternatively, you can use `mocha-loader` or Karma + `karma-webpack` to run the tests in real browsers.
199199

200-
#### Running in Node
200+
### Running in Node
201201

202202
Create the following webpack config (together with proper [`.babelrc`](https://babeljs.io/docs/usage/babelrc/)):
203203

@@ -228,13 +228,13 @@ webpack
228228
mocha test-bundle.js
229229
```
230230

231-
#### Running in Browser
231+
### Running in Browser
232232

233233
1. Install `mocha-loader`.
234234
2. Change the `entry` from the webpack config above to `'mocha-loader!babel-loader!./test.js'`.
235235
3. Start `webpack-dev-server` using the config.
236236
4. Go to `localhost:8080/webpack-dev-server/test-bundle`.
237237

238-
#### Running in Browser with Karma + karma-webpack
238+
### Running in Browser with Karma + karma-webpack
239239

240240
Consult the setup in [vue-loader documentation](https://vue-loader.vuejs.org/en/workflow/testing.html).

docs/ja/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Vuex は Vue.js アプリケーションのための **状態管理パターン
66
これは予測可能な方法によってのみ状態の変異を行うというルールを保証し、アプリケーション内の全てのコンポーネントのための集中型のストアとして機能します。
77
また Vue 公式の[開発ツール拡張](https://github.com/vuejs/vue-devtools)と連携し、設定なしでタイムトラベルデバッグやステートのスナップショットのエクスポートやインポートのような高度な機能を提供します。
88

9-
### "状態管理パターン"とはなんですか?
9+
## "状態管理パターン"とはなんですか?
1010

1111
単純な Vue で作られたカウンターアプリをみてみましょう:
1212

@@ -61,7 +61,7 @@ new Vue({
6161

6262
![vuex](/vuex.png)
6363

64-
### いつ、Vuexを使うべきでしょうか?
64+
## いつ、Vuexを使うべきでしょうか?
6565

6666
Vuex は、共有状態の管理に役立ちますが、さらに概念やボイラープレートのコストがかかります。これは、短期的生産性と長期的生産性のトレードオフです。
6767

docs/ja/guide/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Vuex アプリケーションの中心にあるものは**ストア**です。"
88

99
2. ストアの状態を直接変更することはできません。明示的に**ミューテーションをコミットする**ことによってのみ、ストアの状態を変更します。これによって、全ての状態の変更について追跡可能な記録を残すことが保証され、ツールでのアプリケーションの動作の理解を助けます。
1010

11-
### シンプルなストア
11+
## シンプルなストア
1212

1313
:::tip 注意
1414
私たちは、このドキュメントのコード例に ES2015 のシンタックスを利用しています。 もし触れたことがなければ、[ぜひ触れてください](https://babeljs.io/docs/learn-es2015/)

docs/ja/guide/actions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ actions: {
3939
}
4040
```
4141

42-
### アクションのディスパッチ
42+
## アクションのディスパッチ
4343

4444
アクションは `store.dispatch` がトリガーとなって実行されます:
4545

@@ -97,7 +97,7 @@ actions: {
9797

9898
一連の非同期の処理を実行しつつ、ミューテーションのコミットによってのみ副作用(状態の変更)を与えていることに注意してください。
9999

100-
### コンポーネント内でのアクションのディスパッチ
100+
## コンポーネント内でのアクションのディスパッチ
101101

102102
`this.$store.dispatch('xxx')` でコンポーネント内でアクションをディスパッチできます。あるいはコンポーネントのメソッドを `store.dispatch` にマッピングする `mapActions` ヘルパーを使うこともできます(ルートの `store` の注入が必要です):
103103

@@ -119,7 +119,7 @@ export default {
119119
}
120120
```
121121

122-
### アクションを構成する
122+
## アクションを構成する
123123

124124
アクションはしばしば非同期処理を行いますが、アクションが完了したことをどうやって知れば良いのでしょう?そしてもっと重要なことは、さらに複雑な非同期処理を取り扱うために、どうやって複数のアクションを構成させるかということです。
125125

docs/ja/guide/forms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ mutations: {
4040
}
4141
```
4242

43-
### 双方向算出プロパティ
43+
## 双方向算出プロパティ
4444

4545
確かに、上記の例は単純な `v-model` と ローカルステートよりもかなり冗長で、`v-model` のいくつかの有用な機能が使えません。代わりに、セッターで双方向算出プロパティを使うアプローチがあります。
4646

docs/ja/guide/getters.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ const store = new Vuex.Store({
3434
})
3535
```
3636

37-
### プロパティスタイルアクセス
37+
## プロパティスタイルアクセス
3838

3939
ゲッターは `store.getters` オブジェクトから取り出され、プロパティとしてアクセスすることができます:
4040

@@ -69,7 +69,7 @@ computed: {
6969

7070
プロパティとしてアクセスされるゲッターは Vue のリアクティブシステムの一部としてキャッシュされるという点に留意してください。
7171

72-
### メソッドスタイルアクセス
72+
## メソッドスタイルアクセス
7373

7474
関数を返り値にすることで、ゲッターに引数を渡すこともできます。これは特にストアの中の配列を検索する時に役立ちます:
7575
```js
@@ -87,7 +87,7 @@ store.getters.getTodoById(2) // -> { id: 2, text: '...', done: false }
8787

8888
メソッドによってアクセスされるゲッターは呼び出す度に実行され、その結果はキャッシュされない点に留意してください。
8989

90-
### `mapGetters` ヘルパー
90+
## `mapGetters` ヘルパー
9191

9292
`mapGetters` ヘルパーはストアのゲッターをローカルの算出プロパティにマッピングさせます:
9393

docs/ja/guide/modules.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ store.state.a // -> `moduleA` のステート
3131
store.state.b // -> `moduleB` のステート
3232
```
3333

34-
### モジュールのローカルステート
34+
## モジュールのローカルステート
3535

3636
モジュールのミューテーションやゲッターの中では、渡される第1引数は**モジュールのローカルステート**です。
3737

@@ -83,7 +83,7 @@ const moduleA = {
8383
}
8484
```
8585

86-
### 名前空間
86+
## 名前空間
8787

8888
デフォルトでは、モジュール内部のアクション、ミューテーション、そしてゲッターは**グローバル名前空間**の元で登録されます - これにより、複数のモジュールが同じミューテーション/アクションタイプに反応することができます。
8989

@@ -134,7 +134,7 @@ const store = new Vuex.Store({
134134

135135
名前空間のゲッターとアクションは、ローカライズされた `getters``dispatch``commit` を受け取ります。言い換えれば、同じモジュールに接頭辞 (prefix) を書き込まずに、モジュールアセットを使用することができます。名前空間オプションの切り替えは、モジュール内のコードには影響しません。
136136

137-
#### 名前空間付きモジュールでのグローバルアセットへのアクセス
137+
### 名前空間付きモジュールでのグローバルアセットへのアクセス
138138

139139
グローバルステートとゲッターを使いたい場合、`rootState``rootGetters` はゲッター関数の第3引数と第4引数として渡され、アクション関数に渡される `context` オブジェクトのプロパティとしても公開されます。
140140

@@ -174,7 +174,7 @@ modules: {
174174
}
175175
```
176176

177-
#### 名前空間付きモジュールでのグローバルアクションへの登録
177+
### 名前空間付きモジュールでのグローバルアクションへの登録
178178

179179
名前空間付きモジュールでグローバルアクションに登録したい場合、`root: true` でそれをマークでき、そしてアクション定義を `handler` 関数に置くことができます。例えば:
180180

@@ -200,7 +200,7 @@ modules: {
200200
```
201201

202202

203-
#### 名前空間によるバインディングヘルパー
203+
### 名前空間によるバインディングヘルパー
204204

205205
`mapState``mapGetters``mapActions`、そして `mapMutations` ヘルパーを使って名前空間付きモジュールをコンポーネントにバインディングするとき、少し冗長になります:
206206

@@ -261,7 +261,7 @@ export default {
261261
}
262262
```
263263

264-
#### プラグイン開発者向けの注意事項
264+
### プラグイン開発者向けの注意事項
265265

266266
モジュールを提供する[プラグイン](plugins.md)を作成し、ユーザーがそれらを Vuex ストアに追加できるようにすると、モジュールの予測できない名前空間が気になるかもしれません。あなたのモジュールは、プラグインユーザーが名前空間付きモジュールの元にモジュールを追加すると、その名前空間に属するようになります。この状況に適応するには、プラグインオプションを使用して名前空間の値を受け取る必要があります。
267267

@@ -277,7 +277,7 @@ export function createPlugin (options = {}) {
277277
}
278278
```
279279

280-
### 動的にモジュールを登録する
280+
## 動的にモジュールを登録する
281281

282282
ストアが作られた****`store.registerModule` メソッドを使って、モジュールを登録できます:
283283

@@ -301,13 +301,13 @@ store.registerModule(['nested', 'myModule'], {
301301

302302
また、すでにモジュールが登録されているかどうかを `store.hasModule(moduleName)` メソッドを使って確認することができます。
303303

304-
#### ステートの保持
304+
### ステートの保持
305305

306306
サーバサイドレンダリングされたアプリケーションから状態を保持するなど、新しいモジュールを登録するときに、以前の状態を保持したい場合があります。`preserveState` オプション(`store.registerModule('a', module, { preserveState: true })`)でこれを実現できます。
307307

308308
`preserveState: true` を設定した場合、モジュールを登録する際に、アクション、ミューテーション、そしてゲッターは追加されますがステートは追加されません。これはストアのステートはすでにモジュールのステートを登録しているので、それを上書きしないようにするためです。
309309

310-
### モジュールの再利用
310+
## モジュールの再利用
311311

312312
時どき、モジュールの複数インスタンスを作成する必要があるかもしれません。例えば:
313313

docs/ja/guide/mutations.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ const store = new Vuex.Store({
2424
store.commit('increment')
2525
```
2626

27-
### 追加の引数を渡してコミットする
27+
## 追加の引数を渡してコミットする
2828

2929
`store.commit` に追加の引数を渡すこともできます。この追加の引数は、特定のミューテーションに対する**ペイロード**と呼びます:
3030

@@ -58,7 +58,7 @@ store.commit('increment', {
5858
})
5959
```
6060

61-
### オブジェクトスタイルのコミット
61+
## オブジェクトスタイルのコミット
6262

6363
また `type` プロパティを持つオブジェクトを使って、ミューテーションをコミットすることもできます:
6464

@@ -80,7 +80,7 @@ mutations: {
8080
```
8181

8282

83-
### Vue のリアクティブなルールに則ったミューテーション
83+
## Vue のリアクティブなルールに則ったミューテーション
8484

8585
Vuex ストアの状態は Vue によってリアクティブになっているので、状態を変更すると、状態を監視している Vue コンポーネントは自動的に更新されます。これは Vuex のミューテーションは、通常の Vue と動作させているときと同じく、リアクティブな値に関する注意が必要であることを意味します:
8686

@@ -96,7 +96,7 @@ Vuex ストアの状態は Vue によってリアクティブになっている
9696
state.obj = { ...state.obj, newProp: 123 }
9797
```
9898

99-
### ミューテーション・タイプに定数を使用する
99+
## ミューテーション・タイプに定数を使用する
100100

101101
いろいろな Flux 実装において、ミューテーション・タイプに定数を使用することが共通して見られるパターンです。これはコードに対してリントツールのようなツールを利用できるという利点があり、また単一ファイルに全ての定数を設定することによって、共同で作業する人に、アプリケーション全体で何のミューテーションが可能であるかを一目見ただけで理解できるようにします:
102102

@@ -123,7 +123,7 @@ const store = new Vuex.Store({
123123

124124
定数を使用するかどうかは好みの問題です。多くの開発者による大規模なプロジェクトで役に立ちますが、完全にオプションなので、もしお気に召さなければ使用しなくても構いません。
125125

126-
### ミューテーションは同期的でなければならない
126+
## ミューテーションは同期的でなければならない
127127

128128
ひとつの重要なルールを覚えておきましょう。それは**ミューテーションハンドラ関数は同期的でなければならない**ということです。なぜか?次の例で考えてみましょう:
129129

@@ -139,7 +139,7 @@ mutations: {
139139

140140
いま、開発ツールのミューテーションのログを見ながら、アプリケーションのデバッグを行っていることを想像してください。全てのミューテーションをログに記録するためには、ミューテーションの前後の状態のスナップショットを捕捉することが必要です。しかし、上の例にあるミューテーション内の非同期コールバックは、それを不可能にします: そのコールバックは、ミューテーションがコミットされた時点ではまだ呼び出されていません。そして、コールバックが実際にいつ呼び出されるかを、開発ツールは知る術がありません。いかなる状態変更でも、コールバック内で起きる場合は本質的に追跡不可能です。
141141

142-
### コンポーネント内におけるミューテーションのコミット
142+
## コンポーネント内におけるミューテーションのコミット
143143

144144
`this.$store.commit('xxx')` と書くか、もしくはコンポーネントのメソッドを `store.commit` にマッピングする `mapMutations` ヘルパーを呼び出すこと(ルートの `store` の注入が必要)で、コンポーネント内でミューテーションをコミットできます:
145145

@@ -162,7 +162,7 @@ export default {
162162
}
163163
```
164164

165-
### アクションへ向けて
165+
## アクションへ向けて
166166

167167
状態変更を非同期に組み合わせることは、プログラムの動きを予測することを非常に困難にします。例えば、状態を変更する非同期コールバックを持った 2つのメソッドを両方呼び出すとき、それらがいつ呼び出されたか、どちらが先に呼び出されたかを、どうやって知ればよいのでしょう?これがまさに、状態変更と非同期の 2つの概念を分離したいという理由です。Vuex では**全てのミューテーションは同期的に行う**という作法になっています:
168168

docs/ja/guide/plugins.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ const store = new Vuex.Store({
2323
})
2424
```
2525

26-
### プラグイン内でのミューテーションのコミット
26+
## プラグイン内でのミューテーションのコミット
2727

2828
プラグインは直接、状態を変更できません。これはコンポーネントに似ています。プラグインはコンポーネント同様に、ミューテーションのコミットをトリガーすることで状態を変更できます。
2929

@@ -54,7 +54,7 @@ const store = new Vuex.Store({
5454
})
5555
```
5656

57-
### 状態のスナップショットを撮る
57+
## 状態のスナップショットを撮る
5858

5959
時々、状態の"スナップショット"を撮って、ミューテーション前後の状態を比較したくなることがあるでしょう。それを実現するために、状態オブジェクトのディープコピーを行う必要があります:
6060

@@ -85,7 +85,7 @@ const store = new Vuex.Store({
8585

8686
上のように記述すれば、プラグインはデフォルトで利用されることになります。本番環境( production ) では、 `process.env.NODE_ENV !== 'production'``false` に置き換えるために、 webpack では[DefinePlugin](https://webpack.js.org/plugins/define-plugin/) 、 Browserify では[envify](https://github.com/hughsk/envify) が必要になります。
8787

88-
### ビルトインロガープラグイン
88+
## ビルトインロガープラグイン
8989

9090
> もし、あなたが [vue-devtools](https://github.com/vuejs/vue-devtools) を使っている場合は、これは不要でしょう。
9191

0 commit comments

Comments
 (0)