-
Notifications
You must be signed in to change notification settings - Fork 332
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(core): warn when using
debug
option (#364)
- Loading branch information
1 parent
eed934f
commit 2a2e3dd
Showing
3 changed files
with
24 additions
and
0 deletions.
There are no files selected for viewing
11 changes: 11 additions & 0 deletions
11
packages/autocomplete-core/src/__tests__/checkOptions.test.ts
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,11 @@ | ||
import { createAutocomplete } from '../createAutocomplete'; | ||
|
||
describe('Validate options', () => { | ||
test('debug option warns about development usage', () => { | ||
expect(() => { | ||
createAutocomplete({ debug: true }); | ||
}).toWarnDev( | ||
'[Autocomplete] The `debug` option is meant for development debugging and should not be used in production.' | ||
); | ||
}); | ||
}); |
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,10 @@ | ||
import { warn } from '@algolia/autocomplete-shared'; | ||
|
||
import { AutocompleteOptions } from './types'; | ||
|
||
export function checkOptions<TItem>(option: AutocompleteOptions<TItem>) { | ||
warn( | ||
!option.debug, | ||
'The `debug` option is meant for development debugging and should not be used in production.' | ||
); | ||
} |
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