@adamlui/scss-to-css 1.3.2 → 1.4.1

package/README.md

@@ -2,9 +2,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=46464&style=for-the-badge"></a>
+<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.3.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=versions"><img height=31 src="https://img.shields.io/badge/Latest_Build-1.4.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&labelColor=464646"></a>
 
 <img height=8px width="100%" src="https://github.com/adamlui/js-utils/blob/main/docs/images/aqua-separator.png">
 
@@ -27,27 +28,27 @@ npm install -D @adamlui/scss-to-css
 The basic **global command** is:
 
 ```
-scss-to-css
+scsstocss
 ```
 
 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 `--disable-source-maps` is passed.
+**💡 Note:** Source maps are also generated by default unless `-S` or `--disable-source-maps` is passed.
 
 #
 
 To specify **input/output** paths:
    
 ```
-scss-to-css <input_path> <output_path>
+scsstocss [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).
+- `[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 `--include-dotfolders`.
+**💡 Note:** If folders are passed, files will be processed recursively. To include dotfolders, pass `-dd` or `--include-dotfolders`.
 
 #
 
@@ -59,7 +60,7 @@ To use as a **package script**, edit your project's `package.json` like this:
   },
 ```
 
-Replace `<scss-to-css-cmd>` with `scss-to-css` + optional args. Then, `npm run build:css` can be used to run the command.
+Replace `<scss-to-css-cmd>` with `scsstocss` + optional args. Then, `npm run build:css` can be used to run the command.
 <br><br>
 
 ## 📃 Example commands:
@@ -67,25 +68,25 @@ Replace `<scss-to-css-cmd>` with `scss-to-css` + optional args. Then, `npm run b
 - Compile all SCSS files in the **current directory** (outputs to `css/`):
 
    ```
-   scss-to-css
+   scsstocss
    ```
 
 - Compile all SCSS files in a **specific directory** (outputs to `path/to/your/directory/css/`):
 
    ```
-   scss-to-css path/to/your/directory
+   scsstocss path/to/your/directory
    ```
 
 - Compile a **specific file** (outputs to `path/to/your/css/file.min.css`):
 
    ```
-   scss-to-css path/to/your/file.scss
+   scsstocss path/to/your/file.scss
    ```
 
 - Specify both **input and output** directories (outputs to `output_folder/`):
 
    ```
-   scss-to-css input_folder output_folder
+   scsstocss input_folder output_folder
    ```
 
 ## 🏛️ MIT License

package/docs/SECURITY.md

@@ -2,4 +2,4 @@
 
 If you find a vulnerability, please open a [draft security advisory](https://github.com/adamlui/js-utils/security/advisories/new).
 
-Pull requests are also welcome, but for safety reasons, send an email to adam@kudoai.com and wait for a response before making it public.
+Pull requests are also welcome, but for safety reasons, send an email to <adam@kudoai.com> and wait for a response before making it public.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adamlui/scss-to-css",
-  "version": "1.3.2",
+  "version": "1.4.1",
   "description": "Recursively compile all SCSS files into minified CSS",
   "author": {
     "name": "Adam Lui",
@@ -11,6 +11,7 @@
   "license": "MIT",
   "main": "scss-to-css.js",
   "bin": {
+    "scsstocss": "scss-to-css.js",
     "scss-to-css": "scss-to-css.js"
   },
   "scripts": {

package/scss-to-css.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-// Import libs
+// Import LIBS
 const fs = require('fs'),
       path = require('path'),
       sass = require('sass');
@@ -11,77 +11,128 @@ const nc = '\x1b[0m', // no color
       by = '\x1b[1;33m', // bright yellow
       bg = '\x1b[1;92m'; // bright green
 
-// Init I/O args
-const [inputArg = '', outputArg = ''] = ( // default to empty strings for error-less handling
-    process.argv.slice(2) // exclude executable and script paths
-        .filter(arg => !arg.startsWith('-')) // exclude flags
-        .map(arg => arg.replace(/^\/*/, '')) // clean leading slashes to avoid parsing system root
-);
+// Show HELP screen if -h or --help passed
+if (process.argv.some(arg => /^--?h(?:elp)?$/.test(arg))) {
 
-// Validate input arg (output arg can be anything)
-const inputPath = path.resolve(process.cwd(), inputArg);
-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>> scss-to-css . output.min.css');
-    process.exit(1);
-}
+    // Print help
+    console.info(`\n${by}scsstocss [inputPath] [outputPath] [options]${nc}`);
+    console.info('\nPath arguments:');
+    printWrappedMsg(' [inputPath]                 '
+        + 'Path to SCSS file or directory containing SCSS files to be compiled,'
+        + ' relative to the current working directory.');
+    printWrappedMsg(' [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(' -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.');
+
+// Show VERSION number if -v or --version passed
+} else if (process.argv.some(arg => /^--?ve?r?s?i?o?n?$/.test(arg))) {
+    console.info('v' + require('./package.json').version);
+
+} else { // run MAIN routine
+
+    // Init I/O args
+    const [inputArg = '', outputArg = ''] = ( // default to empty strings for error-less handling
+        process.argv.slice(2) // exclude executable and script paths
+            .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)
+    const inputPath = path.resolve(process.cwd(), inputArg);
+    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');
+        process.exit(1);
+    }
+
+    // Load flag settings
+    const config = { 
+        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))
+    };
 
-// 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 scssFiles = [];
+    if (inputArg.endsWith('.scss')) scssFiles.push(inputPath);
+    else (function findSCSSfiles(dir) {
+        const files = fs.readdirSync(dir);
+        files.forEach(file => {
+            const filePath = path.resolve(dir, file);
+            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);
 
-// Recursively find all eligible SCSS files or arg-passed file
-const scssFiles = [];
-if (inputArg.endsWith('.scss')) scssFiles.push(inputPath);
-else (function findSCSSfiles(dir) {
-    const files = fs.readdirSync(dir);
-    files.forEach(file => {
-        const filePath = path.resolve(dir, file);
-        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
+    // Compile SCSS files to CSS
+    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 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),
+                  compileResult = sass.compile(scssPath, { style: '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}`);
+        }
     });
-})(inputPath);
 
-// Compile SCSS files to CSS
-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 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),
-              compileResult = sass.compile(scssPath, { style: '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++;
+    // Print final summary
+    if (cssGenCnt) {
+        console.info(`\n${bg}Compilation complete!${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}`);
+}
+
+function printWrappedMsg(msg) { // truncates msg, indents 2nd+ lines
+    const terminalWidth = process.stdout.columns || 80,
+          indentation = 29, 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 = '';
         }
-    } catch (err) {
-        console.error(`${br}Error compiling ${ scssPath }: ${ err.message }${nc}`);
-    }
-});
+        currentLine += word;
+    });
+    lines.push(lines.length === 0 ? currentLine : currentLine.trimStart());
 
-// Print final summary
-if (cssGenCnt) {
-    console.info(`\n${bg}Compilation complete!${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}`);
+    // Print formatted msg
+    lines.forEach((line, index) => console.info(
+        index === 0 ? line // print 1st line unindented
+            : ' '.repeat(indentation) + line // print subsequent lines indented
+    ));
+}