Add tracking information for unused variables

README.md

@@ -26,20 +26,32 @@ fusv folder [, folder2...]
 
 ```js
 const fusv = require('find-unused-sass-variables')
-// 'scss' is a folder
-let unused = fusv.find('scss')
+// 'directory' is a folder
+let unused = fusv.find('directory')
 // Array of unused variables
 console.log(unused.unused);
-// ['$foo', '$bar', '$imunused']
+// Array<{ name: string, line: string, file: string }>
+/*
+* [
+*   {
+*      name = '$foo';
+*      file = 'file where this variable can be found';
+*      line = 'line of file';
+*   },
+*   {
+*      ....
+*   }
+* ]
+*/
 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 })
+unused = fusv.find('directory', { ignore: ignoredVars })
 
 // specifing file extensions
-unused = fusv.find('scss', { fileExtensions: ['css','scss']})
+unused = fusv.find('directory', { fileExtensions: ['css','scss']})
 
 // asynchornous usage
 let unused = await fusv.findAsync('directory')

cli.js

@@ -51,8 +51,8 @@ const executeForPath = async(arg, options) => {
 
     if (unusedVars.unused.length > 0) {
         console.log(`${chalk.yellowBright.bold(unusedVars.unused.length)} are not used!`);
-        for (const unusedVar of unusedVars.unused) {
-            console.log(`Variable ${chalk.red(unusedVar)} is not being used!`);
+        for (const { name, file, line } of unusedVars.unused) {
+            console.log(`Variable ${chalk.red(name)} is not being used! ${chalk.gray(file)}:${chalk.yellowBright(line)}`);
         }
     } else {
         console.log(chalk.greenBright(`No unused variables found in "${dir}!`));

index.js

@@ -49,21 +49,21 @@ function makeResults(sassFilesAsStrings) {
 
 const parseFileAsync = async(file, options) => {
     const sassFileString = await fs.promises.readFile(file, 'utf8');
-    return parseData(sassFileString, options);
+    return parseData(file, sassFileString, options);
 };
 
 const parseFileSync = (file, options) => {
     const sassFileString = fs.readFileSync(file, 'utf8');
-    return parseData(sassFileString, options);
+    return parseData(file, sassFileString, options);
 };
 
-const parseData = (sassFileString, options) => {
+const parseData = (fileName, sassFileString, options) => {
     // Remove jekyll comments
     if (sassFileString.includes('---')) {
         sassFileString = sassFileString.replace(/---/g, '');
     }
 
-    const variables = parse(sassFileString, options.ignore);
+    const variables = parse(fileName, sassFileString, options.ignore);
 
     return {
         sassFileString,
@@ -74,7 +74,7 @@ const parseData = (sassFileString, options) => {
 const filterVariables = (sassFilesString, variables) => {
     // Store unused vars from all files and loop through each variable
     const unusedVars = variables.filter(variable => {
-        const re = new RegExp(`(${escapeRegex(variable)})\\b(?!-)`, 'g');
+        const re = new RegExp(`(${escapeRegex(variable.name)})\\b(?!-)`, 'g');
 
         return sassFilesString.match(re).length === 1;
     });

lib/parse-variable.js

@@ -4,8 +4,15 @@ import Declaration from 'postcss/lib/declaration';
 import Comment from 'postcss/lib/comment';
 /* eslint-enable node/file-extension-in-import */
 
+let file = '';
 let fusvEnabled = true;
 
+const UnusedInfo = function(node) {
+    this.name = node.prop;
+    this.line = node.source.start.line;
+    this.file = file;
+};
+
 const parseNodes = (nodes, variables, ignoreList) => {
     for (const node of nodes) {
         findVars(node, variables, ignoreList);
@@ -20,7 +27,7 @@ const findVars = (node, result, ignoreList) => {
     }
 
     if (node instanceof Declaration && node.prop.startsWith('$') && !ignoreList.includes(node.prop) && fusvEnabled) {
-        result.push(node.prop);
+        result.push(new UnusedInfo(node));
 
         return;
     }
@@ -38,7 +45,8 @@ const parseComment = node => {
     }
 };
 
-const parse = (scssString, ignoreList) => {
+const parse = (fileName, scssString, ignoreList) => {
+    file = fileName;
     const parsedScss = scssParse(scssString);
     const variables = [];