@adamlui/scss-to-css 1.7.0 → 1.7.2

package/README.md

@@ -1,4 +1,4 @@
-<div align="right">
+<div align="center">
     <h6>
         <picture>
             <source type="image/svg+xml" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/earth-icon/white/icon32.svg">
@@ -10,7 +10,11 @@
         <a href="https://github.com/adamlui/js-utils/tree/main/scss-to-css/docs/hi#readme">हिंदी</a> |
         <a href="https://github.com/adamlui/js-utils/tree/main/scss-to-css/docs/bn#readme">বাংলা</a> |
         <a href="https://github.com/adamlui/js-utils/tree/main/scss-to-css/docs/mr#readme">मराठी</a> |
-        <a href="https://github.com/adamlui/js-utils/tree/main/scss-to-css/docs/pa#readme">ਪੰਜਾਬੀ</a>
+        <a href="https://github.com/adamlui/js-utils/tree/main/scss-to-css/docs/pa#readme">ਪੰਜਾਬੀ</a> |
+        <a href="https://github.com/adamlui/js-utils/tree/main/scss-to-css/docs/de#readme">Deutsch</a> |
+        <a href="https://github.com/adamlui/js-utils/tree/main/scss-to-css/docs/es#readme">Español</a> |
+        <a href="https://github.com/adamlui/js-utils/tree/main/scss-to-css/docs/fr#readme">Français</a> |
+        <a href="https://github.com/adamlui/js-utils/tree/main/scss-to-css/docs/pt#readme">Português</a>
     </h6>
 </div>
 
@@ -20,11 +24,11 @@
 
 <a href="https://www.npmjs.com/package/@adamlui/scss-to-css"><img height=31 src="https://img.shields.io/npm/dt/%40adamlui%2Fscss-to-css?logo=npm&color=af68ff&logoColor=white&labelColor=464646&style=for-the-badge"></a>
 <a href="#%EF%B8%8F-mit-license"><img height=31 src="https://img.shields.io/badge/License-MIT-orange.svg?logo=internetarchive&logoColor=white&labelColor=464646&style=for-the-badge"></a>
-<a href="https://www.npmjs.com/package/@adamlui/scss-to-css?activeTab=versions"><img height=31 src="https://img.shields.io/badge/Latest_Build-1.7.0-44cc11.svg?logo=icinga&logoColor=white&labelColor=464646&style=for-the-badge"></a>
+<a href="https://github.com/adamlui/js-utils/releases/tag/scss-to-css-1.7.2"><img height=31 src="https://img.shields.io/badge/Latest_Build-1.7.2-44cc11.svg?logo=icinga&logoColor=white&labelColor=464646&style=for-the-badge"></a>
 <a href="https://www.npmjs.com/package/@adamlui/scss-to-css?activeTab=code"><img height=31 src="https://img.shields.io/npm/unpacked-size/%40adamlui%2Fscss-to-css?style=for-the-badge&logo=ebox&logoColor=white&color=blue&labelColor=464646"></a>
 <a href="https://sonarcloud.io/component_measures?metric=new_vulnerabilities&id=adamlui_js-utils:scss-to-css/scss-to-css.js"><img height=31 src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fsonarcloud.io%2Fapi%2Fmeasures%2Fcomponent%3Fcomponent%3Dadamlui_js-utils%3Ascss-to-css%2Fscss-to-css.js%26metricKeys%3Dvulnerabilities&query=%24.component.measures.0.value&style=for-the-badge&logo=sonarcloud&logoColor=white&labelColor=464646&label=Vulnerabilities&color=gold"></a>
 
-<img height=8px width="100%" src="https://github.com/adamlui/js-utils/blob/main/docs/images/aqua-separator.png">
+<img height=6px width="100%" src="https://github.com/adamlui/js-utils/blob/main/docs/images/aqua-separator.png">
 
 ## ⚡ Installation
 
