Skip to content

castastrophe/postcss-dropunusedvars

Repository files navigation

postcss-dropunusedvars

Remove or report on unused variable definitions

Installation

yarn add -D postcss-dropunusedvars

Via the command line:

postcss -u postcss-dropunusedvars -o dist/index.css src/index.css

In the postcss config:

require("postcss-dropunusedvars")({ fix: true });

Options

fix

Type: boolean
Default: false

Remove unused variables from the output or, if false, report on them to the console.

Usage

Assuming you have some variables defined and rule(s) that use them:

:root {
	--prefix-component-background-color: blue;
	--prefix-component-width: 10px;
	--prefix-component-height: 10px;
	--prefix-component-size: 10px;
}

.component {
	background-color: var(--prefix-component-background-color);

	width: var(--prefix-component-width);
	height: var(--prefix-component-height);
}

The variables that are not used in any rule will be removed from the output:

:root {
	--prefix-component-background-color: blue;
	--prefix-component-width: 10px;
	--prefix-component-height: 10px;
}

.component {
	background-color: var(--prefix-component-background-color);

	width: var(--prefix-component-width);
	height: var(--prefix-component-height);
}

TODO

  • Add test for broken var function that returns no word nodes, e.g. var() or var(calc(),)
  • Incorporate support for checking against external files and their variable use

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

Apache 2.0 © Cassondra Roberts