feat: introduce development and production modes (#363)

francoischalifour · web-flow · commit eed934f1d7d6 · 2020-11-10T11:47:29.000+01:00
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -74,7 +74,7 @@ module.exports = {
       },
     },
     {
-      files: ['scripts/**/*'],
+      files: ['scripts/**/*', '*.config.js'],
       rules: {
         'import/no-commonjs': 'off',
       },
diff --git a/babel.config.js b/babel.config.js
@@ -1,4 +1,4 @@
-/* eslint-disable import/no-commonjs */
+const wrapWarningWithDevCheck = require('./scripts/babel/wrap-warning-with-dev-check');
 
 module.exports = (api) => {
   const isTest = api.env('test');
@@ -23,12 +23,13 @@ module.exports = (api) => {
       ],
     ],
     plugins: clean([
-      !isTest && [
+      wrapWarningWithDevCheck,
+      [
         'inline-replace-variables',
         {
           __DEV__: {
             type: 'node',
-            replacement: "process.env.NODE_ENV === 'development'",
+            replacement: "process.env.NODE_ENV !== 'production'",
           },
         },
       ],
diff --git a/bundlesize.config.json b/bundlesize.config.json
@@ -1,23 +1,23 @@
 {
   "files": [
     {
-      "path": "packages/autocomplete-core/dist/umd/index.js",
+      "path": "packages/autocomplete-core/dist/umd/index.production.js",
       "maxSize": "4.5 kB"
     },
     {
-      "path": "packages/autocomplete-js/dist/umd/index.js",
+      "path": "packages/autocomplete-js/dist/umd/index.production.js",
       "maxSize": "8 kB"
     },
     {
-      "path": "packages/autocomplete-preset-algolia/dist/umd/index.js",
+      "path": "packages/autocomplete-preset-algolia/dist/umd/index.production.js",
       "maxSize": "1.5 kB"
     },
     {
-      "path": "packages/autocomplete-plugin-recent-searches/dist/umd/index.js",
+      "path": "packages/autocomplete-plugin-recent-searches/dist/umd/index.production.js",
       "maxSize": "2.5 kB"
     },
     {
-      "path": "packages/autocomplete-plugin-query-suggestions/dist/umd/index.js",
+      "path": "packages/autocomplete-plugin-query-suggestions/dist/umd/index.production.js",
       "maxSize": "2.25 kB"
     }
   ]
diff --git a/jest.config.js b/jest.config.js
@@ -1,5 +1,3 @@
-/* eslint-disable import/no-commonjs */
-
 module.exports = {
   rootDir: process.cwd(),
   setupFilesAfterEnv: [
diff --git a/packages/autocomplete-core/package.json b/packages/autocomplete-core/package.json
@@ -12,10 +12,10 @@
   "source": "src/index.ts",
   "types": "dist/esm/index.d.ts",
   "module": "dist/esm/index.js",
-  "main": "dist/umd/index.js",
-  "umd:main": "dist/umd/index.js",
-  "unpkg": "dist/umd/index.js",
-  "jsdelivr": "dist/umd/index.js",
+  "main": "dist/umd/index.production.js",
+  "umd:main": "dist/umd/index.production.js",
+  "unpkg": "dist/umd/index.production.js",
+  "jsdelivr": "dist/umd/index.production.js",
   "sideEffects": false,
   "files": [
     "dist/"
diff --git a/packages/autocomplete-core/rollup.config.js b/packages/autocomplete-core/rollup.config.js
@@ -1,16 +1,5 @@
-import { plugins } from '../../rollup.base.config';
-import { getBundleBanner } from '../../scripts/getBundleBanner';
+import { createRollupConfigs } from '../../scripts/rollup/config';
 
 import pkg from './package.json';
 
-export default {
-  input: 'src/index.ts',
-  output: {
-    file: 'dist/umd/index.js',
-    format: 'umd',
-    sourcemap: true,
-    name: pkg.name,
-    banner: getBundleBanner(pkg),
-  },
-  plugins,
-};
+export default createRollupConfigs({ pkg });
diff --git a/packages/autocomplete-js/package.json b/packages/autocomplete-js/package.json
@@ -12,10 +12,10 @@
   "source": "src/index.ts",
   "types": "dist/esm/index.d.ts",
   "module": "dist/esm/index.js",
-  "main": "dist/umd/index.js",
-  "umd:main": "dist/umd/index.js",
-  "unpkg": "dist/umd/index.js",
-  "jsdelivr": "dist/umd/index.js",
+  "main": "dist/umd/index.production.js",
+  "umd:main": "dist/umd/index.production.js",
+  "unpkg": "dist/umd/index.production.js",
+  "jsdelivr": "dist/umd/index.production.js",
   "sideEffects": false,
   "files": [
     "dist/"
diff --git a/packages/autocomplete-js/rollup.config.js b/packages/autocomplete-js/rollup.config.js
@@ -1,16 +1,5 @@
-import { plugins } from '../../rollup.base.config';
-import { getBundleBanner } from '../../scripts/getBundleBanner';
+import { createRollupConfigs } from '../../scripts/rollup/config';
 
 import pkg from './package.json';
 
-export default {
-  input: 'src/index.ts',
-  output: {
-    file: 'dist/umd/index.js',
-    format: 'umd',
-    sourcemap: true,
-    name: pkg.name,
-    banner: getBundleBanner(pkg),
-  },
-  plugins,
-};
+export default createRollupConfigs({ pkg });
diff --git a/packages/autocomplete-plugin-query-suggestions/package.json b/packages/autocomplete-plugin-query-suggestions/package.json
@@ -12,10 +12,10 @@
   "source": "src/index.ts",
   "types": "dist/esm/index.d.ts",
   "module": "dist/esm/index.js",
-  "main": "dist/umd/index.js",
-  "umd:main": "dist/umd/index.js",
-  "unpkg": "dist/umd/index.js",
-  "jsdelivr": "dist/umd/index.js",
+  "main": "dist/umd/index.production.js",
+  "umd:main": "dist/umd/index.production.js",
+  "unpkg": "dist/umd/index.production.js",
+  "jsdelivr": "dist/umd/index.production.js",
   "sideEffects": false,
   "files": [
     "dist/"
diff --git a/packages/autocomplete-plugin-query-suggestions/rollup.config.js b/packages/autocomplete-plugin-query-suggestions/rollup.config.js
@@ -1,16 +1,5 @@
-import { plugins } from '../../rollup.base.config';
-import { getBundleBanner } from '../../scripts/getBundleBanner';
+import { createRollupConfigs } from '../../scripts/rollup/config';
 
 import pkg from './package.json';
 
-export default {
-  input: 'src/index.ts',
-  output: {
-    file: 'dist/umd/index.js',
-    format: 'umd',
-    sourcemap: true,
-    name: pkg.name,
-    banner: getBundleBanner(pkg),
-  },
-  plugins,
-};
+export default createRollupConfigs({ pkg });
diff --git a/packages/autocomplete-plugin-recent-searches/package.json b/packages/autocomplete-plugin-recent-searches/package.json
@@ -12,10 +12,10 @@
   "source": "src/index.ts",
   "types": "dist/esm/index.d.ts",
   "module": "dist/esm/index.js",
-  "main": "dist/umd/index.js",
-  "umd:main": "dist/umd/index.js",
-  "unpkg": "dist/umd/index.js",
-  "jsdelivr": "dist/umd/index.js",
+  "main": "dist/umd/index.production.js",
+  "umd:main": "dist/umd/index.production.js",
+  "unpkg": "dist/umd/index.production.js",
+  "jsdelivr": "dist/umd/index.production.js",
   "sideEffects": false,
   "files": [
     "dist/"
diff --git a/packages/autocomplete-plugin-recent-searches/rollup.config.js b/packages/autocomplete-plugin-recent-searches/rollup.config.js
@@ -1,16 +1,5 @@
-import { plugins } from '../../rollup.base.config';
-import { getBundleBanner } from '../../scripts/getBundleBanner';
+import { createRollupConfigs } from '../../scripts/rollup/config';
 
 import pkg from './package.json';
 
-export default {
-  input: 'src/index.ts',
-  output: {
-    file: 'dist/umd/index.js',
-    format: 'umd',
-    sourcemap: true,
-    name: pkg.name,
-    banner: getBundleBanner(pkg),
-  },
-  plugins,
-};
+export default createRollupConfigs({ pkg });
diff --git a/packages/autocomplete-plugin-recent-searches/src/createRecentSearchesPlugin.ts b/packages/autocomplete-plugin-recent-searches/src/createRecentSearchesPlugin.ts
@@ -94,6 +94,7 @@ export function createRecentSearchesPlugin<TItem extends RecentSearchesItem>({
         // because we need to resolve the promise before getting the value.
         if (!Array.isArray(lastItemsRef.current)) {
           warn(
+            false,
             'The `getAlgoliaQuerySuggestionsFacetFilters` function is not supported with storages that return promises in `getAll`.'
           );
           return params;
diff --git a/packages/autocomplete-preset-algolia/package.json b/packages/autocomplete-preset-algolia/package.json
@@ -16,10 +16,10 @@
   "source": "src/index.ts",
   "types": "dist/esm/index.d.ts",
   "module": "dist/esm/index.js",
-  "main": "dist/umd/index.js",
-  "umd:main": "dist/umd/index.js",
-  "unpkg": "dist/umd/index.js",
-  "jsdelivr": "dist/umd/index.js",
+  "main": "dist/umd/index.production.js",
+  "umd:main": "dist/umd/index.production.js",
+  "unpkg": "dist/umd/index.production.js",
+  "jsdelivr": "dist/umd/index.production.js",
   "scripts": {
     "build:clean": "rm -rf ./dist",
     "build:esm": "babel src --root-mode upward --extensions '.ts,.tsx' --out-dir dist/esm --ignore '**/*/__tests__/'",
diff --git a/packages/autocomplete-preset-algolia/rollup.config.js b/packages/autocomplete-preset-algolia/rollup.config.js
@@ -1,16 +1,5 @@
-import { plugins } from '../../rollup.base.config';
-import { getBundleBanner } from '../../scripts/getBundleBanner';
+import { createRollupConfigs } from '../../scripts/rollup/config';
 
 import pkg from './package.json';
 
-export default {
-  input: 'src/index.ts',
-  output: {
-    file: 'dist/umd/index.js',
-    format: 'umd',
-    sourcemap: true,
-    name: pkg.name,
-    banner: getBundleBanner(pkg),
-  },
-  plugins,
-};
+export default createRollupConfigs({ pkg });
diff --git a/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitHighlight.test.ts b/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitHighlight.test.ts
@@ -169,7 +169,7 @@ describe('parseAlgoliaHitHighlight', () => {
           },
         },
       });
-    }).toWarn(
+    }).toWarnDev(
       '[Autocomplete] The attribute "_highlightResult.description.value" does not exist on the hit. Did you set it in `attributesToHighlight`?' +
         '\nSee https://www.algolia.com/doc/api-reference/api-parameters/attributesToHighlight/'
     );
diff --git a/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitReverseHighlight.test.ts b/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitReverseHighlight.test.ts
@@ -186,7 +186,7 @@ describe('parseAlgoliaHitReverseHighlight', () => {
           },
         },
       });
-    }).toWarn(
+    }).toWarnDev(
       '[Autocomplete] The attribute "_highlightResult.description.value" does not exist on the hit. Did you set it in `attributesToHighlight`?' +
         '\nSee https://www.algolia.com/doc/api-reference/api-parameters/attributesToHighlight/'
     );
diff --git a/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitReverseSnippet.test.ts b/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitReverseSnippet.test.ts
@@ -160,7 +160,7 @@ describe('parseAlgoliaHitReverseSnippet', () => {
           },
         },
       });
-    }).toWarn(
+    }).toWarnDev(
       '[Autocomplete] The attribute "_snippetResult.description.value" does not exist on the hit. Did you set it in `attributesToSnippet`?' +
         '\nSee https://www.algolia.com/doc/api-reference/api-parameters/attributesToSnippet/'
     );