@@ -46,6 +50,10 @@ As a **runtime dependency** (e.g. for on-the-fly compilation), from your project
 $ npm install @adamlui/scss-to-css
 ```
 
+<br>
+
+<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png">
+
 ## 💻 Command line usage
 
 The basic **global command** is:
@@ -84,7 +92,8 @@ To use as a **package script**, in your project's `package.json`:
 ```
 
 Replace `<scss-to-css-cmd>` with `scss-to-css` + optional args. Then, `npm run build:css` can be used to run the command.
-<br><br>
+
+#
 
 ### Example commands
 
@@ -113,7 +122,8 @@ $ scss-to-css input_folder output_folder
 ```
 
 **💡 Note:** Output CSS is minified unless `-M` or `--no-minify` is passed.
-<br><br>
+
+#
 
 ### Command line options
 
@@ -128,11 +138,15 @@ Config options:
  -q, --quiet                 Suppress all logging except errors.
 
 Info commands:
- -h, --help                  Display this help screen.
+ -h, --help                  Display help screen.
  -v, --version               Show version number.
 ```
 
-## 🔌 API reference
+<br>
+
+<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png">
+
+## 🔌 API usage
 
 You can also import **scss-to-css** into your app to use its API methods, both as an ECMAScript module or a CommonJS module.
 
@@ -148,6 +162,8 @@ import * as scssToCSS from '@adamlui/scss-to-css';
 const scssToCSS = require('@adamlui/scss-to-css');
 ```
 
+#
+
 ### `compile(inputPath[, options])`
 
 Compiles SCSS found in the `inputPath` provided into CSS data.
@@ -165,11 +181,11 @@ If a **directory path** is passed, SCSS files are searched for (recursively by d
 
 ```js
 // Outputs paths to SCSS files in working directory + all nested directories
-const results = scssToCSS.compile('.');
-results.forEach(result => console.log(result.srcPath));
+const compileResults = scssToCSS.compile('.');
+compileResults.forEach(result => console.log(result.srcPath));
 
 // Outputs compiled CSS from 2nd SCSS file if found, or `undefined` if not found
-console.log(results[1].code);
+console.log(compileResults[1].code);
 ```
 
 Options are boolean, passed as object properties. For example:
@@ -179,16 +195,17 @@ Options are boolean, passed as object properties. For example:
 scssToCSS.compile(inputDir, { minify: false });
 ```
 
-Possible parameters (and their default settings) are:
+Available parameters (and their default settings) are:
 
-```
- recursive (true)     Recursively search for nested files if dir path
-                      passed.
- verbose (true)       Show logging in console/terminal.
- dotFolders (false)   Include dotfolders in file search.
- minify (true)        Minify output CSS.
- sourceMaps (true)    Generate CSS source maps.
-```
+Name         | Desciption                                              | Default value
+-------------|---------------------------------------------------------|---------------
+`recursive`  | Recursively search for nested files if dir path passed. | `true`
+`verbose`    | Show logging in console/terminal.                       | `true`
+`dotFolders` | Include dotfolders in file search.                      | `false`
+`minify`     | Minify output CSS.                                      | `true`
+`sourceMaps` | Generate CSS source maps.                               | `true`
+
+#
 
 ### `findSCSS(searchDir[, options])`
 
