From 5c0805c5c6c82efd8ebc9490c72bd86317b0940c Mon Sep 17 00:00:00 2001 From: XhmikosR Date: Thu, 27 Apr 2023 14:54:23 +0300 Subject: [PATCH] BREAKING: change default exports to named ones --- README.md | 12 ++++++------ cli.js | 4 ++-- index.js | 13 ++++++------- tests/integration.js | 6 +++--- tests/options.js | 4 ++-- 5 files changed, 19 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index a2600ec..53e996c 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,10 @@ fusv folder [, folder2...] --ignore "$my-var,$my-second-var" -e scss -e css --ig ## API ```js -import fusv from 'find-unused-sass-variables'; +import { findAsync, find } from 'find-unused-sass-variables'; // 'directory' is a folder -const unused = fusv.find('directory'); +const unused = find('directory'); // Array of unused variables console.log(unused.unused); // Array<{ name: string, line: string, file: string }> @@ -48,7 +48,7 @@ console.log(unused.total); ```js // Ignoring variables const ignoredVars = ['$my-var', '$my-second-var']; -const unused = fusv.find('directory', { ignore: ignoredVars }); +const unused = find('directory', { ignore: ignoredVars }); ``` ```js @@ -59,15 +59,15 @@ const unused = fusv.find('directory', { ignoreFiles }); ```js // Specifying file extensions -const unused = fusv.find('directory', { fileExtensions: ['css','scss']}); +const unused = find('directory', { fileExtensions: ['css','scss']}); ``` ```js // Asynchronous usage -let unused = await fusv.findAsync('directory'); +let unused = await findAsync('directory'); // or like a Promise -unused = fusv.findAsync('directory').then(result => { +unused = findAsync('directory').then(result => { console.log(unused.unused); }); ``` diff --git a/cli.js b/cli.js index d974faa..bbdf5fd 100644 --- a/cli.js +++ b/cli.js @@ -5,7 +5,7 @@ import process from 'node:process'; import path from 'node:path'; import { program } from 'commander'; import picocolors from 'picocolors'; -import fusv from './index.js'; +import { findAsync } from './index.js'; const { version } = JSON.parse(await fs.readFile(new URL('package.json', import.meta.url))); @@ -43,7 +43,7 @@ async function main() { const executeForPath = async(arg, options) => { const dir = path.resolve(arg); - const unusedVars = await fusv.findAsync(dir, options); + const unusedVars = await findAsync(dir, options); const unusedVarsNumber = unusedVars.unused.length; console.log(`\nSearching for unused variables in "${picocolors.cyan(dir)}" folder, ${picocolors.cyan(options.fileExtensions.join(', '))} files...`); diff --git a/index.js b/index.js index e64581f..72298f5 100644 --- a/index.js +++ b/index.js @@ -14,7 +14,7 @@ const defaultOptions = { fileExtensions: ['scss'] }; -const findUnusedVarsAsync = async(strDir, opts) => { +const findAsync = async(strDir, opts = {}) => { const options = parseOptions(opts); const dir = await sanitizeDirAsync(strDir); // Array of all Sass files @@ -29,7 +29,7 @@ const findUnusedVarsAsync = async(strDir, opts) => { return makeResults(sassFilesString); }; -const findUnusedVarsSync = (strDir, opts) => { +const findSync = (strDir, opts = {}) => { const options = parseOptions(opts); const dir = sanitizeDirSync(strDir); // Array of all Sass files @@ -89,7 +89,7 @@ const filterVariables = (sassFilesString, variables) => { }; }; -const parseOptions = opts => { +const parseOptions = (opts = {}) => { const options = { ...defaultOptions, ...opts }; if (Boolean(options.ignore) && !Array.isArray(options.ignore)) { @@ -138,8 +138,7 @@ function checkDir(stat, dir) { return dir; } -/* eslint-disable-next-line import/no-anonymous-default-export */ -export default { - findAsync: findUnusedVarsAsync, - find: findUnusedVarsSync +export { + findSync as find, + findAsync }; diff --git a/tests/integration.js b/tests/integration.js index 9c6e2b3..af1a78e 100644 --- a/tests/integration.js +++ b/tests/integration.js @@ -1,7 +1,7 @@ #!/usr/bin/env node import process from 'node:process'; -import fusv from '../index.js'; +import { find, findAsync } from '../index.js'; const expectedUnused = [ '$a', @@ -31,7 +31,7 @@ const runTests = (type, result) => { }; try { - const result = fusv.find('./tests/', { ignore, ignoreFiles }); + const result = find('./tests/', { ignore, ignoreFiles }); runTests('sync', result); } catch (error) { console.error(error); @@ -40,7 +40,7 @@ try { (async() => { try { - const result = await fusv.findAsync('./tests/', { ignore, ignoreFiles }); + const result = await findAsync('./tests/', { ignore, ignoreFiles }); runTests('async', result); } catch (error) { console.error(error); diff --git a/tests/options.js b/tests/options.js index e6cbba2..b951344 100644 --- a/tests/options.js +++ b/tests/options.js @@ -1,7 +1,7 @@ #!/usr/bin/env node import process from 'node:process'; -import fusv from '../index.js'; +import { findAsync } from '../index.js'; const allExpectedUnused = [ '$a', @@ -26,7 +26,7 @@ const ignoreFiles = ['**/ignored-file*.scss']; console.log('Running "Options" tests...'); const runTests = async(description, dir, options, expectedUnused) => { - const result = await fusv.findAsync(dir, options); + const result = await findAsync(dir, options); try { console.log(`Running, ${description}...`);