@adamlui/scss-to-css 1.4.0 → 1.4.1

package/README.md

@@ -4,7 +4,8 @@
 
 <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.0-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,7 +28,7 @@ npm install -D @adamlui/scss-to-css
 The basic **global command** is:
 
 ```
-scss-to-css
+scsstocss
 ```
 
 Sample output:
@@ -41,7 +42,7 @@ Sample output:
 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. 
@@ -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.4.0",
+  "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,16 +11,16 @@ const nc = '\x1b[0m', // no color
       by = '\x1b[1;33m', // bright yellow
       bg = '\x1b[1;92m'; // bright green
 
-// Show help screen if -h or --help passed
+// Show HELP screen if -h or --help passed
 if (process.argv.some(arg => /^--?h(?:elp)?$/.test(arg))) {
 
     // Print help
-    console.info(`\n${by}scss-to-css [inputPath] [outputPath] [options]${nc}`);
+    console.info(`\n${by}scsstocss [inputPath] [outputPath] [options]${nc}`);
     console.info('\nPath arguments:');
-    printWrappedMsg(' [input_path]                '
+    printWrappedMsg(' [inputPath]                 '
         + 'Path to SCSS file or directory containing SCSS files to be compiled,'
         + ' relative to the current working directory.');
-    printWrappedMsg(' [output_path]               '
+    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:');
@@ -30,34 +30,11 @@ if (process.argv.some(arg => /^--?h(?:elp)?$/.test(arg))) {
     printWrappedMsg(' -h, --help                  Display this help screen.');
     printWrappedMsg(' -v, --version               Show version number.');
 
-    function printWrappedMsg(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 = '';
-            }
-            currentLine += word;
-        });
-        lines.push(lines.length === 0 ? currentLine : currentLine.trimStart());
-
-        // Print formatted msg
-        lines.forEach((line, index) => {
-            if (index === 0) console.info(line); // print 1st line unindented
-            else console.info(' '.repeat(indentation) + line); // print subsequent lines indented
-        });
-    }
-
-// Show version number if -v or --version passed
-} else if (process.argv.some(arg => /^--?v(?:er(?:s(?:ion)?)?)?$/.test(arg))) {
+// 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
+} else { // run MAIN routine
 
     // Init I/O args
     const [inputArg = '', outputArg = ''] = ( // default to empty strings for error-less handling
@@ -71,7 +48,7 @@ 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>> scss-to-css . output.min.css');
+            + '\n\nExample valid command: \n>> scsstocss . output.min.css');
         process.exit(1);
     }
 
@@ -136,3 +113,26 @@ if (process.argv.some(arg => /^--?h(?:elp)?$/.test(arg))) {
             + ' 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 = '';
+        }
+        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
+    ));
+}