diff --git a/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitSnippet.test.ts b/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitSnippet.test.ts
@@ -160,7 +160,7 @@ describe('parseAlgoliaHitSnippet', () => {
           },
         },
       });
-    }).toWarn(
+    }).toWarnDev(
       '[Autocomplete] The attribute "_snippetResult.description.value" does not exist on the hit. Did you set it in `attributesToSnippet`?' +
         '\nSee https://www.algolia.com/doc/api-reference/api-parameters/attributesToSnippet/'
     );
diff --git a/packages/autocomplete-preset-algolia/src/highlight/parseAlgoliaHitHighlight.ts b/packages/autocomplete-preset-algolia/src/highlight/parseAlgoliaHitHighlight.ts
@@ -16,6 +16,7 @@ export function parseAlgoliaHitHighlight<THit extends Hit<{}>>({
 
   if (typeof highlightedValue !== 'string') {
     warn(
+      false,
       `The attribute ${JSON.stringify(
         path
       )} does not exist on the hit. Did you set it in \`attributesToHighlight\`?` +
diff --git a/packages/autocomplete-preset-algolia/src/highlight/parseAlgoliaHitSnippet.ts b/packages/autocomplete-preset-algolia/src/highlight/parseAlgoliaHitSnippet.ts
@@ -16,6 +16,7 @@ export function parseAlgoliaHitSnippet<THit extends Hit<{}>>({
 
   if (typeof highlightedValue !== 'string') {
     warn(
+      false,
       `The attribute ${JSON.stringify(
         path
       )} does not exist on the hit. Did you set it in \`attributesToSnippet\`?` +
diff --git a/packages/autocomplete-shared/global.d.ts b/packages/autocomplete-shared/global.d.ts
@@ -0,0 +1 @@
+declare const __DEV__: boolean;
diff --git a/packages/autocomplete-shared/src/__tests__/warn.test.ts b/packages/autocomplete-shared/src/__tests__/warn.test.ts
@@ -3,19 +3,31 @@
 import { warn } from '../warn';
 
 describe('warn', () => {
+  test('logs when the condition is unmet', () => {
+    expect(() => {
+      warn(false, 'warning');
+    }).toWarnDev('[Autocomplete] warning');
+  });
+
+  test('does not log when the condition is unmet', () => {
+    expect(() => {
+      warn(true, 'warning');
+    }).not.toWarnDev();
+  });
+
   test('trims the message', () => {
     expect(() => {
-      warn('\nwarning! ');
-    }).toWarn('[Autocomplete] warning!');
+      warn(false, '\nwarning! ');
+    }).toWarnDev('[Autocomplete] warning!');
   });
 
   test('warns a message a single time', () => {
     const originalConsoleWarn = console.warn;
     console.warn = jest.fn();
 
-    warn('warning1');
-    warn('warning1');
-    warn('warning2');
+    warn(false, 'warning1');
+    warn(false, 'warning1');
+    warn(false, 'warning2');
 
     expect(console.warn).toHaveBeenCalledTimes(2);
     expect(console.warn).toHaveBeenNthCalledWith(1, '[Autocomplete] warning1');
diff --git a/packages/autocomplete-shared/src/warn.ts b/packages/autocomplete-shared/src/warn.ts
@@ -2,7 +2,19 @@ export const warnCache = {
   current: {},
 };
 
-export function warn(message: string) {
+/**
+ * Logs a warning if the condition is not met.
+ * This is used to log issues in development environment only.
+ */
+export function warn(condition: boolean, message: string) {
+  if (!__DEV__) {
+    return;
+  }
+
+  if (condition) {
+    return;
+  }
+
   const sanitizedMessage = message.trim();
   const hasAlreadyPrinted = warnCache.current[sanitizedMessage];
 
diff --git a/packages/website/docusaurus.config.js b/packages/website/docusaurus.config.js
@@ -1,5 +1,3 @@
-/* eslint-disable import/no-commonjs */
-
 module.exports = {
   title: 'Autocomplete',
   tagline: 'JavaScript library for building autocomplete search experiences.',
diff --git a/rollup.base.config.js b/rollup.base.config.js
diff --git a/scripts/babel/__tests__/wrap-warning-with-dev-check.test.js b/scripts/babel/__tests__/wrap-warning-with-dev-check.test.js
diff --git a/scripts/babel/wrap-warning-with-dev-check.js b/scripts/babel/wrap-warning-with-dev-check.js
diff --git a/scripts/jest/matchers/__tests__/toWarnDev.test.ts b/scripts/jest/matchers/__tests__/toWarnDev.test.ts
diff --git a/scripts/jest/matchers/index.ts b/scripts/jest/matchers/index.ts
diff --git a/scripts/jest/matchers/toWarnDev.d.ts b/scripts/jest/matchers/toWarnDev.d.ts
diff --git a/scripts/jest/matchers/toWarnDev.ts b/scripts/jest/matchers/toWarnDev.ts
diff --git a/scripts/jest/setupTests.ts b/scripts/jest/setupTests.ts
diff --git a/scripts/rollup/config.js b/scripts/rollup/config.js
diff --git a/ship.config.js b/ship.config.js

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ module.exports = {`
`74`	`74`	`},`
`75`	`75`	`},`
`76`	`76`	`{`
`77`		`- files: ['scripts/*/'],`
	`77`	`+ files: ['scripts/*/', '*.config.js'],`
`78`	`78`	`rules: {`
`79`	`79`	`'import/no-commonjs': 'off',`
`80`	`80`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1,23 +1,23 @@`
`1`	`1`	`{`
`2`	`2`	`"files": [`
`3`	`3`	`{`
`4`		`- "path": "packages/autocomplete-core/dist/umd/index.js",`
	`4`	`+ "path": "packages/autocomplete-core/dist/umd/index.production.js",`
`5`	`5`	`"maxSize": "4.5 kB"`
`6`	`6`	`},`
`7`	`7`	`{`
`8`		`- "path": "packages/autocomplete-js/dist/umd/index.js",`
	`8`	`+ "path": "packages/autocomplete-js/dist/umd/index.production.js",`
`9`	`9`	`"maxSize": "8 kB"`
`10`	`10`	`},`
`11`	`11`	`{`
`12`		`- "path": "packages/autocomplete-preset-algolia/dist/umd/index.js",`
	`12`	`+ "path": "packages/autocomplete-preset-algolia/dist/umd/index.production.js",`
`13`	`13`	`"maxSize": "1.5 kB"`
`14`	`14`	`},`
`15`	`15`	`{`
`16`		`- "path": "packages/autocomplete-plugin-recent-searches/dist/umd/index.js",`
	`16`	`+ "path": "packages/autocomplete-plugin-recent-searches/dist/umd/index.production.js",`
`17`	`17`	`"maxSize": "2.5 kB"`
`18`	`18`	`},`
`19`	`19`	`{`
`20`		`- "path": "packages/autocomplete-plugin-query-suggestions/dist/umd/index.js",`
	`20`	`+ "path": "packages/autocomplete-plugin-query-suggestions/dist/umd/index.production.js",`
`21`	`21`	`"maxSize": "2.25 kB"`
`22`	`22`	`}`
`23`	`23`	`]`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-/* eslint-disable import/no-commonjs */`
`2`		`-`
`3`	`1`	`module.exports = {`
`4`	`2`	`rootDir: process.cwd(),`
`5`	`3`	`setupFilesAfterEnv: [`