@adamlui/scss-to-css 1.4.2 → 1.5.1

package/README.md

@@ -3,9 +3,10 @@
 ### Recursively compile all SCSS files into minified CSS.
 
 <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&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-fcde7b.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.4.2-fc7811.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&labelColor=464646"></a>
+<a href="#%EF%B8%8F-mit-license"><img height=31 src="https://img.shields.io/badge/License-MIT-red.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.5.1-fc7811.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">
 
@@ -28,7 +29,7 @@ npm install -D @adamlui/scss-to-css
 The basic **global command** is:
 
 ```
-scsstocss
+scss-to-css
 ```
 
 **💡 Note:** Pass `-n` or `--dry-run` to only see what files will be processed.
@@ -37,20 +38,20 @@ Sample output:
 
 <img src="https://github.com/adamlui/js-utils/blob/main/scss-to-css/media/images/sample-output.png">
 
-**💡 Note:** Source maps are also generated by default unless `-S` or `--disable-source-maps` is passed. To only see what files will be processed, pass `-n` or `--dry-run`.
+**💡 Note:** Source maps are also generated by default unless `-S` or `--disable-source-maps` is passed.
 
 #
 
 To specify **input/output** paths:
    
 ```
-scsstocss [input_path] [output_path]
+scss-to-css [input_path] [output_path]
 ```
 
 - `[input_path]`: Path to SCSS file or directory containing SCSS files to be compiled, relative to the current working directory. 
 - `[output_path]`: Path to file or directory where CSS + sourcemap files will be stored, relative to original file location (if not provided, `css/` is used).
 
-**💡 Note:** If folders are passed, files will be processed recursively. To include dotfolders, pass `-dd` or `--include-dotfolders`.
+**💡 Note:** If folders are passed, files will be processed recursively. To include dotfolders, pass `-d` or `--include-dotfolders`.
 
 #
 
@@ -62,7 +63,7 @@ To use as a **package script**, in your project's `package.json`:
   },
 ```
 
-Replace `<scss-to-css-cmd>` with `scsstocss` + optional args. Then, `npm run build:css` can be used to run the command.
+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:
@@ -70,27 +71,35 @@ Replace `<scss-to-css-cmd>` with `scsstocss` + optional args. Then, `npm run bui
 - Compile all SCSS files in the **current directory** (outputs to `css/`):
 
    ```
-   scsstocss
+   scss-to-css
    ```
 
 - Compile all SCSS files in a **specific directory** (outputs to `path/to/your/directory/css/`):
 
    ```
-   scsstocss path/to/your/directory
+   scss-to-css path/to/your/directory
    ```
 
 - Compile a **specific file** (outputs to `path/to/your/css/file.min.css`):
 
    ```
-   scsstocss path/to/your/file.scss
+   scss-to-css path/to/your/file.scss
    ```
 
 - Specify both **input and output** directories (outputs to `output_folder/`):
 
    ```
-   scsstocss input_folder output_folder
+   scss-to-css input_folder output_folder
    ```
 
+**💡 Note:** Output CSS is minified unless `-M` or `--no-minify` is passed.
+<br><br>
+
+## 💖 Support
+
+Please consider [giving a GitHub ⭐](https://github.com/adamlui/js-utils) if this helped you!
+<br><br>
+
 ## 🏛️ MIT License
 
 **Copyright (c) 2024 [Adam Lui](https://github.com/adamlui)**

package/docs/LICENSE.md

@@ -1,21 +1,9 @@
-# MIT License
+# 🏛️ MIT License
 
 **Copyright (c) 2024 [Adam Lui](https://github.com/adamlui)**
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

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

package/scss-to-css.js

@@ -11,26 +11,39 @@ const nc = '\x1b[0m', // no color
       by = '\x1b[1;33m', // bright yellow
       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?)$/.test(arg)),
+    disableSourceMaps: process.argv.some(arg =>
+        /^--?(?:S|(?:exclude|disable|no)-?so?u?rce?-?maps?)$/.test(arg)),
+    noMinify: process.argv.some(arg =>
+        /^--?(?:M|(?:disable|no)-?minif(?:y|ication))$/.test(arg)),
+    quietMode: process.argv.some(arg => /^--?q(?:uiet)?$/.test(arg))
+};
+
 // Show HELP screen if -h or --help passed
 if (process.argv.some(arg => /^--?h(?:elp)?$/.test(arg))) {
 
-    // Print help
-    console.info(`\n${by}scsstocss [inputPath] [outputPath] [options]${nc}`);
-    console.info('\nPath arguments:');
-    printWrappedMsg(' [inputPath]                  '
+    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.');
-    printWrappedMsg(' [outputPath]                 '
+    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).');
-    console.info('\nConfig options:');
-    printWrappedMsg('  -n, --dry-run               Don\'t actually compile the file(s),'
+    printHelp('\nConfig options:');
+    printHelp(' -n, --dry-run                Don\'t actually compile the file(s),'
         + ' just show if they will be processed.');
-    printWrappedMsg(' -dd, --include-dotfolders    Include dotfolders in file search.');
-    printWrappedMsg('  -S, --disable-source-maps   Prevent source maps from being generated.');
-    console.info('\nInfo commands:');
-    printWrappedMsg('  -h, --help                  Display this help screen.');
-    printWrappedMsg('  -v, --version               Show version number.');
+    printHelp(' -d, --include-dotfolders     Include dotfolders in file search.');
+    printHelp(' -S, --disable-source-maps    Prevent source maps from being generated.');
+    printHelp(' -M, --no-minify              Disable minification of output CSS.');
+    printHelp(' -q, --quiet                  Suppress all logging except errors.');
+    printHelp('\nInfo commands:');
+    printHelp(' -h, --help                   Display this help screen.');
+    printHelp(' -v, --version                Show version number.');
 
 // Show VERSION number if -v or --version passed
 } else if (process.argv.some(arg => /^--?ve?r?s?i?o?n?$/.test(arg))) {
@@ -50,19 +63,11 @@ if (process.argv.some(arg => /^--?h(?:elp)?$/.test(arg))) {
     if (inputArg && !fs.existsSync(inputPath)) {
         console.error(`\n${br}Error: First arg must be an existing file or directory.`
             + `\n${ inputPath } does not exist.${nc}`
-            + '\n\nExample valid command: \n>> scsstocss . output.min.css');
+            + `\n\n${bg}Example valid command: \n>> scss-to-css . output.min.css${nc}`
+            + `\n\n${by}For all command options: \n>> scss-to-css --help${nc}`);
         process.exit(1);
     }
 
-    // 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?)$/.test(arg)),
-        disableSourceMaps: process.argv.some(arg =>
-            /^--?(?:S|(?:exclude|disable)-so?u?rce?-?maps?)$/.test(arg))
-    };
-
     // Recursively find all eligible SCSS files or arg-passed file
     const scssFiles = [];
     if (inputArg.endsWith('.scss')) scssFiles.push(inputPath);
@@ -78,18 +83,20 @@ if (process.argv.some(arg => /^--?h(?:elp)?$/.test(arg))) {
         });
     })(inputPath);
 
