Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme.md #274

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update readme.md #274

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ The default configuration as defined below can be overridden by using the follow

> NOTE: Priority/order of config selection comes from the below list where the first item have the defined defaults and each next step having a potential to override the previous if a configuration value is specified.

1. Starting with the defaults (as shown in the JS object below) this is defined in [lib/config.js](lib/config.js).
1. Starting with the defaults (as shown in the JS object below) this is defined in [lib/config.ts](lib/config.ts).
1. We then take and override the defaults (and only the properties specified) with config in a yaml or json file in your home directory `~/.approvalsConfig`.
1. You can then call [`approvals.configure({...})`](#module_approvals.configure).
1. Then passing any specific configuration at the test level as the last parameter in the verify function `.verify(..., {...overridden config...});`. See [API](#api) for specific parameters.
Expand Down Expand Up @@ -508,7 +508,7 @@ approvals.verifyAndScrub(__dirname, 'sample-approval-test', { a: "some text in a
### approvals~verifyWithControl(namer, writer, [reporterFactory], [optionsOverride])
This allows you to take full control of naming and writing files before verifying.

For an example that we use to generate the docs within the readme, check out the [test/readmeTests.js](test/readmeTests.js) in this project.
For an example that we use to generate the docs within the readme, check out the [test/readmeTests.ts](test/readmeTests.ts) in this project.

**Kind**: inner method of [<code>approvals</code>](#module_approvals)

Expand Down
Loading