@@ -197,25 +214,31 @@ Searches for all SCSS files within the `searchDir` string passed (useful for dis
 Options are boolean, passed as object properties. For example:
 
 ```js
-// Returns array containing filepaths to SCSS files in exactly `searchDir`
-scssToCSS.findSCSS(searchDir, { recursive: false });
+// Search for SCSS files in exactly assets/scss:
+const searchResults = scssToCSS.findSCSS('assets/scss', { recursive: false });
+console.log(searchResults);
+
+/* sample output:
+Searching for SCSS files...
+Search complete. 2 files found.
+[
+  'E:\\js\\utils\\minify.js\\assets\\scss\\foo.scss',
+  'E:\\js\\utils\\minify.js\\assets\\scss\\bar.scss'
+]
+*/
 ```
 
-Possible parameters (and their default settings) are:
+Available parameters (and their default settings) are:
 
-```
- recursive (true)     Recursively search for nested files if dir path
-                      passed.
- verbose (true)       Show logging in console/terminal.
- dotFolders (false)   Include dotfolders in file search.
-```
+Name         | Desciption                                              | Default value
+-------------|---------------------------------------------------------|---------------
+`recursive`  | Recursively search for nested files if dir path passed. | `true`
+`verbose`    | Show logging in console/terminal.                       | `true`
+`dotFolders` | Include dotfolders in file search.                      | `false`
 
 <br>
 
-## 💖 Support
-
-Please consider [giving a GitHub ⭐](https://github.com/adamlui/js-utils) or [funding](https://github.com/sponsors/adamlui) this project if it helped you!
-<br><br>
+<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png">
 
 ## 🏛️ MIT License
 

package/docs/LICENSE.md

@@ -10,7 +10,11 @@
         <a href="hi/LICENSE.md">हिंदी</a> |
         <a href="bn/LICENSE.md">বাংলা</a> |
         <a href="mr/LICENSE.md">मराठी</a> |
-        <a href="pa/LICENSE.md">ਪੰਜਾਬੀ</a>
+        <a href="pa/LICENSE.md">ਪੰਜਾਬੀ</a> |
+        <a href="de/LICENSE.md">Deutsch</a> |
+        <a href="es/LICENSE.md">Español</a> |
+        <a href="fr/LICENSE.md">Français</a> |
+        <a href="pt/LICENSE.md">Português</a>
     </h6>
 </div>
 

package/docs/SECURITY.md

@@ -10,7 +10,11 @@
         <a href="hi/SECURITY.md">हिंदी</a> |
         <a href="bn/SECURITY.md">বাংলা</a> |
         <a href="mr/SECURITY.md">मराठी</a> |
-        <a href="pa/SECURITY.md">ਪੰਜਾਬੀ</a>
+        <a href="pa/SECURITY.md">ਪੰਜਾਬੀ</a> |
+        <a href="de/SECURITY.md">Deutsch</a> |
+        <a href="es/SECURITY.md">Español</a> |
+        <a href="fr/SECURITY.md">Français</a> |
+        <a href="pt/SECURITY.md">Português</a>
     </h6>
 </div>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adamlui/scss-to-css",
-  "version": "1.7.0",
+  "version": "1.7.2",
   "description": "Recursively compile all SCSS files into minified CSS",
   "author": {
     "name": "Adam Lui",

package/scss-to-css.js

@@ -13,6 +13,28 @@ function findSCSS(searchDir, options = {}) {
     const defaultOptions = { recursive: true, verbose: true, dotFolders: false };
     options = { ...defaultOptions, ...options };
 
+    // Validate searchDir
+    if (!searchDir) return console.error(
+        'findSCSS() error: Please supply a `searchDir` arg.');
+    else if (typeof searchDir !== 'string') return console.error(
+        'findSCSS() error: Arg `searchDir` must be a string.');
+    else { // verify searchDir path existence
+        const searchPath = path.resolve(process.cwd(), searchDir);
+        if (!fs.existsSync(searchPath)) return console.error(
+            'findSCSS() error: Arg `searchDir` must be an existing directory.'
+                + `\n'${ searchPath }' does not exist.`);
+    }
+
+    // Validate options
+    for (const key of Object.keys(options)) {
+        if (!Object.prototype.hasOwnProperty.call(defaultOptions, key))
+            if (key !== 'isRecursing') return console.error(
+                `findSCSS() error: \`${ key }\` is an invalid option.`
+                    + `\nValid options: [ ${Object.keys(defaultOptions).join(', ')} ]`);
+        else if (typeof options[key] !== 'boolean') return console.error(
+            `findSCSS() error: \`${ key }\` option must be set to \`true\` or \`false\`.`);
+    }
+
     // Search for SCSS
     const dirFiles = fs.readdirSync(searchDir), scssFiles = [];
     if (options.verbose && !options.isRecursing) console.info('\nSearching for SCSS files...');
@@ -42,9 +64,23 @@ function compile(inputPath, options = {}) {
     options = { ...defaultOptions, ...options };
 
     // Validate inputPath
-    if (typeof inputPath !== 'string')
-        return console.error('ERROR:'
-            + ' First argument must be a string representing a file/folder path.');
+    if (typeof inputPath !== 'string') return console.error(
+        'compile() error: Arg `inputPath` must be a string.');
+    else { // verify inputPath path existence
+        inputPath = path.resolve(process.cwd(), inputPath);
+        if (!fs.existsSync(inputPath)) return console.error(
+            'compile() error: Arg `inputPath` must be an existing directory or file.'
+                + `\n'${ inputPath }' does not exist.`);
+    }
+
+    // Validate options
+    for (const key of Object.keys(options)) {
+        if (!Object.prototype.hasOwnProperty.call(defaultOptions, key)) return console.error(
+            `findSCSS() error: \`${ key }\` is an invalid option.`
+                + `\nValid options: [ ${Object.keys(defaultOptions).join(', ')} ]`);
+        else if (typeof options[key] !== 'boolean') return console.error(
+            `findSCSS() error: \`${ key }\` option must be set to \`true\` or \`false\`.`);
+    }
 
     // Compile SCSS based on inputPath
     const compileOptions = { style: options.minify ? 'compressed' : 'expanded', sourceMap: options.sourceMaps };
@@ -53,10 +89,11 @@ function compile(inputPath, options = {}) {
             if (options.verbose) console.info(`Compiling ${ inputPath }...`);
             try { // to compile file passed
                 const compileResult = sass.compile(inputPath, compileOptions);
-                return { code: compileResult.css, srcMap: compileResult.sourceMap, srcPath: inputPath };
+                return { code: compileResult.css, srcMap: compileResult.sourceMap,
+                         srcPath: path.resolve(process.cwd(), inputPath) };
             } catch (err) { console.error(`\nERROR: ${ err.message }\n`); return { error: err }; }
         } else { // dir path passed
-            return findSCSS(inputPath, { recursive: options.recursive, verbosity: options.verbose,
+            return findSCSS(inputPath, { recursive: options.recursive, verbose: options.verbose,
                                          dotFolders: options.dotFolders
                 })?.map(scssPath => { // compile found SCSS files
                     if (options.verbose) console.info(`Compiling ${ scssPath }...`); 
@@ -66,14 +103,13 @@ function compile(inputPath, options = {}) {
                     } catch (err) { console.error(`\nERROR: ${ err.message }\n`); return { error: err }; }
                 }).filter(data => !data.error ); // filter out failed compilations
         }
-    } else return console.error('First argument must be an existing file or directory.'
-        + `\n'${ inputPath }' does not exist.`);
+    }
 }
 
-// EXPORT functions if script was required
+// EXPORT main functions if script was required
 if (require.main !== module) module.exports = { compile, findSCSS };
 
-else { // run as CLI tool
+else { // run as CLI utility
 
     // Init UI colors
     const nc = '\x1b[0m',    // no color
@@ -82,46 +118,36 @@ else { // run as CLI tool
           bg = '\x1b[1;92m'; // bright green
 
     // Load FLAG settings
-    const config = { 
-        dryRun: process.argv.some(arg => /^--?(?:n|dry-?run)$/.test(arg)),
-        includeDotFolders: process.argv.some(arg =>
-            /^--?(?:dd?|(?:include-?)?dot-?(?:folder|dir(?:ector(?:y|ie))?)s?=?(?:true|1)?)$/.test(arg)),
-        noSourceMaps: process.argv.some(arg =>
-            /^--?(?:S|(?:exclude|disable|no)-?so?u?rce?-?maps?|so?u?rce?-?maps?=(?:false|0))$/.test(arg)),
-        noRecursion: process.argv.some(arg =>
-            /^--?(?:R|(?:disable|no)-?recursion|recursion=(?:false|0))$/.test(arg)),
-        noMinify: process.argv.some(arg =>
-            /^--?(?:M|(?:disable|no)-?minif(?:y|ication)|minif(?:y|ication)=(?:false|0))$/.test(arg)),
-        quietMode: process.argv.some(arg => /^--?q(?:uiet)?(?:-?mode)?$/.test(arg))
+    const config = {};
+    const argRegex = {
+        'dryRun': /^--?(?:n|dry-?run)$/,
+        'includeDotFolders': /^--?(?:dd?|(?:include-?)?dot-?(?:folder|dir(?:ector(?:y|ie))?)s?=?(?:true|1)?)$/,
+        'noSourceMaps': /^--?(?:S|(?:exclude|disable|no)-?so?u?rce?-?maps?|so?u?rce?-?maps?=(?:false|0))$/,
+        'noRecursion': /^--?(?:R|(?:disable|no)-?recursion|recursion=(?:false|0))$/,
+        'noMinify': /^--?(?:M|(?:disable|no)-?minif(?:y|ication)|minif(?:y|ication)=(?:false|0))$/,
+        'quietMode': /^--?q(?:uiet)?(?:-?mode)?$/,
+        'help': /^--?h(?:elp)?$/,
+        'version': /^--?ve?r?s?i?o?n?$/
     };
+    process.argv.forEach(arg => {
+        if (!arg.startsWith('-')) return;
+        const matchedFlag = Object.keys(argRegex).find(flag => argRegex[flag].test(arg));
+        if (matchedFlag) config[matchedFlag] = true;
+        else {
+            console.error(`\n${br}ERROR: Arg [${ arg }] not recognized.${nc}`);
+            console.info(`\n${by}Valid arguments are below.${nc}`);
+            printHelpSections(['configOptions', 'infoCmds']);
+            process.exit(1);
+    }});
 
     // Show HELP screen if -h or --help passed
-    if (process.argv.some(arg => /^--?h(?:elp)?$/.test(arg))) {
-        printHelp(`\n${by}scss-to-css [inputPath] [outputPath] [options]${nc}`);
-        printHelp('\nPath arguments:');
-        printHelp(' [inputPath]                  '
-            + 'Path to SCSS file or directory containing SCSS files to be compiled,'
-            + ' relative to the current working directory.');
-        printHelp(' [outputPath]                 '
-            + 'Path to file or directory where CSS + sourcemap files will be stored,'
-            + ' relative to original file location (if not provided, css/ is used).');
-        printHelp('\nConfig options:');
-        printHelp(' -n, --dry-run                Don\'t actually compile the file(s),'
-            + ' just show if they will be processed.');
-        printHelp(' -d, --include-dotfolders     Include dotfolders in file search.');
-        printHelp(' -S, --no-source-maps         Prevent source maps from being generated.');
-        printHelp(' -M, --no-minify              Disable minification of output CSS.');
-        printHelp(' -R, --no-recursion           Disable recursive file searching.');
-        printHelp(' -q, --quiet                  Suppress all logging except errors.');
-        printHelp('\nInfo commands:');
-        printHelp(' -h, --help                   Display this help screen.');
-        printHelp(' -v, --version                Show version number.');
+    if (process.argv.some(arg => argRegex.help.test(arg))) printHelpSections();
 
     // Show VERSION number if -v or --version passed
-    } else if (process.argv.some(arg => /^--?ve?r?s?i?o?n?$/.test(arg))) {
+    else if (process.argv.some(arg => argRegex.version.test(arg)))
         console.info('v' + require('./package.json').version);
 
-    } else { // run MAIN routine
+    else { // run MAIN routine
 
         // Init I/O args
         const [inputArg = '', outputArg = ''] = ( // default to empty strings for error-less handling
@@ -199,27 +225,61 @@ else { // run as CLI tool
 
     // Define LOGGING functions
 
-    function printHelp(msg) { // wrap msg + indent 2nd+ lines (for --help screen)
-        const terminalWidth = process.stdout.columns || 80,
-              indentation = 30, lines = [], words = msg.match(/\S+|\s+/g);
-
-        // Split msg into lines of appropriate lengths
-        let currentLine = '';
-        words.forEach(word => {
-            const lineLength = terminalWidth - ( lines.length === 0 ? 0 : indentation );
-            if (currentLine.length + word.length > lineLength) { // cap/store it
-                lines.push(lines.length === 0 ? currentLine : currentLine.trimStart());
-                currentLine = '';
-            }
-            currentLine += word;
-        });
-        lines.push(lines.length === 0 ? currentLine : currentLine.trimStart());
-
-        // Print formatted msg
-        lines.forEach((line, index) => console.info(
-            index === 0 ? line // print 1st line unindented
-                : ' '.repeat(indentation) + line // print subsequent lines indented
-        ));
+    function printHelpSections(includeSections = ['cmdFormat', 'pathArgs', 'configOptions', 'infoCmds']) {
+        const helpSections = {
+            'cmdFormat': [
+                `\n${by}scss-to-css [inputPath] [outputPath] [options]${nc}`
+            ],
+            'pathArgs': [
+                '\nPath arguments:',
+                ' [inputPath]                 '
+                    + 'Path to SCSS file or directory containing SCSS files to be compiled,'
+                    + ' relative to the current working directory.',
+                ' [outputPath]                '
+                    + 'Path to file or directory where CSS + sourcemap files will be stored,'
+                    + ' relative to original file location (if not provided, css/ is used).'
+            ],
+            'configOptions': [
+                '\nConfig options:',
+                ' -n, --dry-run                Don\'t actually compile the file(s),'
+                                            + ' just show if they will be processed.',
+                ' -d, --include-dotfolders     Include dotfolders in file search.',
+                ' -S, --no-source-maps         Prevent source maps from being generated.',
+                ' -M, --no-minify              Disable minification of output CSS.',
+                ' -R, --no-recursion           Disable recursive file searching.',
+                ' -q, --quiet                  Suppress all logging except errors.'
+            ],
+            'infoCmds': [
+                '\nInfo commands:',
+                ' -h, --help                   Display help screen.',
+                ' -v, --version                Show version number.'
+            ]
+        };
+        includeSections.forEach(section => { // print valid arg elems
+            helpSections[section]?.forEach(line => printHelpMsg(line)); });
+
+        function printHelpMsg(msg) { // wrap msg + indent 2nd+ lines (for --help screen)
+            const terminalWidth = process.stdout.columns || 80,
+                  indentation = 30, lines = [], words = msg.match(/\S+|\s+/g);
+
+            // Split msg into lines of appropriate lengths
+            let currentLine = '';
+            words.forEach(word => {
+                const lineLength = terminalWidth - ( lines.length === 0 ? 0 : indentation );
+                if (currentLine.length + word.length > lineLength) { // cap/store it
+                    lines.push(lines.length === 0 ? currentLine : currentLine.trimStart());
+                    currentLine = '';
+                }
+                currentLine += word;
+            });
+            lines.push(lines.length === 0 ? currentLine : currentLine.trimStart());
+
+            // Print formatted msg
+            lines.forEach((line, index) => console.info(
+                index === 0 ? line // print 1st line unindented
+                    : ' '.repeat(indentation) + line // print subsequent lines indented
+            ));
+        }
     }
 
     function printIfNotQuiet(msg) { if (!config.quietMode) console.info(msg); }