find-unused-sass-variables
A simple tool to check for unused Sass variables in a directory.
Install
npm install find-unused-sass-variables --save-dev
Usage
find-unused-sass-variables folder [, folder2...] --ignore "$my-var,$my-second-var" -e scss -e css --ignoreFiles file-with-unused-vars.scss
# or
fusv folder [, folder2...] --ignore "$my-var,$my-second-var" -e scss -e css --ignoreFiles file-with-unused-vars.scss
API
import { findAsync, find } from 'find-unused-sass-variables';
const unused = find('directory');
console.log(unused.unused);
console.log(unused.total);
const ignoredVars = ['$my-var', '$my-second-var'];
const unused = find('directory', { ignore: ignoredVars });
const ignoreFiles = ['./file-with-unused-vars.scss', '**/_variables.scss'];
const unused = fusv.find('directory', { ignoreFiles });
const unused = find('directory', { fileExtensions: ['css','scss']});
let unused = await findAsync('directory');
unused = findAsync('directory').then(result => {
console.log(unused.unused);
});
find(dir, options)
dir
: stringoptions
: optional options Object
Returns an object with unused
and total
. unused
has the array of unused variables and total
has the sum of all variables in the files (unused and used ones).
findAsync(dir, options)
Returns a Promise which resolves result; returns the same as find(dir, options)
.
options.ignore
Array of strings of the variables to ignore, e.g. ['$my-var', '$my-second-var']
options.ignoreFiles
Array of strings of files to ignore, e.g. ['./file-with-unused-vars.scss', '**/_variables.scss']
.
options.fileExtensions
Array of file extensions to search for unused variables in. e.g. ['scss']
Disable & enable
Disable or enable fusv
with the fusv-disable
and fusv-enable
comments:
$used-variable-1: #666;
$unused-variable: #coffee;
$used-variable-2: #ace;
Notes
- The tool's logic is pretty "dumb"; if you use the same name for a variable in different files or namespaces,
then it won't distinguish between them.
- The tool only looks for
.scss
files by default, but you can optionally specify the file extension.
License
MIT