Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
babel-plugin-optimize-clsx
Advanced tools
Babel plugin to optimize the use of clsx, classnames, and all libraries with a compatible API
Babel plugin to optimize the use of clsx, classnames, and all libraries with a compatible API
yarn add babel-plugin-optimize-clsx --dev
or
npm install babel-plugin-optimize-clsx --save-dev
clsx({
[classes.disabled]: disabled,
[classes.focusVisible]: focusVisible && !disabled,
});
// Transforms to
clsx(disabled && classes.disabled, focusVisible && !disabled && classes.focusVisible);
clsx({
[classes.disabled]: disabled,
[classes.focusVisible]: focusVisible && !disabled,
});
// Transforms to
clsx(disabled ? classes.disabled : focusVisible && classes.focusVisible);
clsx({
[classes.focusVisible]: this.state.focusVisible,
[focusVisibleClassName]: this.state.focusVisible,
});
// Transforms to
clsx(this.state.focusVisible && [classes.focusVisible, focusVisibleClassName]);
function foo(props) {
const { position: p } = props;
const x = clsx({
[classes.x]: p === 'top',
[classes.y]: p === 'bottom',
});
}
foo.propTypes = {
position: PropTypes.oneOf(['top', 'bottom']),
};
// Transforms to
function foo(props) {
const { position: p } = props;
const x = clsx(p === 'top' ? classes.x : classes.y);
}
foo.propTypes = {
position: PropTypes.oneOf(['top', 'bottom']),
};
const x = clsx({
btn: true,
'col-md-1': true,
['btn-primary']: true,
});
// Transforms to
const x = 'btn col-md-1 btn-primary';
const x = clsx({
btn: true,
'btn-foo': isDisabled,
'btn-bar': !isDisabled,
});
// Transforms to
const x = 'btn ' + (isDisabled ? 'btn-foo' : 'btn-bar');
Benchmarks can be found in the benchmark
directory
Name | Type | Default value |
---|---|---|
libraries | string[] | ['clsx', 'classnames'] |
By default the plugin looks for import
and require
statements for clsx
and classnames
and uses that to know which function calls to optimize. If you're using another library with a compatible API you can overwrite that with this option.
{
"plugins": [
[
"babel-plugin-optimize-clsx",
{
"libraries": ["clsx", "classnames", "my-custom-library"]
}
]
]
}
Name | Type | Default value |
---|---|---|
functionNames | string[] | [] |
If you want the plugin to match on all functions with a specific name, no matter where it comes from you can specify them using this option. An example for this is if you have clsx
as a global function and thus don't import it.
{
"plugins": [
[
"babel-plugin-optimize-clsx",
{
"functionNames": ["myClsxImplementation"]
}
]
]
}
Name | Type | Default value |
---|---|---|
removeUnnecessaryCalls | boolean | true |
By default the plugin will remove unnecessary function calls and if all calls are removed, imports. If you need to keep them, you can set this option to false.
Example of some unnecessary calls
import clsx from 'clsx';
const x = clsx('foo', 'bar');
const y = clsx({ classA: foo === 'a', classB: foo !== 'a' });
const z = clsx({
classA: foo === 'a',
classB: foo !== 'a',
classC: bar === 'c',
classD: bar !== 'c',
});
// Transforms to
const x = 'foo bar';
const y = foo === 'a' ? 'classA' : 'classB';
const z = (foo === 'a' ? 'classA ' : 'classB ') + (bar === 'c' ? 'classC' : 'classD');
FAQs
Babel plugin to optimize the use of clsx, classnames, and all libraries with a compatible API
The npm package babel-plugin-optimize-clsx receives a total of 20,038 weekly downloads. As such, babel-plugin-optimize-clsx popularity was classified as popular.
We found that babel-plugin-optimize-clsx demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.