Flow: add typings for chai and mocha

Author: IvanGoncharov

.eslintignore

@@ -2,3 +2,6 @@
 node_modules
 coverage
 dist
+
+# Ignore Flow typings for 3rd-party libraries
+/flow-typed

.flowconfig

@@ -1,17 +1,13 @@
 [ignore]
 .*
 !<PROJECT_ROOT>/src
-!<PROJECT_ROOT>/node_modules/chai
-!<PROJECT_ROOT>/node_modules/mocha
 !<PROJECT_ROOT>/node_modules/graphql
 
 [include]
 
 [declarations]
 <PROJECT_ROOT>/node_modules/graphql
 
-[libs]
-
 [lints]
 sketchy-null-bool=error
 sketchy-null-string=error

cspell.json

@@ -8,6 +8,7 @@
     "dist",
 
     // Excluded from spelling check
+    "flow-typed",
     "cspell.json",
     "package.json",
     "package-lock.json",

flow-typed/npm/chai_vx.x.x.js

@@ -0,0 +1,331 @@
+declare module 'chai' {
+  declare type ExpectChain<T> = {
+    and: ExpectChain<T>,
+    at: ExpectChain<T>,
+    be: ExpectChain<T>,
+    been: ExpectChain<T>,
+    have: ExpectChain<T>,
+    has: ExpectChain<T>,
+    is: ExpectChain<T>,
+    of: ExpectChain<T>,
+    same: ExpectChain<T>,
+    that: ExpectChain<T>,
+    to: ExpectChain<T>,
+    which: ExpectChain<T>,
+    with: ExpectChain<T>,
+    not: ExpectChain<T>,
+    deep: ExpectChain<T>,
+    any: ExpectChain<T>,
+    all: ExpectChain<T>,
+    own: ExpectChain<T>,
+    a: ExpectChain<T> & ((type: string, message?: string) => ExpectChain<T>),
+    an: ExpectChain<T> & ((type: string, message?: string) => ExpectChain<T>),
+    include: ExpectChain<T> &
+      ((value: mixed, message?: string) => ExpectChain<T>),
+    includes: ExpectChain<T> &
+      ((value: mixed, message?: string) => ExpectChain<T>),
+    contain: ExpectChain<T> &
+      ((value: mixed, message?: string) => ExpectChain<T>),
+    contains: ExpectChain<T> &
+      ((value: mixed, message?: string) => ExpectChain<T>),
+    eq: (value: T, message?: string) => ExpectChain<T>,
+    eql: (value: T, message?: string) => ExpectChain<T>,
+    equal: (value: T, message?: string) => ExpectChain<T>,
+    equals: (value: T, message?: string) => ExpectChain<T>,
+    above: (value: T & number, message?: string) => ExpectChain<T>,
+    gt: (value: T & number, message?: string) => ExpectChain<T>,
+    greaterThan: (value: T & number, message?: string) => ExpectChain<T>,
+    least: (value: T & number, message?: string) => ExpectChain<T>,
+    below: (value: T & number, message?: string) => ExpectChain<T>,
+    lessThan: (value: T & number, message?: string) => ExpectChain<T>,
+    lt: (value: T & number, message?: string) => ExpectChain<T>,
+    most: (value: T & number, message?: string) => ExpectChain<T>,
+    within: (
+      start: T & number,
+      finish: T & number,
+      message?: string,
+    ) => ExpectChain<T>,
+    instanceof: (constructor: mixed, message?: string) => ExpectChain<T>,
+    instanceOf: (constructor: mixed, message?: string) => ExpectChain<T>,
+    nested: ExpectChain<T>,
+    property: <P>(
+      name: string,
+      value?: P,
+      message?: string,
+    ) => ExpectChain<P> & ((name: string) => ExpectChain<mixed>),
+    length: ExpectChain<number> &
+      ((value: number, message?: string) => ExpectChain<T>),
+    lengthOf: ExpectChain<number> &
+      ((value: number, message?: string) => ExpectChain<T>),
+    match: (regex: RegExp, message?: string) => ExpectChain<T>,
+    matches: (regex: RegExp, message?: string) => ExpectChain<T>,
+    string: (string: string, message?: string) => ExpectChain<T>,
+    key: (key: string) => ExpectChain<T>,
+    keys: (
+      key: string | Array<string>,
+      ...keys: Array<string>
+    ) => ExpectChain<T>,
+    throw: <E>(
+      err?: Class<E> | Error | RegExp | string,
+      errMsgMatcher?: RegExp | string,
+      msg?: string,
+    ) => ExpectChain<T>,
+    respondTo: (method: string, message?: string) => ExpectChain<T>,
+    itself: ExpectChain<T>,
+    satisfy: (
+      method: (value: T) => boolean,
+      message?: string,
+    ) => ExpectChain<T>,
+    closeTo: (
+      expected: T & number,
+      delta: number,
+      message?: string,
+    ) => ExpectChain<T>,
+    members: (set: mixed, message?: string) => ExpectChain<T>,
+    oneOf: (list: Array<T>, message?: string) => ExpectChain<T>,
+    change: (obj: mixed, key: string, message?: string) => ExpectChain<T>,
+    increase: (obj: mixed, key: string, message?: string) => ExpectChain<T>,
+    decrease: (obj: mixed, key: string, message?: string) => ExpectChain<T>,
+    by: (delta: number, message?: string) => ExpectChain<T>,
+    ordered: ExpectChain<T>,
+    // dirty-chai
+    ok: () => ExpectChain<T>,
+    true: () => ExpectChain<T>,
+    false: () => ExpectChain<T>,
+    null: () => ExpectChain<T>,
+    undefined: () => ExpectChain<T>,
+    exist: () => ExpectChain<T>,
+    empty: () => ExpectChain<T>,
+    extensible: () => ExpectChain<T>,
+    sealed: () => ExpectChain<T>,
+    frozen: () => ExpectChain<T>,
+    NaN: () => ExpectChain<T>,
+    // chai-immutable
+    size: (n: number) => ExpectChain<T>,
+    // sinon-chai
+    called: () => ExpectChain<T>,
+    callCount: (n: number) => ExpectChain<T>,
+    calledOnce: () => ExpectChain<T>,
+    calledTwice: () => ExpectChain<T>,
+    calledThrice: () => ExpectChain<T>,
+    calledBefore: (spy: mixed) => ExpectChain<T>,
+    calledAfter: (spy: mixed) => ExpectChain<T>,
+    calledImmediatelyBefore: (spy: mixed) => ExpectChain<T>,
+    calledImmediatelyAfter: (spy: mixed) => ExpectChain<T>,
+    calledWith: (...args: Array<mixed>) => ExpectChain<T>,
+    calledOnceWith: (...args: Array<mixed>) => ExpectChain<T>,
+    calledWithMatch: (...args: Array<mixed>) => ExpectChain<T>,
+    calledWithExactly: (...args: Array<mixed>) => ExpectChain<T>,
+    calledOnceWithExactly: (...args: Array<mixed>) => ExpectChain<T>,
+    returned: (returnVal: mixed) => ExpectChain<T>,
+    alwaysReturned: (returnVal: mixed) => ExpectChain<T>,
+    // chai-as-promised
+    eventually: ExpectChain<T>,
+    resolvedWith: (value: mixed) => Promise<mixed> & ExpectChain<T>,
+    resolved: () => Promise<mixed> & ExpectChain<T>,
+    rejectedWith: (
+      value: mixed,
+      errMsgMatcher?: RegExp | string,
+      msg?: string,
+    ) => Promise<mixed> & ExpectChain<T>,
+    rejected: () => Promise<mixed> & ExpectChain<T>,
+    notify: (callback: () => mixed) => ExpectChain<T>,
+    fulfilled: () => Promise<mixed> & ExpectChain<T>,
+    // chai-subset
+    containSubset: (obj: { ... } | Array<{ ... }>) => ExpectChain<T>,
+    // chai-redux-mock-store
+    dispatchedActions: (
+      actions: Array<{ ... } | ((action: { ... }) => any)>,
+    ) => ExpectChain<T>,
+    dispatchedTypes: (actions: Array<string>) => ExpectChain<T>,
+    // chai-enzyme
+    attr: (key: string, val?: any) => ExpectChain<T>,
+    data: (key: string, val?: any) => ExpectChain<T>,
+    prop: (key: string, val?: any) => ExpectChain<T>,
+    state: (key: string, val?: any) => ExpectChain<T>,
+    value: (val: string) => ExpectChain<T>,
+    className: (val: string) => ExpectChain<T>,
+    text: (val: string) => ExpectChain<T>,
+    // chai-karma-snapshot
+    matchSnapshot: (lang?: any, update?: boolean, msg?: any) => ExpectChain<T>,
+    ...
+  };
+
+  declare var expect: {
+    <T>(actual: T, message?: string): ExpectChain<T>,
+    fail: ((message?: string) => void) &
+      ((
+        actual: any,
+        expected: any,
+        message?: string,
+        operator?: string,
+      ) => void),
+    ...
+  };
+
+  declare function use(plugin: (chai: Object, utils: Object) => void): void;
+
+  declare class assert {
+    static (expression: mixed, message?: string): void;
+    static fail(
+      actual: mixed,
+      expected: mixed,
+      message?: string,
+      operator?: string,
+    ): void;
+
+    static isOk(object: mixed, message?: string): void;
+    static isNotOk(object: mixed, message?: string): void;
+
+    static empty(object: mixed, message?: string): void;
+    static isEmpty(object: mixed, message?: string): void;
+    static notEmpty(object: mixed, message?: string): void;
+    static isNotEmpty(object: mixed, message?: string): void;
+
+    static equal(actual: mixed, expected: mixed, message?: string): void;
+    static notEqual(actual: mixed, expected: mixed, message?: string): void;
+
+    static strictEqual(act: mixed, exp: mixed, msg?: string): void;
+    static notStrictEqual(act: mixed, exp: mixed, msg?: string): void;
+
+    static deepEqual(act: mixed, exp: mixed, msg?: string): void;
+    static notDeepEqual(act: mixed, exp: mixed, msg?: string): void;
+
+    static ok(val: mixed, msg?: string): void;
+    static isTrue(val: mixed, msg?: string): void;
+    static isNotTrue(val: mixed, msg?: string): void;
+    static isFalse(val: mixed, msg?: string): void;
+    static isNotFalse(val: mixed, msg?: string): void;
+
+    static isNull(val: mixed, msg?: string): void;
+    static isNotNull(val: mixed, msg?: string): void;
+
+    static isUndefined(val: mixed, msg?: string): void;
+    static isDefined(val: mixed, msg?: string): void;
+
+    static isNaN(val: mixed, msg?: string): void;
+    static isNotNaN(val: mixed, msg?: string): void;
+
+    static isAbove(val: number, abv: number, msg?: string): void;
+    static isBelow(val: number, blw: number, msg?: string): void;
+
+    static exists(val: mixed, msg?: string): void;
+    static notExists(val: mixed, msg?: string): void;
+
+    static isAtMost(val: number, atmst: number, msg?: string): void;
+    static isAtLeast(val: number, atlst: number, msg?: string): void;
+
+    static isFunction(val: mixed, msg?: string): void;
+    static isNotFunction(val: mixed, msg?: string): void;
+
+    static isObject(val: mixed, msg?: string): void;
+    static isNotObject(val: mixed, msg?: string): void;
+
+    static isArray(val: mixed, msg?: string): void;
+    static isNotArray(val: mixed, msg?: string): void;
+
+    static isString(val: mixed, msg?: string): void;
+    static isNotString(val: mixed, msg?: string): void;
+
+    static isNumber(val: mixed, msg?: string): void;
+    static isNotNumber(val: mixed, msg?: string): void;
+
+    static isBoolean(val: mixed, msg?: string): void;
+    static isNotBoolean(val: mixed, msg?: string): void;
+
+    static typeOf(val: mixed, type: string, msg?: string): void;
+    static notTypeOf(val: mixed, type: string, msg?: string): void;
+
+    static instanceOf(val: mixed, constructor: Class<*>, msg?: string): void;
+    static notInstanceOf(val: mixed, constructor: Class<*>, msg?: string): void;
+
+    static include(exp: string, inc: mixed, msg?: string): void;
+    static include<T>(exp: Array<T>, inc: T, msg?: string): void;
+
+    static notInclude(exp: string, inc: mixed, msg?: string): void;
+    static notInclude<T>(exp: Array<T>, inc: T, msg?: string): void;
+
+    static deepInclude<T>(
+      haystack: T[] | string,
+      needle: $Shape<T>,
+      msg?: string,
+    ): void;
+    static notDeepInclude<T>(
+      haystack: T[] | string,
+      needle: $Shape<T>,
+      msg?: string,
+    ): void;
+
+    static match(exp: mixed, re: RegExp, msg?: string): void;
+    static notMatch(exp: mixed, re: RegExp, msg?: string): void;
+
+    static property(obj: Object, prop: string, msg?: string): void;
+    static notProperty(obj: Object, prop: string, msg?: string): void;
+    static deepProperty(obj: Object, prop: string, msg?: string): void;
+    static notDeepProperty(obj: Object, prop: string, msg?: string): void;
+
+    static propertyVal(
+      obj: Object,
+      prop: string,
+      val: mixed,
+      msg?: string,
+    ): void;
+    static propertyNotVal(
+      obj: Object,
+      prop: string,
+      val: mixed,
+      msg?: string,
+    ): void;
+
+    static deepPropertyVal(
+      obj: Object,
+      prop: string,
+      val: mixed,
+      msg?: string,
+    ): void;
+    static deepPropertyNotVal(
+      obj: Object,
+      prop: string,
+      val: mixed,
+      msg?: string,
+    ): void;
+
+    static lengthOf(exp: mixed, len: number, msg?: string): void;
+
+    static throws<E>(
+      func: () => any,
+      err?: Class<E> | Error | RegExp | string,
+      errorMsgMatcher?: string | RegExp,
+      msg?: string,
+    ): void;
+    static doesNotThrow<E>(
+      func: () => any,
+      err?: Class<E> | Error | RegExp | string,
+      errorMsgMatcher?: string | RegExp,
+      msg?: string,
+    ): void;
+
+    static closeTo(
+      actual: number,
+      expected: number,
+      delta: number,
+      msg?: string,
+    ): void;
+    static approximately(
+      actual: number,
+      expected: number,
+      delta: number,
+      msg?: string,
+    ): void;
+
+    // chai-immutable
+    static sizeOf(val: mixed, length: number): void;
+  }
+
+  declare var config: {
+    includeStack: boolean,
+    showDiff: boolean,
+    truncateThreshold: number,
+    ...
+  };
+}