find-unused-sass-variables
    Overview
    Documentation
    Code
    Playground
    Issues
    Insights
    Contributors
    Dependencies
    Versions
    Alternatives

find-unused-sass-variables

A small tool to find unused Sass variables

0.5.0  •  Published 25 days ago  •  by XhmikosR  •  MIT License

NPM version Build Status Dependency Status devDependency Status

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"
# or
fusv folder [, folder2...]

API

const fusv = require('find-unused-sass-variables')
// 'scss' is a folder
let unused = fusv.find('scss')
// Array of unused variables
console.log(unused.unused);
// ['$foo', '$bar', '$imunused']
console.log(unused.total);
// Total number of variables in the files

// ignoring variables
const ignoredVars = ['$my-var', '$my-second-var']
unused = fusv.find('scss', { ignore: ignoredVars })

find(dir, options)

  • dir: string
  • options: 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).

options.ignore

Array of strings of the variables to ignore, e.g. ['$my-var', '$my-second-var']

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 currently.

License

MIT

Popularity

Weekly Downloads
1.9K

Maintenance

Development

Last ver 25 days ago
Created 1 year ago
Last commit 1 second ago
1 second between commits

Technology

Node version: 12.8.1
8.5K unpacked

Legal and Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

0 contributors

Tags

sass
unused
variables
scss