@salesforce/design-system-react
Version:
Salesforce Lightning Design System for React
54 lines (45 loc) • 2.13 kB
JavaScript
/* 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 an error message to the browser console about the future of a removal and moving of a property's valid value to another prop. This makes the most sense to be used with `oneOf` prop types.
import warning from 'warning';
let deprecated = function deprecatedFunction() {};
if (process.env.NODE_ENV !== 'production') {
const hasWarned = {};
deprecated = function deprecatedFunction(
control,
{
propAsString, // key name of prop being warned about
propValue, // actual value of prop being warned about
deprecatedPropValue, // value that is being deprecated
replacementPropAsString, // prop that value is being moved to
replacementPropAsValue, // value that should be used in new prop
log, // log function that will disable console warning and pipe to another function log({ message })
},
comment
) {
const additionalComment = comment ? ` ${comment}` : '';
const warnOnFirstOccurrenceKey =
control + propAsString + deprecatedPropValue;
const triggerWarning = propValue === deprecatedPropValue;
const replacementSentence =
deprecatedPropValue && replacementPropAsString && replacementPropAsValue
? ` Replace \`${propAsString}="${deprecatedPropValue}"\` with \`${replacementPropAsString}="${replacementPropAsValue}"\`.`
: '';
if (!hasWarned[warnOnFirstOccurrenceKey]) {
const message = `[Design System React] The value of \`${deprecatedPropValue}\`, for prop \`${propAsString}\` will be removed in the next major version of ${control}. Please update your props.${replacementSentence}${additionalComment}`;
if (triggerWarning && log) {
log({ message });
} else {
warning(
!triggerWarning, // false value triggers warning
message
);
}
// store global flag to limit warnings to first issue
hasWarned[warnOnFirstOccurrenceKey] = triggerWarning;
}
};
}
export default deprecated;