docs(vuepress): add docs website

README.md

@@ -1,5 +1,5 @@
 # Onyx
-![Onyx logo](docs/assets/onyx-logo-sm.svg)
+![Onyx logo](packages/docs/.vuepress/public/onyx-logo-sm.svg)
 
 [![Build Status](https://travis-ci.org/onyxjs/onyx.svg?branch=master)](https://travis-ci.org/onyxjs/onyx)
 [![codecov](https://codecov.io/gh/onyxjs/onyx/branch/master/graph/badge.svg)](https://codecov.io/gh/onyxjs/onyx)

package.json

@@ -16,7 +16,9 @@
     "lint:fix": "lerna run --no-bail lint:fix --stream",
     "build": "lerna run build --stream",
     "dev": "lerna run dev --stream",
-    "watch": "lerna run watch --stream"
+    "watch": "lerna run watch --stream",
+    "dev:docs": "lerna run dev --stream --scope @onyx/docs",
+    "build:docs": "lerna run build --stream --scope @onyx/docs"
   },
   "husky": {
     "hooks": {

packages/docs/.vuepress/config.js

@@ -0,0 +1,113 @@
+module.exports = {
+  base: "/onyx/",
+  plugins: {
+    "@vuepress/pwa": {
+      serviceWorker: true,
+      updatePopup: {
+        "/": {
+          message: "New content is available.",
+          buttonText: "Refresh"
+        },
+        "/ru/": {
+          message: "Доступна новая информация.",
+          buttonText: "Обновить"
+        },
+        "/zh-Hant/": {
+          message: "新內容可用。",
+          buttonText: "刷新"
+        }
+      }
+    },
+    "@vuepress/nprogress": {},
+    "@vuepress/back-to-top": {}
+  },
+  themeConfig: {
+    locales: {
+      "/": {
+        selectText: "Languages",
+        label: "English",
+        editLinkText: "Edit this page on GitHub",
+        sidebar: [
+          "/",
+          {
+            title: "@onyx/matchers",
+            path: "/matchers/",
+            children: [
+              "/matchers/matchers/to-be",
+              "/matchers/matchers/to-be-defined",
+              "/matchers/matchers/to-be-false",
+              "/matchers/matchers/to-be-instance-of",
+              "/matchers/matchers/to-be-nan",
+              "/matchers/matchers/to-be-null",
+              "/matchers/matchers/to-be-true",
+              "/matchers/matchers/to-be-type-of",
+              "/matchers/matchers/to-be-undefined",
+              "/matchers/matchers/to-contain",
+              "/matchers/matchers/to-equal",
+              "/matchers/matchers/to-have-length",
+              "/matchers/matchers/to-strictly-equal",
+              "/matchers/matchers/to-throw"
+            ]
+          },
+          "/mock/"
+        ]
+      },
+      "/ru/": {
+        selectText: "Языки",
+        label: "Русский",
+        editLinkText: "Редактировать эту страницу на GitHub",
+        sidebar: ["/ru/", "/ru/matchers/", "/ru/mock/"]
+      },
+      "/zh/": {
+        selectText: "語言",
+        label: "中文",
+        editLinkText: "在Github中編輯此頁面",
+        sidebar: [
+          "/zh/",
+          {
+            title: "@onyx/matchers",
+            path: "/zh/matchers/",
+            children: [
+              "/zh/matchers/matchers/to-be",
+              "/zh/matchers/matchers/to-be-defined",
+              "/zh/matchers/matchers/to-be-false",
+              "/zh/matchers/matchers/to-be-instance-of",
+              "/zh/matchers/matchers/to-be-nan",
+              "/zh/matchers/matchers/to-be-null",
+              "/zh/matchers/matchers/to-be-true",
+              "/zh/matchers/matchers/to-be-type-of",
+              "/zh/matchers/matchers/to-be-undefined",
+              "/zh/matchers/matchers/to-contain",
+              "/zh/matchers/matchers/to-equal",
+              "/zh/matchers/matchers/to-have-length",
+              "/zh/matchers/matchers/to-strictly-equal",
+              "/zh/matchers/matchers/to-throw"
+            ]
+          },
+          {
+            title: "@onyx/mock",
+            path: "/zh/mock/",
+            children: []
+          }
+        ]
+      }
+    }
+  },
+  locales: {
+    "/": {
+      lang: "en-US",
+      title: "Onyx",
+      description: "Onyx is a JavaScript testing framework"
+    },
+    "/ru/": {
+      lang: "ru-RU",
+      title: "Onyx",
+      description: "Onyx это фреймворк для тестирования JavaScript кода."
+    },
+    "/zh/": {
+      lang: "zh-TW",
+      title: "Onyx",
+      description: "Onyx是一個JavaScript測試框架。"
+    }
+  }
+};

packages/docs/README.md

@@ -0,0 +1,7 @@
+# Onyx
+![Onyx logo](/onyx/onyx-logo-sm.svg)
+
+[![Build Status](https://travis-ci.org/onyxjs/onyx.svg?branch=master)](https://travis-ci.org/onyxjs/onyx)
+[![codecov](https://codecov.io/gh/onyxjs/onyx/branch/master/graph/badge.svg)](https://codecov.io/gh/onyxjs/onyx)
+
+> Onyx is a JavaScript testing framework

packages/docs/deploy.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env sh
+
+# abort on errors
+set -e
+
+# build
+yarn build
+
+# navigate into the build output directory
+cd .vuepress/dist
+
+git init
+git add -A
+git commit -m 'deploy'
+
+# deploy to gh-pages branch
+git push -f https://github.com/onyxjs/onyx master:gh-pages
+
+cd -

packages/docs/matchers/README.md

@@ -0,0 +1,4 @@
+# @onyx/matchers
+![Onyx logo](/onyx/onyx-logo-sm.svg)
+
+This package provides matchers that can compare, validate and diff (TODO) values in your tests.

packages/docs/matchers/expect/expect.md

@@ -0,0 +1,16 @@
+## expect
+
+> Signature: `expect ( matchers: { [ key: string ]: Function }, expectation: any): any
+
+`expect` allows you to test that values meet certain expectations. The `expect` function can be paired with a `matcher` to validate a desired output or value.
+
+### Example
+
+```ts
+import { expect } from '@onyx/matchers';
+
+console.log(expect(1).toBeTypeOf('number')); // true
+console.log(expect('string').toHaveLength(6)); // true
+console.log(expect(2).not.toBeTypeOf('number')); // false
+console.log(expect('string').not.toHaveLength(6)); // false
+```

packages/docs/matchers/matchers/README.md

@@ -0,0 +1,18 @@
+## Matcher functions
+All matcher functions are listed here:
+- [toBe](to-be)
+- [toBeDefined](to-be-defined)
+- [toBeFalse](to-be-false)
+- [toBeFalsy](to-be-falsy)
+- [toBeInstanceOf](to-be-instance-of)
+- [toBeNaN](to-be-nan)
+- [toBeNull](to-be-null)
+- [toBeTrue](to-be-true)
+- [toBeTruthy](to-be-truthy)
+- [toBeTypeOf](to-be-type-of)
+- [toBeUndefined](to-be-undefined)
+- [toContain](to-contain)
+- [toEqual](to-equal)
+- [toHaveLength](to-have-length)
+- [toStrictlyEqual](to-strictly-equal)
+- [toThrow](to-throw)

packages/docs/matchers/matchers/to-be-defined.md

@@ -0,0 +1,17 @@
+## toBeDefined
+
+> Signature: `toBeDefined (a: any): boolean`
+
+`toBeDefined` checks if the value is defined. It only returns `false` when it has `undefined` as input.
+
+### Example
+
+```ts
+import { toBeDefined } from '@onyx/matchers';
+
+console.log(toBeDefined(1)); // true
+console.log(toBeDefined({}); // true
+console.log(toBeDefined(NaN)); // true
+console.log(toBeDefined(null)); // true
+console.log(toBeDefined(undefined)); // false
+```

packages/docs/matchers/matchers/to-be-false.md

@@ -0,0 +1,18 @@
+## toBeFalse (toBeFalsy)
+
+> Signature: `toBeFalse (a: any): boolean`
+
+`toBeFalse` matcher (aliased as `toBeFalsy`) checks whether the given value is falsy.
+
+### Example
+
+```ts
+import { toBeFalse } from '@onyx/matchers';
+
+console.log(toBeFalse(false)); // true
+console.log(toBeFalse(undefined)); // true
+console.log(toBeFalse(NaN)); // true
+console.log(toBeFalse(0)); // true
+console.log(toBeFalse(1)); // false
+console.log(toBeFalse({})); // false
+```

packages/docs/matchers/matchers/to-be-instance-of.md

@@ -0,0 +1,16 @@
+## toBeInstanceOf
+
+> Signature: `toBeInstanceOf (a: any, b: Function): boolean`
+
+`toBeInstanceOf` matcher checks whether the given first argument in instance of type given as second argument.
+
+### Example
+
+```ts
+import { toBeInstanceOf } from '@onyx/matchers';
+
+console.log(toBeInstanceOf(document, Document)); // true
+console.log(toBeInstanceOf(document.body, Element)); // true
+console.log(toBeInstanceOf([], Array)); // true
+console.log(toBeInstanceOf({}, Element)); // false
+```

packages/docs/matchers/matchers/to-be-nan.md

@@ -0,0 +1,16 @@
+## toBeNaN
+
+> Signature: `toBeNaN (a: any, b: any): boolean`
+
+`toBeNaN` matcher checks whether given value is `NaN`. If the value is string, `toBeNaN` will parse it.
+
+### Example
+
+```ts
+import { toBeNaN } from '@onyx/matchers';
+
+console.log(toBeNaN(NaN)); // true
+console.log(toBeNaN('onyx')); // true
+console.log(toBeNaN(1)); // false
+console.log(toBeNaN(1337)); // false
+```

packages/docs/matchers/matchers/to-be-null.md

@@ -0,0 +1,14 @@
+## toBeNull
+
+> Signature: `toBeNull (a: any): boolean`
+
+`toBeNull` matcher checks if the given value is `null`.
+
+### Example
+
+```ts
+import { toBeNull } from '@onyx/matchers';
+
+console.log(toBeNull(null)); // true
+console.log(toBeNull(1)); // false
+```

packages/docs/matchers/matchers/to-be-true.md

@@ -0,0 +1,18 @@
+## toBeTrue (toBeTruthy)
+
+> Signature: `toBeTrue (a: any): boolean`
+
+`toBeTrue` matcher (aliased as `toBeTruthy`) checks whether the given value is truthy.
+
+### Example
+
+```ts
+import { toBeTrue } from '@onyx/matchers';
+
+console.log(toBeTrue(false)); // false
+console.log(toBeTrue(undefined)); // false
+console.log(toBeTrue(NaN)); // false
+console.log(toBeTrue(0)); // false
+console.log(toBeTrue(1)); // true
+console.log(toBeTrue({})); // true
+```

packages/docs/matchers/matchers/to-be-type-of.md

@@ -0,0 +1,16 @@
+## toBeTypeOf
+
+> Signature: `toBeTypeOf (a: any, b: Function): boolean`
+
+`toBeTypeOf` matcher checks the first given argument's object type.
+
+### Example
+
+```ts
+import { toBeTypeOf } from '@onyx/matchers';
+
+console.log(toBeTypeOf('', 'string')); // true
+console.log(toBeTypeOf(22, 'number')); // true
+console.log(toBeTypeOf([], 'array')); // true
+console.log(toBeTypeOf({}, 'boolean')); // false
+```

packages/docs/matchers/matchers/to-be-undefined.md

@@ -0,0 +1,16 @@
+## toBeUndefined
+
+> Signature: `toBeUndefined (a: any): boolean`
+
+`toBeUndefined` matcher checks if the given argument is undefined.
+
+### Example
+
+```ts
+import { toBeUndefined } from '@onyx/matchers';
+
+console.log(toBeUndefined('')); // false
+console.log(toBeUndefined(undefined)); // true
+console.log(toBeUndefined(null)); // false
+console.log(toBeUndefined({})); // false
+```

packages/docs/matchers/matchers/to-be.md

@@ -0,0 +1,18 @@
+## toBe
+
+> Signature: `toBe (a: any, b: any): boolean`
+
+`toBe` matcher uses `lodash.isEqual` and `Object.is` under the hood to compare values. It returns `true` if values are identical, `false` in any other case.
+
+### Example
+
+```ts
+import { toBe } from '@onyx/matchers';
+
+console.log(toBe(1, 1)); // true
+console.log(toBe({}, {})); // true
+console.log(toBe(NaN, NaN)); // true
+console.log(toBe(1, 2)); // false
+console.log(toBe(NaN, null)); // false
+console.log(toBe(undefined, null)); // false
+```

packages/docs/matchers/matchers/to-contain.md

@@ -0,0 +1,16 @@
+## toContain
+
+> Signature: `toContain (a: any[] | object, b: any): boolean`
+
+`toContain` matcher checks if the first given parameter contains the second given parameter.
+
+### Example
+
+```ts
+import { toContain } from '@onyx/matchers';
+
+console.log(toContain([1], 1)); // true
+console.log(toContain({a: 'b'}, 'b')); // true
+console.log(toContain([{}, 1, 'onyx'], 'onyx')); // true
+console.log(toContain(1 as any, 'onyx')); // false
+```

packages/docs/matchers/matchers/to-equal.md

@@ -0,0 +1,16 @@
+## toEqual
+
+> Signature: `toEqual (a: any, b: any): boolean`
+
+`toEqual` matcher performs `type coercion` and checks the given parameters for loose equality.
+
+### Example
+
+```ts
+import { toEqual } from '@onyx/matchers';
+
+console.log(toEqual(1, '1')); // true
+console.log(toEqual('string', ['string'])); // true
+console.log(toEqual('five', 5)); // false
+console.log(toEqual({}, {})); // false
+```