-    if (config.dryRun) { // print files to be processed
-        console.info('\nSCSS files to be compiled:');
+    if (scssFiles.length === 0) { // print nothing found
+        printIfNotQuiet(`\n${by}No SCSS files found.${nc}`);
+
+    } else if (config.dryRun) { // print files to be processed
+        console.info(`\n${by}SCSS files to be compiled:${nc}`);
         scssFiles.forEach(file => console.info(file));
 
     } else { // actually compile SCSS files
 
-        // Compile SCSS files to CSS
         let cssGenCnt = 0, srcMapGenCnt = 0;
-        console.log(''); // line break before first log
+        printIfNotQuiet(''); // line break before first log
         scssFiles.forEach(scssPath => {
-            console.info(`Compiling ${ scssPath }...`);
-            try { // to compile it
+            printIfNotQuiet(`Compiling ${ scssPath }...`);
+            try { // to compile SCSS file
                 const outputDir = path.join(
                     path.dirname(scssPath), // path of file to be minified
                     /(?:src|s[ac]ss)$/.test(path.dirname(scssPath)) ? '../css' // + ../css/ if in *(src|sass|scss)/
@@ -102,29 +109,31 @@ if (process.argv.some(arg => /^--?h(?:elp)?$/.test(arg))) {
                         : path.basename(scssPath, '.scss')
                 ) + '.min.css';
                 const outputPath = path.join(outputDir, outputFilename),
-                      compileResult = sass.compile(scssPath, { style: 'compressed', sourceMap: !config.disableSourceMaps });
+                      compileResult = sass.compile(scssPath, {
+                          style: config.noMinify ? 'expanded' : 'compressed',
+                          sourceMap: !config.disableSourceMaps });
                 if (!fs.existsSync(outputDir)) fs.mkdirSync(outputDir, { recursive: true });
                 fs.writeFileSync(outputPath, compileResult.css, 'utf8'); cssGenCnt++;
                 if (!config.disableSourceMaps) {
                     fs.writeFileSync(outputPath + '.map', JSON.stringify(compileResult.sourceMap), 'utf8');
                     srcMapGenCnt++;
                 }
-            } catch (err) {
-                console.error(`${br}Error compiling ${ scssPath }: ${ err.message }${nc}`);
-            }
+            } catch (err) { console.error(`${br}Error compiling ${ scssPath }: ${ err.message }${nc}`); }
         });
 
         // Print final summary
         if (cssGenCnt) {
-            console.info(`\n${bg}Compilation complete!${nc}`);
-            console.info(`${ cssGenCnt } CSS file${ cssGenCnt > 1 ? 's' : '' }`
+            printIfNotQuiet(`\n${bg}Compilation complete!${nc}`);
+            printIfNotQuiet(`${ cssGenCnt } CSS file${ cssGenCnt > 1 ? 's' : '' }`
                 + ( srcMapGenCnt ? ` + ${ srcMapGenCnt } source map${ srcMapGenCnt > 1 ? 's' : '' }` : '' )
                 + ' generated.');
-        } else console.info(`${by}No SCSS files found.${nc}`);
+        } else printIfNotQuiet(`${by}No SCSS files processed successfully.${nc}`);
     }
 }
 
-function printWrappedMsg(msg) { // truncates msg, indents 2nd+ lines
+// 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);
 
@@ -146,3 +155,5 @@ function printWrappedMsg(msg) { // truncates msg, indents 2nd+ lines
             : ' '.repeat(indentation) + line // print subsequent lines indented
     ));
 }
+
+function printIfNotQuiet(msg) { if (!config.quietMode) console.info(msg); }