From 20cdeb507020d6bbc410c60794665ed8590063a6 Mon Sep 17 00:00:00 2001 From: Derpius <49565664+Derpius@users.noreply.github.com> Date: Sat, 1 Jul 2023 21:36:59 +0100 Subject: [PATCH 1/3] docs: add folder exports --- packages/docs/functions/index.js | 10 ++++++++ packages/docs/index.js | 3 +++ packages/docs/matchers/index.js | 1 + packages/docs/matchers/symmetric/index.js | 30 +++++++++++++++++++++++ packages/docs/types/index.js | 2 ++ 5 files changed, 46 insertions(+) create mode 100644 packages/docs/functions/index.js create mode 100644 packages/docs/index.js create mode 100644 packages/docs/matchers/index.js create mode 100644 packages/docs/matchers/symmetric/index.js create mode 100644 packages/docs/types/index.js diff --git a/packages/docs/functions/index.js b/packages/docs/functions/index.js new file mode 100644 index 0000000..aeb39d7 --- /dev/null +++ b/packages/docs/functions/index.js @@ -0,0 +1,10 @@ +export { default as afterAll } from "./afterAll.json"; +export { default as afterEach } from "./afterEach.json"; +export { default as beforeAll } from "./beforeAll.json"; +export { default as beforeEach } from "./beforeEach.json"; +export { default as describe } from "./describe.json"; +export { default as describeEach } from "./describe-each.json"; +export { default as expect } from "./expect.json"; +export { default as lestFn } from "./fn.json"; +export { default as test } from "./test.json"; +export { default as testEach } from "./test-each.json"; diff --git a/packages/docs/index.js b/packages/docs/index.js new file mode 100644 index 0000000..c017699 --- /dev/null +++ b/packages/docs/index.js @@ -0,0 +1,3 @@ +export * from "./functions"; +export * from "./matchers"; +export * from "./types"; diff --git a/packages/docs/matchers/index.js b/packages/docs/matchers/index.js new file mode 100644 index 0000000..1164944 --- /dev/null +++ b/packages/docs/matchers/index.js @@ -0,0 +1 @@ +export * from "./symmetric"; diff --git a/packages/docs/matchers/symmetric/index.js b/packages/docs/matchers/symmetric/index.js new file mode 100644 index 0000000..0129b85 --- /dev/null +++ b/packages/docs/matchers/symmetric/index.js @@ -0,0 +1,30 @@ +export { default as toBe } from "./toBe.json"; +export { default as toBeCloseTo } from "./toBeCloseTo.json"; +export { default as toBeDefined } from "./toBeDefined.json"; +export { default as toBeFalsy } from "./toBeFalsy.json"; +export { default as toBeGreaterThan } from "./toBeGreaterThan.json"; +export { default as toBeGreaterThanOrEqual } from "./toBeGreaterThanOrEqual.json"; +export { default as toBeInfinity } from "./toBeInfinity.json"; +export { default as toBeInstanceOf } from "./toBeInstanceOf.json"; +export { default as toBeLessThan } from "./toBeLessThan.json"; +export { default as toBeLessThanOrEqual } from "./toBeLessThanOrEqual.json"; +export { default as toBeNaN } from "./toBeNaN.json"; +export { default as toBeTruthy } from "./toBeTruthy.json"; +export { default as toBeUndefined } from "./toBeUndefined.json"; +export { default as toContain } from "./toContain.json"; +export { default as toContainEqual } from "./toContainEqual.json"; +export { default as toEqual } from "./toEqual.json"; +export { default as toHaveBeenCalled } from "./toHaveBeenCalled.json"; +export { default as toHaveBeenCalledTimes } from "./toHaveBeenCalledTimes.json"; +export { default as toHaveBeenCalledWith } from "./toHaveBeenCalledWith.json"; +export { default as toHaveBeenLastCalledWith } from "./toHaveBeenLastCalledWith.json"; +export { default as toHaveBeenNthCalledWith } from "./toHaveBeenNthCalledWith.json"; +export { default as toHaveReturned } from "./toHaveReturned.json"; +export { default as toHaveReturnedTimes } from "./toHaveReturnedTimes.json"; +export { default as toHaveReturnedWith } from "./toHaveReturnedWith.json"; +export { default as toHaveLastReturnedWith } from "./toHaveLastReturnedWith.json"; +export { default as toHaveNthReturnedWith } from "./toHaveNthReturnedWith.json"; +export { default as toHaveLength } from "./toHaveLength.json"; +export { default as toMatch } from "./toMatch.json"; +export { default as toMatchObject } from "./toMatchObject.json"; +export { default as toThrow } from "./toThrow.json"; diff --git a/packages/docs/types/index.js b/packages/docs/types/index.js new file mode 100644 index 0000000..177ee63 --- /dev/null +++ b/packages/docs/types/index.js @@ -0,0 +1,2 @@ +export { default as mock } from "./mock.json"; +export { default as mockResult } from "./mock-result.json"; From c66c9b67f06e9aece6403435f3bf91feb89c0f7a Mon Sep 17 00:00:00 2001 From: Derpius <49565664+Derpius@users.noreply.github.com> Date: Sat, 1 Jul 2023 21:40:50 +0100 Subject: [PATCH 2/3] docs: update expect.mdx docs imports --- packages/site/docs/api/expect.mdx | 69 +++++++++++++++---------------- 1 file changed, 33 insertions(+), 36 deletions(-) diff --git a/packages/site/docs/api/expect.mdx b/packages/site/docs/api/expect.mdx index 39d2d85..2034352 100644 --- a/packages/site/docs/api/expect.mdx +++ b/packages/site/docs/api/expect.mdx @@ -5,42 +5,39 @@ title: Expect import FunctionRenderer from "@site/src/components/FunctionRenderer"; import MatcherRenderer from "@site/src/components/MatcherRenderer"; -import expect from "@lest/docs/functions/expect.json"; - -import toBe from "@lest/docs/matchers/symmetric/toBe.json"; -import toBeDefined from "@lest/docs/matchers/symmetric/toBeDefined.json"; -import toBeUndefined from "@lest/docs/matchers/symmetric/toBeUndefined.json"; -import toBeFalsy from "@lest/docs/matchers/symmetric/toBeFalsy.json"; -import toBeTruthy from "@lest/docs/matchers/symmetric/toBeTruthy.json"; -import toBeInstanceOf from "@lest/docs/matchers/symmetric/toBeInstanceOf.json"; -import toEqual from "@lest/docs/matchers/symmetric/toEqual.json"; - -import toHaveBeenCalled from "@lest/docs/matchers/symmetric/toHaveBeenCalled.json"; -import toHaveBeenCalledTimes from "@lest/docs/matchers/symmetric/toHaveBeenCalledTimes.json"; -import toHaveBeenCalledWith from "@lest/docs/matchers/symmetric/toHaveBeenCalledWith.json"; -import toHaveBeenLastCalledWith from "@lest/docs/matchers/symmetric/toHaveBeenLastCalledWith.json"; -import toHaveBeenNthCalledWith from "@lest/docs/matchers/symmetric/toHaveBeenNthCalledWith.json"; -import toHaveReturned from "@lest/docs/matchers/symmetric/toHaveReturned.json"; -import toHaveReturnedTimes from "@lest/docs/matchers/symmetric/toHaveReturnedTimes.json"; -import toHaveReturnedWith from "@lest/docs/matchers/symmetric/toHaveReturnedWith.json"; -import toHaveLastReturnedWith from "@lest/docs/matchers/symmetric/toHaveLastReturnedWith.json"; -import toHaveNthReturnedWith from "@lest/docs/matchers/symmetric/toHaveNthReturnedWith.json"; - -import toBeCloseTo from "@lest/docs/matchers/symmetric/toBeCloseTo.json"; -import toBeGreaterThan from "@lest/docs/matchers/symmetric/toBeGreaterThan.json"; -import toBeGreaterThanOrEqual from "@lest/docs/matchers/symmetric/toBeGreaterThanOrEqual.json"; -import toBeLessThan from "@lest/docs/matchers/symmetric/toBeLessThan.json"; -import toBeLessThanOrEqual from "@lest/docs/matchers/symmetric/toBeLessThanOrEqual.json"; -import toBeNaN from "@lest/docs/matchers/symmetric/toBeNaN.json"; -import toBeInfinity from "@lest/docs/matchers/symmetric/toBeInfinity.json"; - -import toHaveLength from "@lest/docs/matchers/symmetric/toHaveLength.json"; -import toContain from "@lest/docs/matchers/symmetric/toContain.json"; -import toContainEqual from "@lest/docs/matchers/symmetric/toContainEqual.json"; -import toMatchObject from "@lest/docs/matchers/symmetric/toMatchObject.json"; - -import toMatch from "@lest/docs/matchers/symmetric/toMatch.json"; -import toThrow from "@lest/docs/matchers/symmetric/toThrow.json"; +import { + expect, + toBe, + toBeDefined, + toBeUndefined, + toBeFalsy, + toBeTruthy, + toBeInstanceOf, + toEqual, + toHaveBeenCalled, + toHaveBeenCalledTimes, + toHaveBeenCalledWith, + toHaveBeenLastCalledWith, + toHaveBeenNthCalledWith, + toHaveReturned, + toHaveReturnedTimes, + toHaveReturnedWith, + toHaveLastReturnedWith, + toHaveNthReturnedWith, + toBeCloseTo, + toBeGreaterThan, + toBeGreaterThanOrEqual, + toBeLessThan, + toBeLessThanOrEqual, + toBeNaN, + toBeInfinity, + toHaveLength, + toContain, + toContainEqual, + toMatchObject, + toMatch, + toThrow, +} from "@lest/docs"; From 9e73ee8e7044237194cc7a60f4bff0f79b5e1422 Mon Sep 17 00:00:00 2001 From: Derpius <49565664+Derpius@users.noreply.github.com> Date: Sat, 1 Jul 2023 21:52:15 +0100 Subject: [PATCH 3/3] docs: update remaining docs imports --- packages/site/docs/api/globals.mdx | 9 +-------- packages/site/docs/api/lest-object.mdx | 2 +- packages/site/docs/api/mock-functions.mdx | 3 +-- 3 files changed, 3 insertions(+), 11 deletions(-) diff --git a/packages/site/docs/api/globals.mdx b/packages/site/docs/api/globals.mdx index 42d27c7..cf34cc6 100644 --- a/packages/site/docs/api/globals.mdx +++ b/packages/site/docs/api/globals.mdx @@ -4,14 +4,7 @@ title: Globals import FunctionRenderer from "@site/src/components/FunctionRenderer"; -import afterAll from "@lest/docs/functions/afterAll.json"; -import afterEach from "@lest/docs/functions/afterEach.json"; -import beforeAll from "@lest/docs/functions/beforeAll.json"; -import beforeEach from "@lest/docs/functions/beforeEach.json"; -import describe from "@lest/docs/functions/describe.json"; -import describeEach from "@lest/docs/functions/describe-each.json"; -import test from "@lest/docs/functions/test.json"; -import testEach from "@lest/docs/functions/test-each.json"; +import { afterAll, afterEach, beforeAll, beforeEach, describe, describeEach, test, testEach } from "@lest/docs"; In your test files, Lest puts each of these methods and objects into the global environment. You don't have to require or import anything to use them. diff --git a/packages/site/docs/api/lest-object.mdx b/packages/site/docs/api/lest-object.mdx index 099768a..09998b4 100644 --- a/packages/site/docs/api/lest-object.mdx +++ b/packages/site/docs/api/lest-object.mdx @@ -4,7 +4,7 @@ title: The Lest Object import FunctionRenderer from "@site/src/components/FunctionRenderer"; -import lestFn from "@lest/docs/functions/fn.json"; +import { lestFn } from "@lest/docs"; ## Mock Functions diff --git a/packages/site/docs/api/mock-functions.mdx b/packages/site/docs/api/mock-functions.mdx index ec09ae1..05b1851 100644 --- a/packages/site/docs/api/mock-functions.mdx +++ b/packages/site/docs/api/mock-functions.mdx @@ -4,8 +4,7 @@ title: Mock Functions import { ObjectRenderer, FieldRenderer } from "@site/src/components/object-renderer"; -import mock from "@lest/docs/types/mock.json"; -import mockResult from "@lest/docs/types/mock-result.json"; +import { mock, mockResult } from "@lest/docs"; Mock functions allow stubbing and/or inspecting functions when testing. This is especially used when unit testing, where you'll likely need to mock unrelated units of your code or code from other packages or libraries.allow