@adamlui/scss-to-css 1.2.0 → 1.3.0

package/README.md

@@ -3,7 +3,7 @@
 ### Recursively compile all SCSS files into minified CSS.
 
 <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"><img height=31 src="https://img.shields.io/badge/Latest_Build-1.2.0-fc7811.svg?logo=npm&logoColor=white&labelColor=464646&style=for-the-badge"></a>
+<a href="https://www.npmjs.com/package/@adamlui/scss-to-css"><img height=31 src="https://img.shields.io/badge/Latest_Build-1.3.0-fc7811.svg?logo=npm&logoColor=white&labelColor=464646&style=for-the-badge"></a>
 
 <img height=8px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/media/images/separators/aqua.png">
 
@@ -33,20 +33,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.
+**💡 Note:** Source maps are also generated by default. To disable, pass `--disable-source-maps`.
 
 #
 
-To specify **input/output** directories:
+To specify **input/output** paths:
    
 ```
 scss-to-css <input_path> <output_path>
 ```
 
-- `<input_path>`: Path to directory containing SCSS files to be compiled, relative to the current working directory. 
-- `<output_path>`: Path to directory where CSS/sourcemap files will be stored, relative to original file location. (If not provided, `css/` is used.)
+- `<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:** The paths can be either folders or specific files. If folders are passed, files will be processed recursively.
+**💡 Note:** If folders are passed, files will be processed recursively. To include dotfolders, pass `--include-dotfolders`.
 
 #
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adamlui/scss-to-css",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Recursively compile all SCSS files into minified CSS",
   "author": {
     "name": "Adam Lui",
@@ -38,6 +38,10 @@
     "url": "https://github.com/adamlui/js-utils/issues"
   },
   "dependencies": {
-    "sass": "^1.70.0"
+    "sass": "^1.71.0"
+  },
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/adamlui"
   }
 }

package/scss-to-css.js

@@ -11,18 +11,27 @@ const nc = '\x1b[0m', // no color
       by = '\x1b[1;33m', // bright yellow
       bg = '\x1b[1;92m'; // bright green
 
-// Clean leading slashes from args to avoid parsing system root
-const inputArg = process.argv[2] ? process.argv[2].replace(/^\/*/, '') : '',
-      outputArg = process.argv[3] ? process.argv[3].replace(/^\/*/, '') : '';
+// Init I/O args
+const [inputArg = '', outputArg = ''] = ( // default to empty strings for error-less handling
+    process.argv.slice(2) // exclude executable and script path
+        .filter(arg => !arg.startsWith('-')) // exclude flags
+        .map(arg => arg.replace(/^\/*/, '')) // clean leading slashes to avoid parsing system root
+);
 
 // Validate input arg (output arg can be anything)
-if (process.argv[2] && !fs.existsSync(inputArg)) {
-    console.error(`\n${br}Error: First arg must be an existing file or path.${nc}`
+if (inputArg && !fs.existsSync(inputArg)) {
+    console.error(`\n${br}Error: First arg must be an existing file or directory.${nc}`
         + '\nExample valid command: \n>> scss-to-css . output.min.css');
     process.exit(1);
 }
 
-// Recursively find all SCSS files or arg-passed file
+// Store flag settings
+const config = { 
+    includeDotFolders: process.argv.some(arg => /--?include-dot-?folders?/.test(arg)),
+    disableSourceMaps: process.argv.some(arg => /--?(exclude|disable)-source-?maps?/.test(arg))
+};
+
+// Recursively find all eligible SCSS files or arg-passed file
 const inputPath = path.resolve(process.cwd(), inputArg),
       scssFiles = [];
 if (inputArg.endsWith('.scss')) scssFiles.push(inputPath);
@@ -30,45 +39,48 @@ else (function findSCSSfiles(dir) {
     const files = fs.readdirSync(dir);
     files.forEach(file => {
         const filePath = path.resolve(dir, file);
-        if (fs.statSync(filePath).isDirectory())
-            findSCSSfiles(filePath); // recursively find SCSS
-        else if (/\.scss$/.test(file)) // SCSS file found
-            scssFiles.push(filePath); // store it for minification
+        if (fs.statSync(filePath).isDirectory() &&
+            (config.includeDotFolders || !file.startsWith('.')))
+                findSCSSfiles(filePath); // recursively find SCSS in eligible dir
+        else if (file.endsWith('.scss')) // SCSS file found
+            scssFiles.push(filePath); // store it for compilation
     });
 })(inputPath);
 
 // Compile SCSS files to CSS
-let generatedCnt = 0;
+let cssGenCnt = 0, srcMapGenCnt = 0;
 console.log(''); // line break before first log
 scssFiles.forEach(scssPath => {
+    console.info(`Compiling ${ scssPath }...`);
     try { // to compile it
         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)/
                 : outputArg.endsWith('.css') ? path.dirname(outputArg) // or path from file output arg
-                : outputArg || 'css' // or path from path output arg or css/ from no arg
+                : outputArg || 'css' // or path from folder output arg or css/ if no output arg passed
         );
         const outputFilename = (
             outputArg.endsWith('.css') && inputArg.endsWith('.scss')
                 ? path.basename(outputArg).replace(/(\.min)?\.css$/, '')
                 : path.basename(scssPath, '.scss')
         ) + '.min.css';
-        const outputPath = path.join(outputDir, outputFilename);
-        console.info(`Compiling ${ scssPath }...`);
-        const compileResult = sass.compile(scssPath, { style: 'compressed', sourceMap: true });
+        const outputPath = path.join(outputDir, outputFilename),
+              compileResult = sass.compile(scssPath, { style: 'compressed', sourceMap: !config.disableSourceMaps });
         if (!fs.existsSync(outputDir)) fs.mkdirSync(outputDir, { recursive: true });
-        fs.writeFileSync(outputPath, compileResult.css, 'utf8');
-        fs.writeFileSync(outputPath + '.map', JSON.stringify(compileResult.sourceMap), 'utf8');
-        generatedCnt+= 2;
+        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}`);
     }
 });
 
 // Print final summary
-if (generatedCnt) {
-    const isPlural = generatedCnt/2 > 1;
+if (cssGenCnt) {
     console.info(`\n${bg}Compilation complete!${nc}`);
-    console.info(`\n${ generatedCnt/2 } CSS file${ isPlural ? 's' : '' }`
-        + ` + ${ generatedCnt/2 } source map${ isPlural ? 's' : '' } generated.`);
-} else console.info(`\n${by}No SCSS files found.${nc}`);
+    console.info(`${ cssGenCnt } CSS file${ cssGenCnt > 1 ? 's' : '' }`
+        + ( srcMapGenCnt ? ` + ${ srcMapGenCnt } source map${ srcMapGenCnt > 1 ? 's' : '' }` : '' )
+        + ' generated.');
+} else console.info(`${by}No SCSS files found.${nc}`);