feat: add screen export to mirror testing-lib (#174)

Author: benmonro

src/index.ts

@@ -133,4 +133,55 @@ export const queryAllByTestId = bindFunction("queryAllByTestId");
 export const findByTestId = bindFunction("findByTestId");
 export const findAllByTestId = bindFunction("findAllByTestId");
 
+export const screen = {
+  getByLabelText,
+  getAllByLabelText,
+  queryByLabelText,
+  queryAllByLabelText,
+  findByLabelText,
+  findAllByLabelText,
+  getByText,
+  getAllByText,
+  queryByText,
+  queryAllByText,
+  findByText,
+  findAllByText,
+  getByAltText,
+  getByPlaceholderText,
+  getAllByPlaceholderText,
+  queryByPlaceholderText,
+  queryAllByPlaceholderText,
+  findByPlaceholderText,
+  findAllByPlaceholderText,
+  getAllByAltText,
+  queryByAltText,
+  queryAllByAltText,
+  findByAltText,
+  findAllByAltText,
+  getByTitle,
+  getAllByTitle,
+  queryByTitle,
+  queryAllByTitle,
+  findByTitle,
+  findAllByTitle,
+  getByDisplayValue,
+  getAllByDisplayValue,
+  queryByDisplayValue,
+  queryAllByDisplayValue,
+  findByDisplayValue,
+  getByRole,
+  getAllByRole,
+  queryByRole,
+  queryAllByRole,
+  findByRole,
+  findAllByRole,
+  findAllByDisplayValue,
+  getByTestId,
+  getAllByTestId,
+  queryByTestId,
+  queryAllByTestId,
+  findByTestId,
+  findAllByTestId,
+};
+
 export * from "./types";

src/types.ts

@@ -1,4 +1,4 @@
-import { Config, BoundFunction } from "@testing-library/dom";
+import { Config, BoundFunction, queries } from "@testing-library/dom";
 
 export type Options = Pick<Config, "testIdAttribute">;
 

tests/testcafe/screen.ts

@@ -0,0 +1,21 @@
+import { screen } from "../../src";
+
+fixture`screen`.page`../../test-app/index.html`;
+
+test("getByPlaceHolderText", async (t) => {
+  await t.typeText(
+    screen.getByPlaceholderText("Placeholder Text"),
+    "Hello Placeholder"
+  );
+});
+
+test("getByText", async (t) => {
+  await t.click(screen.getByText("getByText"));
+});
+
+test("getByLabelText", async (t) => {
+  await t.typeText(
+    screen.getByLabelText("Label For Input Labelled By Id"),
+    "Hello Input Labelled By Id"
+  );
+});

tests/unit/__snapshots__/selectors.test.ts.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`exports expected selectors 1`] = `
+exports[`exports expected exports 1`] = `
 Array [
   "configureOnce",
   "configure",
@@ -53,5 +53,6 @@ Array [
   "queryAllByTestId",
   "findByTestId",
   "findAllByTestId",
+  "screen",
 ]
 `;

tests/unit/selectors.test.ts

@@ -1,19 +1,35 @@
-import * as selectors from "../../src";
+import * as allExports from "../../src";
 import { queries } from "@testing-library/dom";
 
-it("exports expected selectors", () => {
-  expect(selectors).toMatchObject(expect.any(Object));
-  expect(Object.keys(selectors)).toMatchSnapshot();
+it("exports expected exports", () => {
+  expect(allExports).toMatchObject(expect.any(Object));
+
+  expect(Object.keys(allExports)).toMatchSnapshot();
+
+  const { screen, ...selectors } = allExports;
+
   Object.keys(selectors).forEach((selector) => {
     expect(selectors[selector as keyof typeof selectors]).toBeInstanceOf(
       Function
     );
   });
+
+  Object.keys(screen).forEach((selector) => {
+    expect(screen[selector as keyof typeof screen]).toBeInstanceOf(Function);
+  });
 });
 
 it("exports all dom-testing-library queries", () => {
-  let { configureOnce, configure, within, ...justSelectors } = selectors;
+  let {
+    configureOnce,
+    configure,
+    within,
+    screen,
+    ...justSelectors
+  } = allExports;
   expect(Object.keys(justSelectors).sort()).toEqual(
     Object.keys(queries).sort()
   );
+
+  expect(Object.keys(screen).sort()).toEqual(Object.keys(queries).sort());
 });