feat(core): warn when using debug option (#364)

Author: francoischalifour

packages/autocomplete-core/src/__tests__/checkOptions.test.ts

@@ -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.'
+    );
+  });
+});

packages/autocomplete-core/src/checkOptions.ts

@@ -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.'
+  );
+}

packages/autocomplete-core/src/createAutocomplete.ts

@@ -1,3 +1,4 @@
+import { checkOptions } from './checkOptions';
 import { createStore } from './createStore';
 import { getAutocompleteSetters } from './getAutocompleteSetters';
 import { getDefaultProps } from './getDefaultProps';
@@ -14,6 +15,8 @@ export function createAutocomplete<
 >(
   options: AutocompleteOptions<TItem>
 ): AutocompleteApi<TItem, TEvent, TMouseEvent, TKeyboardEvent> {
+  checkOptions(options);
+
   const props = getDefaultProps(options);
   const store = createStore(stateReducer, props);