Checkbox: Add checkProps if using old checkbox

If oldEventParameterOrder is true, a warning will fire. This will tell folks to change their path—if they are consuming the source code.

The CommonJS named imports will just have to break at the next breaking change due to the parameter change, since you can’t change the path.

Author: interactivellama

components/checkbox/__examples__/default.jsx

@@ -1,7 +1,7 @@
 import React from 'react';
 // `~` is replaced with design-system-react at runtime
 import IconSettings from '~/components/icon-settings';
-import Checkbox from '~/components/checkbox';
+import Checkbox from '~/components/forms/checkbox';
 
 class Example extends React.Component {
 	static displayName = 'CheckboxExample';

components/checkbox/check-props.js

@@ -3,12 +3,23 @@
 /* eslint-disable import/no-mutable-exports */
 /* eslint-disable max-len */
 
+import deprecatedEventParameter from '../../utilities/warning/deprecated-event-parameter';
 import onlyOneOfProperties from '../../utilities/warning/only-one-of-properties';
 
 let checkProps = function () {};
 
 if (process.env.NODE_ENV !== 'production') {
 	checkProps = function (COMPONENT, props) {
+		deprecatedEventParameter(
+			COMPONENT,
+			{
+				oldEventParameterOrder: props.oldEventParameterOrder,
+				propAsString: 'onChange',
+				propAsValue: props.onChange,
+			},
+			'`components/forms/checkbox` is deprecated. `components/checkbox` should be used. When this path update is made `onChange` event parameters will change from `onChange(value, event, { value } to `onChange(event, { value }). Please update your event parameters when you change paths.` If you are using the CommonJS named import, `Checkbox` events will break at the next breaking change release. Please review https://github.com/salesforce/design-system-react/releases when you upgrade.'
+		);
+
 		if (props.variant === 'toggle' && props.indeterminate === true) {
 			onlyOneOfProperties(
 				COMPONENT,

components/forms/checkbox/index.jsx

@@ -5,8 +5,6 @@ import React from 'react';
 // Alias
 import Checkbox from '../../checkbox';
 
-const OldCheckbox = (props) => (
-	<Checkbox oldEventParameterOrder {...props} />
-);
+const OldCheckbox = (props) => <Checkbox oldEventParameterOrder {...props} />;
 
 export default OldCheckbox;

components/index.js

@@ -47,8 +47,8 @@ export CardEmpty from './card/empty';
 export SLDSCardFilter from './card/filter';
 export CardFilter from './card/filter';
 
-export SLDSCheckbox from './checkbox';
-export Checkbox from './checkbox';
+export SLDSCheckbox from './forms/checkbox';
+export Checkbox from './forms/checkbox';
 
 export SLDSCombobox from './combobox';
 export Combobox from './combobox';

utilities/warning/deprecated-event-parameter.js

@@ -0,0 +1,45 @@
+/* Copyright (c) 2015-present, salesforce.com, inc. All rights reserved */
+/* Licensed under BSD 3-Clause - see LICENSE.txt or git.io/sfdc-license */
+
+/* eslint-disable import/no-mutable-exports */
+/* eslint-disable max-len */
+
+// This function will deliver a warning message to the browser console about an event parameter change.
+import lowPriorityWarning from './low-priority-warning';
+
+let deprecated = function () {};
+
+if (process.env.NODE_ENV !== 'production') {
+	const hasWarned = {};
+
+	deprecated = function (
+		control,
+		{
+			oldEventParameterOrder, // flag that tells which parameter order is in use
+			propAsString, // key name of prop being warned about
+			log, // log function that will disable console warning and pipe to another function log({ message })
+		},
+		comment
+	) {
+		const additionalComment = comment ? ` ${comment}` : '';
+		const warnOnFirstOccurrenceKey = control + propAsString;
+		const triggerWarning = oldEventParameterOrder;
+
+		if (!hasWarned[warnOnFirstOccurrenceKey]) {
+			const message = `[Design System React] ${additionalComment}`;
+
+			if (triggerWarning && log) {
+				log({ message });
+			} else {
+				lowPriorityWarning(
+					!triggerWarning, // false value triggers warning
+					message
+				);
+			}
+			// store global flag to limit warnings to first issue
+			hasWarned[warnOnFirstOccurrenceKey] = triggerWarning;
+		}
+	};
+}
+
+export default deprecated;