refactor: improve defaultHidden computing

Author: EBAM006

src/__tests__/config.test.ts

@@ -6,6 +6,7 @@ beforeEach(() => {
 
 test('getConfig() returns existing configuration', () => {
   expect(getConfig().asyncUtilTimeout).toEqual(1000);
+  expect(getConfig().defaultIncludeHiddenElements).toEqual(true);
 });
 
 test('configure() overrides existing config values', () => {
@@ -14,7 +15,6 @@ test('configure() overrides existing config values', () => {
   expect(getConfig()).toEqual({
     asyncUtilTimeout: 5000,
     defaultDebugOptions: { message: 'debug message' },
-    defaultHidden: true,
     defaultIncludeHiddenElements: true,
   });
 });
@@ -26,11 +26,15 @@ test('resetToDefaults() resets config to defaults', () => {
     defaultHidden: false,
   });
   expect(getConfig().asyncUtilTimeout).toEqual(5000);
-  expect(getConfig().defaultHidden).toEqual(false);
   expect(getConfig().defaultIncludeHiddenElements).toEqual(false);
 
   resetToDefaults();
   expect(getConfig().asyncUtilTimeout).toEqual(1000);
-  expect(getConfig().defaultHidden).toEqual(true);
   expect(getConfig().defaultIncludeHiddenElements).toEqual(true);
 });
+
+test('configure handles alias option defaultHidden', () => {
+  expect(getConfig().defaultIncludeHiddenElements).toEqual(true);
+  configure({ defaultHidden: false });
+  expect(getConfig().defaultIncludeHiddenElements).toEqual(false);
+});

src/config.ts

@@ -7,42 +7,41 @@ export type Config = {
   /** Default includeHiddenElements value for all queries */
   defaultIncludeHiddenElements: boolean;
 
+  /** Default options for `debug` helper. */
+  defaultDebugOptions?: Partial<DebugOptions>;
+};
+
+export type ConfigAliasOptions = {
   /** Default hidden value for all queries, alias to defaultIncludeHiddenElements to respect react-testing-library API
    * WARNING: if both defaultHidden and defaultIncludeHiddenElements values are defined,
    * then defaultIncludeHiddenElements will take precedence
    */
   defaultHidden: boolean;
-
-  /** Default options for `debug` helper. */
-  defaultDebugOptions?: Partial<DebugOptions>;
 };
 
 const defaultConfig: Config = {
   asyncUtilTimeout: 1000,
-  defaultHidden: true,
   defaultIncludeHiddenElements: true,
 };
 
 let config = { ...defaultConfig };
 
-export function configure(options: Partial<Config>) {
-  if (
-    options.defaultHidden !== undefined &&
-    options.defaultIncludeHiddenElements === undefined
-  ) {
-    options.defaultIncludeHiddenElements = options.defaultHidden;
-  }
-
-  if (
-    options.defaultIncludeHiddenElements !== undefined &&
-    options.defaultHidden === undefined
-  ) {
-    options.defaultHidden = options.defaultIncludeHiddenElements;
-  }
+export function configure(options: Partial<Config & ConfigAliasOptions>) {
+  const { defaultHidden, ...restOptions } = options;
+
+  const defaultIncludeHiddenElements =
+    restOptions.defaultIncludeHiddenElements ??
+    defaultHidden ??
+    config.defaultIncludeHiddenElements;
+
+  const optionsToSet = {
+    ...restOptions,
+    defaultIncludeHiddenElements,
+  };
 
   config = {
     ...config,
-    ...options,
+    ...optionsToSet,
   };
 }
 

typings/index.flow.js

@@ -468,12 +468,17 @@ declare module '@testing-library/react-native' {
   declare interface Config {
     asyncUtilTimeout: number;
     defaultIncludeHiddenElements: boolean;
+    defaultDebugOptions?: $Shape<DebugOptions>;
+  }
+
+  declare interface ConfigAliasOptions {
     /** Alias to `defaultIncludeHiddenElements` for RTL compatibility */
     defaultHidden: boolean;
-    defaultDebugOptions?: $Shape<DebugOptions>;
   }
 
-  declare export var configure: (options: $Shape<Config>) => void;
+  declare export var configure: (
+    options: $Shape<Config & ConfigAliasOptions>
+  ) => void;
   declare export var resetToDefaults: () => void;
 
   declare export var act: (callback: () => void) => Thenable;