-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
testingLibrary
config option (#104)
* feature: 'testingLibrary' configure option * docs: add options to docs * docs: more docs * refactore: merge `render`, `cleanup` options with `testingLibrary` * refactor: code review changes * refactor: code review changes * chore: added changeset
- reassure@1.3.2
- reassure@1.3.1
- reassure@1.3.0
- reassure@1.2.1
- reassure@1.2.0
- reassure@1.1.0
- reassure@1.0.0
- reassure@1.0.0-rc.5
- reassure@1.0.0-rc.4
- reassure@1.0.0-rc.3
- reassure@1.0.0-rc.2
- reassure@1.0.0-rc.1
- reassure@1.0.0-rc
- reassure@1.0.0-beta
- reassure@0.11.0
- reassure@0.10.2
- reassure@0.10.1
- reassure@0.10.0
- reassure@0.9.1
- reassure@0.9.0
- reassure@0.8.0
- reassure@0.7.2
- reassure@0.7.1
- reassure@0.7.0
- reassure@0.6.0
- reassure@0.5.0
- reassure@0.4.1
- reassure@0.4.0
- @callstack/reassure-measure@1.3.2
- @callstack/reassure-measure@1.3.1
- @callstack/reassure-measure@1.3.0
- @callstack/reassure-measure@1.2.1
- @callstack/reassure-measure@1.2.0
- @callstack/reassure-measure@1.1.0
- @callstack/reassure-measure@1.0.0
- @callstack/reassure-measure@1.0.0-rc.5
- @callstack/reassure-measure@1.0.0-rc.4
- @callstack/reassure-measure@1.0.0-rc.3
- @callstack/reassure-measure@1.0.0-rc.2
- @callstack/reassure-measure@1.0.0-rc.1
- @callstack/reassure-measure@1.0.0-rc
- @callstack/reassure-measure@1.0.0-beta
- @callstack/reassure-measure@0.11.0
- @callstack/reassure-measure@0.6.0
- @callstack/reassure-measure@0.5.1
- @callstack/reassure-measure@0.5.0
- @callstack/reassure-measure@0.4.1
- @callstack/reassure-measure@0.4.0
- @callstack/reassure-measure@0.3.1
- @callstack/reassure-measure@0.3.0
- @callstack/reassure-logger@1.3.2
- @callstack/reassure-logger@1.3.1
- @callstack/reassure-logger@1.3.0
- @callstack/reassure-logger@1.2.1
- @callstack/reassure-logger@1.2.0
- @callstack/reassure-logger@1.1.0
- @callstack/reassure-logger@1.0.0
- @callstack/reassure-logger@1.0.0-rc.5
- @callstack/reassure-logger@1.0.0-rc.4
- @callstack/reassure-logger@1.0.0-rc.3
- @callstack/reassure-logger@1.0.0-rc.2
- @callstack/reassure-logger@1.0.0-rc.1
- @callstack/reassure-logger@1.0.0-rc
- @callstack/reassure-logger@1.0.0-beta
- @callstack/reassure-logger@0.11.0
- @callstack/reassure-logger@0.3.1
- @callstack/reassure-logger@0.3.0
- @callstack/reassure-logger@0.2.0
- @callstack/reassure-logger@0.1.0
- @callstack/reassure-danger@1.3.2
- @callstack/reassure-danger@1.3.1
- @callstack/reassure-danger@1.3.0
- @callstack/reassure-danger@1.2.1
- @callstack/reassure-danger@1.2.0
- @callstack/reassure-danger@1.1.0
- @callstack/reassure-danger@1.0.0
- @callstack/reassure-danger@1.0.0-rc.5
- @callstack/reassure-danger@1.0.0-rc.4
- @callstack/reassure-danger@1.0.0-rc.3
- @callstack/reassure-danger@1.0.0-rc.2
- @callstack/reassure-danger@1.0.0-rc.1
- @callstack/reassure-danger@1.0.0-rc
- @callstack/reassure-danger@1.0.0-next.2
- @callstack/reassure-danger@1.0.0-beta
- @callstack/reassure-danger@0.11.0
- @callstack/reassure-danger@0.1.1
- @callstack/reassure-danger@0.1.0
- @callstack/reassure-danger@0.0.1
- @callstack/reassure-compare@1.3.2
- @callstack/reassure-compare@1.3.1
- @callstack/reassure-compare@1.3.0
- @callstack/reassure-compare@1.2.1
- @callstack/reassure-compare@1.2.0
- @callstack/reassure-compare@1.1.0
- @callstack/reassure-compare@1.0.0
- @callstack/reassure-compare@1.0.0-rc.5
- @callstack/reassure-compare@1.0.0-rc.4
- @callstack/reassure-compare@1.0.0-rc.3
- @callstack/reassure-compare@1.0.0-rc.2
- @callstack/reassure-compare@1.0.0-rc.1
- @callstack/reassure-compare@1.0.0-rc
- @callstack/reassure-compare@1.0.0-beta
- @callstack/reassure-compare@0.11.0
- @callstack/reassure-compare@0.6.0
- @callstack/reassure-compare@0.5.1
- @callstack/reassure-compare@0.5.0
- @callstack/reassure-compare@0.4.1
- @callstack/reassure-compare@0.4.0
- @callstack/reassure-compare@0.3.0
- @callstack/reassure-compare@0.2.0
- @callstack/reassure-compare@0.1.2
- @callstack/reassure-cli@1.3.2
- @callstack/reassure-cli@1.3.1
- @callstack/reassure-cli@1.3.0
- @callstack/reassure-cli@1.2.1
- @callstack/reassure-cli@1.2.0
- @callstack/reassure-cli@1.1.0
- @callstack/reassure-cli@1.0.0
- @callstack/reassure-cli@1.0.0-rc.5
- @callstack/reassure-cli@1.0.0-rc.4
- @callstack/reassure-cli@1.0.0-rc.3
- @callstack/reassure-cli@1.0.0-rc.2
- @callstack/reassure-cli@1.0.0-rc.1
- @callstack/reassure-cli@1.0.0-rc
- @callstack/reassure-cli@1.0.0-beta
- @callstack/reassure-cli@0.11.0
- @callstack/reassure-cli@0.10.2
- @callstack/reassure-cli@0.10.0
- @callstack/reassure-cli@0.9.1
- @callstack/reassure-cli@0.9.0
- @callstack/reassure-cli@0.8.0
- @callstack/reassure-cli@0.7.0
- @callstack/reassure-cli@0.6.1
- @callstack/reassure-cli@0.6.0
- @callstack/reassure-cli@0.5.0
- @callstack/reassure-cli@0.4.0
- @callstack/reassure-cli@0.3.1
1 parent
0ea5c3c
commit 7ad802b
Showing
7 changed files
with
123 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
'example-native': minor | ||
'@callstack/reassure-measure': minor | ||
'reassure': minor | ||
--- | ||
|
||
`testingLibrary` configuration option that replaces `render` and `cleanup` options |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
import { configure } from 'reassure'; | ||
|
||
configure({ testingLibrary: 'react-native', verbose: true }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
import { config, Render, Cleanup } from './config'; | ||
|
||
type TestingLibraryApi = { | ||
render: Render; | ||
cleanup: Cleanup; | ||
}; | ||
|
||
let RNTL: TestingLibraryApi | undefined; | ||
try { | ||
// eslint-disable-next-line import/no-extraneous-dependencies | ||
RNTL = require('@testing-library/react-native'); | ||
} catch (error) { | ||
// Do nothing | ||
} | ||
|
||
let RTL: TestingLibraryApi | undefined; | ||
try { | ||
// eslint-disable-next-line import/no-extraneous-dependencies | ||
RTL = require('@testing-library/react'); | ||
} catch (error) { | ||
// Do nothing | ||
} | ||
|
||
export function resolveTestingLibrary(): TestingLibraryApi { | ||
// Explicit testing library option | ||
if (config.testingLibrary) { | ||
if (config.testingLibrary === 'react-native') { | ||
if (!RNTL) { | ||
throw new Error(`Reassure: unable to import '@testing-library/react-native' dependency`); | ||
} | ||
|
||
if (config.verbose) console.log(`Reassure: using '@testing-library/react-native' to render components`); | ||
return RNTL; | ||
} | ||
|
||
if (config.testingLibrary === 'react') { | ||
if (!RTL) { | ||
throw new Error(`Reassure: unable to import '@testing-library/react' dependency`); | ||
} | ||
|
||
if (config.verbose) console.log(`Reassure: using '@testing-library/react' to render components`); | ||
return RTL; | ||
} | ||
|
||
if ( | ||
typeof config.testingLibrary === 'object' && | ||
typeof config.testingLibrary.render === 'function' && | ||
typeof config.testingLibrary.cleanup === 'function' | ||
) { | ||
if (config.verbose) console.log(`Reassure: using custom 'render' and 'cleanup' functions to render components`); | ||
return config.testingLibrary; | ||
} | ||
|
||
throw new Error( | ||
`Reassure: unsupported 'testingLibrary' value. Please set 'testingLibrary' to one of following values: 'react-native', 'react' or { render, cleanup }.` | ||
); | ||
} | ||
|
||
// Testing library auto-detection | ||
if (RNTL != null && RTL != null) { | ||
console.warn( | ||
`Reassure: both '@testing-library/react-native' and '@testing-library/react' are installed. Using '@testing-library/react-native' by default.` + | ||
`\nYou can resolve this warning by explicitly calling 'configure({ testingLibrary: 'react-native' })' or 'configure({ testingLibrary: 'react' })' in your test setup file.` | ||
); | ||
|
||
return RNTL; | ||
} | ||
|
||
if (RNTL != null) { | ||
if (config.verbose) console.log(`Reassure: using '@testing-library/react-native' to render components`); | ||
return RNTL; | ||
} | ||
|
||
if (RTL != null) { | ||
if (config.verbose) console.log(`Reassure: using '@testing-library/react' to render components`); | ||
return RTL; | ||
} | ||
|
||
throw new Error( | ||
`Reassure: unable to import neither '@testing-library/react-native' nor '@testing-library/react'.` + | ||
`\nAdd either of these testing libraries to your 'package.json'` | ||
); | ||
} |