Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Clarify `total`
  • Loading branch information
XhmikosR committed Aug 21, 2019
1 parent 1f91f1d commit f101054
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A simple tool to check for unused Sass variables in a directory.
## Usage

```shell
find-unused-sass-variables folder [, folder2...] --ignore '$my-var,$my-second-var'
find-unused-sass-variables folder [, folder2...] --ignore "$my-var,$my-second-var"
# or
fusv folder [, folder2...]
```
Expand All @@ -25,7 +25,7 @@ let unused = fusv.find('scss')
console.log(unused.unused);
// ['$foo', '$bar', '$imunused']
console.log(unused.total);
// 3
// Total number of variables in the files

// ignoring variables
const ignoredVars = ['$my-var', '$my-second-var']
Expand All @@ -37,7 +37,7 @@ unused = fusv.find('scss', { ignore: ignoredVars })
* `dir`: string
* `options`: optional options Object

Returns an object with `unused` and `total`. `unused` has the array of unused variables and `total` their count.
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

Expand Down

0 comments on commit f101054

Please sign in to comment.