📝 Writing docs

Author: biigpongsatorn

README.md

@@ -1,11 +1,104 @@
-# Vue Test Actions
+<p>
+<a href="https://npmjs.com/package/vue-test-actions"><img src="https://img.shields.io/npm/v/vue-test-actions.svg?style=flat" alt="NPM version"></a>
+<a href="https://npmjs.com/package/vue-test-actions"><img src="https://img.shields.io/npm/dm/vue-test-actions.svg?style=flat" alt="NPM downloads"></a>
+<a href="https://www.npmjs.com/package/vue-test-actions"><img src="https://img.shields.io/npm/l/vue-test-actions.svg?style=flat" alt="License"></a>
+<a href="https://biigpongsatorn.github.io/#/vue-test-actions"><img src="https://travis-ci.org/biigpongsatorn/biigpongsatorn.github.io.svg?branch=dev" alt="build status"></a>
+</p>
 
-✅ Unit testing Vuex actions with Jest mocks. (🚧 WIP)
+# ✅ Vue Test Actions
 
-# Ref.
+Unit testing Vuex actions with Jest mocks.
 
-- [vuex-jest-mocking-examples](https://github.com/lmiller1990/vuex-jest-mocking-examples)
-- [vue-test-utils](https://github.com/vuejs/vue-test-utils)
-- [vuex.vuejs.org/guide/testing](https://vuex.vuejs.org/guide/testing.html)
-- [forum.vuejs](https://forum.vuejs.org/t/how-to-test-a-vuex-store-action-with-rootsate/22931)
-- [vue-test-utils](https://github.com/vuejs/vue-test-utils)
+# 💻 Install
+
+```sh
+npm i --save vue-test-actions
+```
+or
+```sh
+yarn add vue-test-actions
+```
+
+# 🕹 Usage
+
+```javascript
+import testAction from 'vue-test-actions'
+
+testAction(action, payload, expectedCommits, expectedDispatchs, store)
+```
+
+# ⚙️ Params
+| Params            | Type          | Description                       |
+| ----------------- |:--------------| ----------------------------------|
+| action            | Function      | Action function                   |
+| payload           | Any           | Parameter send to action function |
+| expected commits  | Array         | Array of commit expectation       |
+| expected dispatchs| Array         | Array of dispatchs expectation    |
+| store             | Object        | Object for mock store data such as `state` or `getter` |
+
+
+# 🔎 Example
+
+```javascript
+// user/actions.js
+
+import userSerive from '../myUserService'
+
+export async function getUser ({ commit, dispatch }, userId) {
+  commit('setLoading', true)
+  try {
+    const { data } = await userSerive.fetchUser(userId)
+    commit('setUser', data)
+    dispatch('getUserPermission', data.id)
+  } catch (e) {
+    commit('setNotificationError', true)
+  }
+  commit('setLoading', false)
+}
+```
+
+```javascript
+// user.spec.js
+
+import testAction from 'vue-test-actions'
+import * as actions from '~/store/user/actions'
+import userSerive from '~/services/myUserService'
+
+describe('getUser', () => {
+  test('If success', () => {
+    const payload = 1
+    userSerive.fetchUser = jest.fn().mockReturnValue({ data: { id: 1 } })
+    const expectedCommits = [
+      { type: 'setLoading', payload: true },
+      { type: 'setUser', payload: { id: 1 } },
+      { type: 'setLoading', payload: false }
+    ]
+    const expectedDispatchs = [
+      { type: 'getUserPermission', payload: 1 }
+    ]
+    testAction(actions.getUser, payload, expectedCommits, expectedDispatchs)
+  })
+})
+
+```
+
+# 🤝 Contributing
+1. Fork this repository.
+2. Create new branch with feature name.
+3. Run `npm install` and `npm run dev`.
+4. Create your feature.
+5. Commit and set commit message with feature name.
+6. Push your code to your fork repository.
+7. Create pull request. 🙂
+
+# ⭐️ Support
+
+```
+If you like this project, You can support me with starring ⭐ this repository.
+```
+
+# 🖊 License
+
+[MIT](LICENSE)
+
+Developed with ❤️ and ☕️