@adamlui/scss-to-css 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,81 @@
+# { } scss-to-css.js 
+
+<a href="#%EF%B8%8F-mit-license"><img height=25 src="https://img.shields.io/badge/License-MIT-fcde7b.svg?logo=internetarchive&logoColor=white&labelColor=464646&style=for-the-badge"></a>
+
+Recursively compile all SCSS files into minified CSS.
+
+<img height=10px width="100%" src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/aqua.png">
+
+## ⚡ Installation
+
+- As a global utility:
+
+   ```
+   npm install -g @adamlui/scss-to-css
+   ```
+
+- As a dev dependency, from your project root:
+
+   ```
+   npm install -D @adamlui/scss-to-css
+   ```
+
+## 💻 Usage
+
+### Globally:
+
+Run the following command from a folder to recursively compile all SCSS:
+
+```
+scss-to-css
+```
+
+Sample output:
+
+![](https://raw.githubusercontent.com/adamlui/js-utils/main/scss-to-css/media/images/sample-output.png)
+
+### Dev dependency:
+
+1. Add build script to project's `package.json`:
+
+    ```json
+      "scripts": {
+        "build:css": "scss-to-css"
+      },
+    ```
+
+2. Run script from a folder to recursively compile all SCSS:
+
+    ```
+    npm run build:css
+    ```
+
+## 🏛️ 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:
+
+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.
+
+<br>
+
+<img height=6px width="100%" src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/aqua.png">
+
+<a href="https://github.com/adamlui">**Home**</a> /
+<a href="https://github.com/adamlui/js-utils/discussions">Discuss</a> /
+<a href="#--scss-to-cssjs">Back to top ↑</a>

package/docs/LICENSE.md

@@ -0,0 +1,21 @@
+# 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:
+
+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.

package/docs/SECURITY.md

@@ -0,0 +1,5 @@
+# 🛡️ Security Policy
+
+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.

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@adamlui/scss-to-css",
-  "version": "1.0.0",
-  "description": "Compile all SCSS files into CSS recursively",
-  "author": "Adam Lui",
-  "license": "MIT",
+  "version": "1.0.1",
+  "description": "Recursively compile all SCSS files into minified CSS",
+  "author": {
+    "name": "Adam Lui",
+    "email": "adam@kudoai.com",
+    "url": "https://github.com/adamlui"
+  },
   "homepage": "https://github.com/adamlui/js-utils",
+  "license": "MIT",
   "main": "scss-to-css.js",
   "bin": {
     "scss-to-css": "scss-to-css.js"

package/scss-to-css.js

@@ -48,7 +48,7 @@ const scssFiles = (() => {
 })();
 
 // Compile SCSS files to CSS
-if (scssFiles.length ===     0) console.info('\nNo SCSS files found.');
+if (scssFiles.length === 0) console.info('\nNo SCSS files found.');
 else {
     scssFiles.forEach(scssPath => {
         const inputDir = path.dirname(scssPath);
@@ -58,6 +58,6 @@ else {
         );
         console.info(`\nCompiling ${ scssPath } to ${ outputPath }...`);
         execSync(`sass --style compressed "${ scssPath }" "${ outputPath }"`);
-        console.info(`${bg}Compilation complete!`);
+        console.info(`${bg}Compilation complete!${nc}`);
     });
 }