@adamlui/scss-to-css 1.6.0 → 1.7.0

package/README.md

@@ -6,17 +6,21 @@
         </picture>
         &nbsp;English |
         <a href="https://github.com/adamlui/js-utils/tree/main/scss-to-css/docs/zh-cn#readme">简体中文</a> |
-        <a href="https://github.com/adamlui/js-utils/tree/main/scss-to-css/docs/zh-tw#readme">繁體中文</a>
+        <a href="https://github.com/adamlui/js-utils/tree/main/scss-to-css/docs/zh-tw#readme">繁體中文</a> |
+        <a href="https://github.com/adamlui/js-utils/tree/main/scss-to-css/docs/hi#readme">हिंदी</a> |
+        <a href="https://github.com/adamlui/js-utils/tree/main/scss-to-css/docs/bn#readme">বাংলা</a> |
+        <a href="https://github.com/adamlui/js-utils/tree/main/scss-to-css/docs/mr#readme">मराठी</a> |
+        <a href="https://github.com/adamlui/js-utils/tree/main/scss-to-css/docs/pa#readme">ਪੰਜਾਬੀ</a>
     </h6>
 </div>
 
-# { } scss-to-css.js 
+# { } scss-to-css
 
 ### 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-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.6.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"><img height=31 src="https://img.shields.io/npm/dt/%40adamlui%2Fscss-to-css?logo=npm&color=af68ff&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-orange.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.7.0-44cc11.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>
 
@@ -27,28 +31,27 @@
 As a **global utility**:
 
 ```
-npm install -g @adamlui/scss-to-css
+$ npm install -g @adamlui/scss-to-css
 ```
 
-As a **dev dependency** (e.g. for build scripts):
+As a **dev dependency** (e.g. for build scripts), from your project root:
 
 ```
-npm install -D @adamlui/scss-to-css
+$ npm install -D @adamlui/scss-to-css
 ```
 
-
-As a **runtime dependency** (e.g. for on-the-fly compilation):
+As a **runtime dependency** (e.g. for on-the-fly compilation), from your project root:
 
 ```
-npm install @adamlui/scss-to-css
+$ npm install @adamlui/scss-to-css
 ```
 
-## 💻 Usage
+## 💻 Command line usage
 
 The basic **global command** is:
 
 ```
-scss-to-css
+$ scss-to-css
 ```
 
 Sample output:
@@ -62,7 +65,7 @@ Sample output:
 To specify **input/output** paths:
    
 ```
-scss-to-css [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.
@@ -88,25 +91,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
+$ scss-to-css
 ```
 
 Compile all SCSS files in a **specific directory** (outputs to `path/to/your/directory/css/`):
 
 ```
-scss-to-css path/to/your/directory
+$ scss-to-css 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
+$ scss-to-css path/to/your/file.scss
 ```
 
 Specify both **input and output** directories (outputs to `output_folder/`):
 
 ```
-scss-to-css input_folder output_folder
+$ scss-to-css input_folder output_folder
 ```
 
 **💡 Note:** Output CSS is minified unless `-M` or `--no-minify` is passed.
@@ -145,33 +148,35 @@ import * as scssToCSS from '@adamlui/scss-to-css';
 const scssToCSS = require('@adamlui/scss-to-css');
 ```
 
-### compile(inputPath, options)
+### `compile(inputPath[, options])`
 
-This function compiles SCSS found in the `inputPath` provided into CSS data.
+Compiles SCSS found in the `inputPath` provided into CSS data.
 
 If a **file path** is passed, the file's code is compiled to CSS, then an object containing `srcPath` + `code` + `error` is returned:
 
 ```js
 const compileResult = scssToCSS.compile('assets/style.scss');
-console.log(compileResult.error); // runtime error, or `undefined` if no error
-console.log(compileResult.code);  // compiled CSS output of assets/style.scss
+
+console.log(compileResult.error); // outputs runtime error, or `undefined` if no error
+console.log(compileResult.code);  // outputs compiled CSS from assets/style.scss
 ```
 
 If a **directory path** is passed, SCSS files are searched for (recursively by default), each one's code is loaded then compiled, then an array of objects containing `srcPath` + `code` + `error` is returned:
 
 ```js
+// Outputs paths to SCSS files in working directory + all nested directories
 const results = scssToCSS.compile('.');
-results.forEach(result =>
-    console.log(result.srcPath) // paths to SCSS files in working directory + all nested directories
-);
-console.log(results[1].code); // compiled CSS output of 2nd SCSS file if found, or `undefined` if not found
+results.forEach(result => console.log(result.srcPath));
+
+// Outputs compiled CSS from 2nd SCSS file if found, or `undefined` if not found
+console.log(results[1].code);
 ```
 
 Options are boolean, passed as object properties. For example:
 
 ```js
+// Returns array of data objects where `.code` contains unminified CSS
 scssToCSS.compile(inputDir, { minify: false });
-// returns data objects where `.code` contains unminified CSS
 ```
 
 Possible parameters (and their default settings) are:
@@ -185,15 +190,15 @@ Possible parameters (and their default settings) are:
  sourceMaps (true)    Generate CSS source maps.
 ```
 
-### findSCSS(searchDir, options)
+### `findSCSS(searchDir[, options])`
 
-This function searches for all SCSS files within the `searchDir` string passed (useful for discovering what files [`compile()`](#compileinputpath-options) will process) and returns an array containing their filepaths.
+Searches for all SCSS files within the `searchDir` string passed (useful for discovering what files [`compile()`](#compileinputpath-options) will process) and returns an array containing their filepaths.
 
 Options are boolean, passed as object properties. For example:
 
 ```js
+// Returns array containing filepaths to SCSS files in exactly `searchDir`
 scssToCSS.findSCSS(searchDir, { recursive: false });
-// returns array containing filepaths to SCSS files in exactly `searchDir`
 ```
 
 Possible parameters (and their default settings) are:
@@ -201,7 +206,7 @@ Possible parameters (and their default settings) are:
 ```
  recursive (true)     Recursively search for nested files if dir path
                       passed.
- verbose (false)      Show logging in console/terminal.
+ verbose (true)       Show logging in console/terminal.
  dotFolders (false)   Include dotfolders in file search.
 ```
 
@@ -209,12 +214,12 @@ Possible parameters (and their default settings) are:
 
 ## 💖 Support
 
-Please consider [giving a GitHub ⭐](https://github.com/adamlui/js-utils) if this helped you!
+Please consider [giving a GitHub ⭐](https://github.com/adamlui/js-utils) or [funding](https://github.com/sponsors/adamlui) this project if it helped you!
 <br><br>
 
 ## 🏛️ MIT License
 
-**Copyright © 2024 [Adam Lui](https://github.com/adamlui)**
+**Copyright © 2024 [Adam Lui](https://github.com/adamlui) & contributors**
 
 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:
 
@@ -228,4 +233,4 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 <a href="https://github.com/adamlui/js-utils">**Home**</a> /
 <a href="https://github.com/adamlui/js-utils/discussions">Discuss</a> /
-<a href="#--scss-to-cssjs">Back to top ↑</a>
+<a href="#--scss-to-css">Back to top ↑</a>

package/docs/LICENSE.md

@@ -6,13 +6,17 @@
         </picture>
         &nbsp;English |
         <a href="zh-cn/LICENSE.md">简体中文</a> |
-        <a href="zh-tw/LICENSE.md">繁體中文</a>
+        <a href="zh-tw/LICENSE.md">繁體中文</a> |
+        <a href="hi/LICENSE.md">हिंदी</a> |
+        <a href="bn/LICENSE.md">বাংলা</a> |
+        <a href="mr/LICENSE.md">मराठी</a> |
+        <a href="pa/LICENSE.md">ਪੰਜਾਬੀ</a>
     </h6>
 </div>
 
 # 🏛️ MIT License
 
-**Copyright © 2024 [Adam Lui](https://github.com/adamlui)**
+**Copyright © 2024 [Adam Lui](https://github.com/adamlui) & contributors**
 
 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:
 

package/docs/SECURITY.md

@@ -6,7 +6,11 @@
         </picture>
         &nbsp;English |
         <a href="zh-cn/SECURITY.md">简体中文</a> |
-        <a href="zh-tw/SECURITY.md">繁體中文</a>
+        <a href="zh-tw/SECURITY.md">繁體中文</a> |
+        <a href="hi/SECURITY.md">हिंदी</a> |
+        <a href="bn/SECURITY.md">বাংলা</a> |
+        <a href="mr/SECURITY.md">मराठी</a> |
+        <a href="pa/SECURITY.md">ਪੰਜਾਬੀ</a>
     </h6>
 </div>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adamlui/scss-to-css",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Recursively compile all SCSS files into minified CSS",
   "author": {
     "name": "Adam Lui",
@@ -29,17 +29,19 @@
   },
   "keywords": [
     "scss",
+    "compiler",
+    "minifier",
+    "cli",
+    "api",
     "sass",
     "css",
-    "stylesheets",
-    "compiler",
-    "minifier"
+    "stylesheets"
   ],
   "bugs": {
     "url": "https://github.com/adamlui/js-utils/issues"
   },
   "dependencies": {
-    "sass": "^1.71.1"
+    "sass": "^1.72.0"
   },
   "funding": {
     "type": "github",

package/scss-to-css.js

@@ -8,29 +8,45 @@ const fs = require('fs'),
 // Define MAIN functions
 
 function findSCSS(searchDir, options = {}) {
-    const defaultOptions = { recursive: true, verbose: false, dotFolders: false };
-    options = { ...defaultOptions, ...options };        
+
+    // Init options
+    const defaultOptions = { recursive: true, verbose: true, dotFolders: false };
+    options = { ...defaultOptions, ...options };
+
+    // Search for SCSS
     const dirFiles = fs.readdirSync(searchDir), scssFiles = [];
+    if (options.verbose && !options.isRecursing) console.info('\nSearching for SCSS files...');
     dirFiles.forEach(file => {
         const filePath = path.resolve(searchDir, file);
-        if (fs.statSync(filePath).isDirectory() && file != 'node_modules' &&
-            (options.dotFolders || !file.startsWith('.')) && options.recursive) {
-                if (options.verbose) console.info(`Searching for SCSS files in: ${filePath}...`);
+        if (fs.statSync(filePath).isDirectory() && file != 'node_modules'
+            && (options.dotFolders || !file.startsWith('.')) && options.recursive)
                 scssFiles.push( // recursively find SCSS in eligible dir
                     ...findSCSS(filePath, { ...options, isRecursing: true }));
-        } else if (file.endsWith('.scss')) // SCSS file found
+        else if (file.endsWith('.scss')) // SCSS file found
             scssFiles.push(filePath); // store it for compilation
     });
-    if (options.isRecursing || scssFiles.length > 0) return scssFiles;
-    else console.info('\nNo SCSS files found.');
+
+    // Log/return final result
+    if (!options.isRecursing && options.verbose) {
+        console.info('Search complete. '
+            + ( scssFiles.length === 0 ? 'No' : scssFiles.length )
+            + ` file${ scssFiles.length > 1 ? 's' : '' } found.`);
+    }
+    return options.isRecursing || scssFiles.length > 0 ? scssFiles : [];
 }
 
 function compile(inputPath, options = {}) {
+
+    // Init options
     const defaultOptions = { minify: true, sourceMaps: true, recursive: true, verbose: true, dotFolders: false };
     options = { ...defaultOptions, ...options };
+
+    // Validate inputPath
     if (typeof inputPath !== 'string')
         return console.error('ERROR:'
             + ' First argument must be a string representing a file/folder path.');
+
+    // Compile SCSS based on inputPath
     const compileOptions = { style: options.minify ? 'compressed' : 'expanded', sourceMap: options.sourceMaps };
     if (fs.existsSync(inputPath)) { // compile based on path arg
         if (inputPath.endsWith('.scss')) { // file path passed
@@ -40,8 +56,9 @@ function compile(inputPath, options = {}) {
                 return { code: compileResult.css, srcMap: compileResult.sourceMap, srcPath: inputPath };
             } catch (err) { console.error(`\nERROR: ${ err.message }\n`); return { error: err }; }
         } else { // dir path passed
-            return findSCSS(inputPath, { recursive: options.recursive, dotFolders: options.dotFolders })
-                ?.map(scssPath => { // compile found SCSS files
+            return findSCSS(inputPath, { recursive: options.recursive, verbosity: options.verbose,
+                                         dotFolders: options.dotFolders
+                })?.map(scssPath => { // compile found SCSS files
                     if (options.verbose) console.info(`Compiling ${ scssPath }...`); 
                     try { // to compile found file
                         const compileResult = sass.compile(scssPath, compileOptions);
@@ -59,7 +76,7 @@ if (require.main !== module) module.exports = { compile, findSCSS };
 else { // run as CLI tool
 
     // Init UI colors
-    const nc = '\x1b[0m', // no color
+    const nc = '\x1b[0m',    // no color
           br = '\x1b[1;91m', // bright red
           by = '\x1b[1;33m', // bright yellow
           bg = '\x1b[1;92m'; // bright green
@@ -68,14 +85,14 @@ else { // run as CLI tool
     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)),
+            /^--?(?:dd?|(?:include-?)?dot-?(?:folder|dir(?:ector(?:y|ie))?)s?=?(?:true|1)?)$/.test(arg)),
         noSourceMaps: process.argv.some(arg =>
-            /^--?(?:S|(?:exclude|disable|no)-?so?u?rce?-?maps?)$/.test(arg)),
+            /^--?(?:S|(?:exclude|disable|no)-?so?u?rce?-?maps?|so?u?rce?-?maps?=(?:false|0))$/.test(arg)),
         noRecursion: process.argv.some(arg =>
-            /^--?(?:R|(?:disable|no)-?recursion)$/.test(arg)),
+            /^--?(?:R|(?:disable|no)-?recursion|recursion=(?:false|0))$/.test(arg)),
         noMinify: process.argv.some(arg =>
-            /^--?(?:M|(?:disable|no)-?minif(?:y|ication))$/.test(arg)),
-        quietMode: process.argv.some(arg => /^--?q(?:uiet)?$/.test(arg))
+            /^--?(?:M|(?:disable|no)-?minif(?:y|ication)|minif(?:y|ication)=(?:false|0))$/.test(arg)),
+        quietMode: process.argv.some(arg => /^--?q(?:uiet)?(?:-?mode)?$/.test(arg))
     };
 
     // Show HELP screen if -h or --help passed
@@ -125,18 +142,19 @@ else { // run as CLI tool
 
         // Find all eligible JavaScript files or arg-passed file
         const scssFiles = inputArg.endsWith('.scss') ? [inputPath]
-            : findSCSS(inputPath, { recursive: !config.noRecursion });
+            : findSCSS(inputPath, { recursive: !config.noRecursion, verbose: !config.quietMode });
 
-        if (config.dryRun && scssFiles?.length > 0) { // print files to be processed
-            console.info(`\n${by}SCSS files to be compiled:${nc}`);
-            scssFiles?.forEach(file => console.info(file));
+        if (config.dryRun) { // -n or --dry-run passed
+            if (scssFiles.length > 0) { // print files to be processed
+                console.info(`\n${by}SCSS files to be compiled:${nc}`);
+                scssFiles.forEach(file => console.info(file));
+            } else console.info(`${by}\nNo SCSS files will be compiled.${nc}`);
 
         } else { // actually compile SCSS files
-            printIfNotQuiet(''); // line break before first log
 
             // Build array of compilation data
             const failedPaths = [];
-            const compileData = scssFiles?.map(scssPath => {
+            const compileData = scssFiles.map(scssPath => {
                 const compileResult = compile(scssPath, {
                     minify: !config.noMinify, sourceMaps: !config.noSourceMaps, verbose: !config.quietMode });
                 if (compileResult.error) failedPaths.push(scssPath);
@@ -169,7 +187,7 @@ else { // run as CLI tool
                 printIfNotQuiet(`${ compileData.length } CSS file${ cssCntSuffix }`
                     + ( !config.noSourceMaps ? ` + ${ compileData.length } source map${ cssCntSuffix }` : '' )
                     + ' generated.');
-            } else printIfNotQuiet(`${by}No SCSS files processed successfully.${nc}`);
+            } else printIfNotQuiet(`${by}No SCSS files processed.${nc}`);
             if (failedPaths.length > 0) {
                 printIfNotQuiet(`\n${br}`
                     + `${ failedPaths.length } file${ failedPaths.length > 1 ? 's' : '' }`

package/docs/zh-cn/LICENSE.md

@@ -1,21 +0,0 @@
-<div align="right">
-    <h6>
-        <picture>
-            <source type="image/svg+xml" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/earth-icon/white/icon32.svg">
-            <img height=14 src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/earth-icon/black/icon32.svg">
-        </picture>
-        &nbsp;简体中文 |
-        <a href="../LICENSE.md">English</a> |
-        <a href="../zh-tw/LICENSE.md">繁體中文</a> 
-    </h6>
-</div>
-
-# 🏛️ MIT 许可证
-
-**版权所有 © 2023–2024 [刘展鹏 (Adam Lui)](https://github.com/adamlui)**
-
-特此免费向任何获得副本的人授予许可本软件和相关文档文件（『软件』），处理在软件中不受限制，包括但不限于权利使用、复制、修改、合并、发布、分发、再许可和/或出售该软件的副本，并允许该软件是提供这样做，但须满足以下条件：
-
-上述版权声明和本许可声明应包含在所有软件的副本或重要部分。
-
-本软件『按原样』提供，不提供任何形式的明示或保证暗示的，包括但不限于适销性保证，适用于特定目的和非侵权。 在任何情况下都不得作者或版权持有人对任何索赔、损害或其他责任，无论是在合同、侵权或其他方面的行为中，由以下原因引起，出于或与软件或使用或其他交易有关软件。

package/docs/zh-cn/README.md

@@ -1,228 +0,0 @@
-<div align="right">
-    <h6>
-        <picture>
-            <source type="image/svg+xml" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/earth-icon/white/icon32.svg">
-            <img height=14 src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/earth-icon/black/icon32.svg">
-        </picture>
-        &nbsp;简体中文 |
-        <a href="../..#readme">English</a> |
-        <a href="../zh-tw#readme">繁體中文</a>
-    </h6>
-</div>
-
-# { } scss-to-css.js 
-
-### 将所有 SCSS 文件递归编译为缩小的 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?label=%E4%B8%8B%E8%BD%BD&logo=npm&logoColor=white&labelColor=464646&style=for-the-badge"></a>
-<a href="#%EF%B8%8F-mit-%E8%AE%B8%E5%8F%AF%E8%AF%81"><img height=31 src="https://img.shields.io/badge/许可证-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/最新版本-1.6.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=code"><img height=31 src="https://img.shields.io/npm/unpacked-size/%40adamlui%2Fscss-to-css?label=%E6%8B%86%E5%B0%81%E5%B0%BA%E5%AF%B8&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=%E6%BC%8F%E6%B4%9E&color=gold"></a>
-
-<img height=8px width="100%" src="https://github.com/adamlui/js-utils/blob/main/docs/images/aqua-separator.png">
-
-## ⚡ 如何安装
-
-作为**全局实用程序**：
-
-```
-npm install -g @adamlui/scss-to-css
-```
-
-作为**开发人员依赖**（例如，对于构建脚本）：
-
-```
-npm install -D @adamlui/scss-to-css
-```
-
-
-作为**运行时依赖**（例如，用于动态编译）：
-
-```
-npm install @adamlui/scss-to-css
-```
-
-## 💻 命令行使用
-
-基本的**全局命令**是：
-
-```
-scss-to-css
-```
-
-示例输出：
-
-<img src="https://github.com/adamlui/js-utils/blob/main/scss-to-css/media/images/sample-output.png">
-
-**💡 笔记：** 默认情况下也会生成源映射，除非传递 `-S` 或 `--no-source-maps`。
-
-#
-
-指定**输入/输出**路径：
-   
-```
-scss-to-css [input_path] [output_path]
-```
-
-- `[input_path]`: SCSS 文件或包含要编译的 SCSS 文件的目录的路径，相对于当前工作目录。
-- `[output_path]`: 将存储 CSS + 源映射文件的文件或目录的路径，相对于原始文件位置（如果未提供，则使用 `css/`）。
-
-**💡 注意：** 如果传递文件夹，文件将被递归处理，除非传递 `-R` 或 `--no-recursion`。
-
-#
-
-要用作 **包脚本**，请在项目的 `package.json` 中：
-
-```json
-  "scripts": {
-    "build:css": "<scss-to-css-cmd>"
-  },
-```
-
-将 `<scss-to-css-cmd>` 替换为 `scss-to-css` + 可选参数。 然后，可以使用 `npm run build:css` 来运行该命令。
-<br><br>
-
-### 命令示例
-
-编译 **当前目录** 中的所有 SCSS 文件（输出到 `css/`）：
-
-```
-scss-to-css
-```
-
-编译 **特定目录** 中的所有 SCSS 文件（输出到 `path/to/your/directory/css/`）：
-
-```
-scss-to-css path/to/your/directory
-```
-
-编译一个**特定文件**（输出到 `path/to/your/css/file.min.css`）：
-
-```
-scss-to-css path/to/your/file.scss
-```
-
-指定 **输入和输出** 目录（输出到 `output_folder/`）：
-
-```
-scss-to-css input_folder output_folder
-```
-
-**💡 注意：** 除非传递 `-M` 或 `--no-minify` ，否则输出 CSS 会被缩小。
-<br><br>
-
-### 命令行选项
-
-```
-配置选项：
- -n, --dry-run               实际上并不缩小文件，只是显示它们是否会被处理。
- -d, --include-dotfolders    在文件搜索中包括点文件夹。
- -S, --no-source-maps        防止生成源映射。
- -M, --no-minify             禁用输出 CSS 的缩小。
- -R, --no-recursion          禁用递归文件搜索。
- -q, --quiet                 禁止除错误之外的所有日志记录。
-
-信息命令：
- -h, --help                  显示帮助屏幕。
- -v, --version               显示版本号。
-```
-
-## 🔌 API 参考
-
-您还可以将 **scss-to-css** 导入您的应用程序以使用其 API 方法，无论是作为 ECMAScript 模块还是 CommonJS 模块。
-
-#### ESM:
-
-```js
-import * as scssToCSS from '@adamlui/scss-to-css';
-```
-
-#### CJS:
-
-```js
-const scssToCSS = require('@adamlui/scss-to-css');
-```
-
-### compile(inputPath, options)
-
-此函数将在 `inputPath` 中找到的 SCSS 编译为 CSS 数据。
-
-如果传递 **文件路径**，则文件的代码将编译为 CSS，然后返回一个包含 `srcPath` + `code` + `error` 的对象：
-
-```js
-const compileResult = scssToCSS.compile('assets/style.scss');
-console.log(compileResult.error); // 运行时错误，如果没有错误则为 `undefined`
-console.log(compileResult.code);  // 编译后的 assets/style.scss CSS 输出
-```
-
-如果传递 **目录路径**，则搜索 SCSS 文件（默认情况下递归），加载每个文件的代码并编译，然后返回包含 `srcPath` + `code` + `error` 的对象数组：
-
-```js
-const results = scssToCSS.compile('.');
-results.forEach(result =>
-    console.log(result.srcPath) // 工作目录 + 所有嵌套目录中 SCSS 文件的路径
-);
-console.log(results[1].code); // 如果找到，则编译第二个 SCSS 文件的 CSS 输出，如果未找到，则为 `undefined`
-```
-
-选项是布尔值，作为对象属性传递。 例如：
-
-```js
-scssToCSS.compile(inputDir, { minify: false });
-// 返回 `.code` 包含未缩小 CSS 的数据对象
-```
-
-可能的参数（及其默认设置）有：
-
-```
- recursive (true)     如果传递目录路径，则递归搜索嵌套文件。
- verbose (true)       在控制台/终端中显示日志记录。
- dotFolders (false)   在文件搜索中包括点文件夹。
- minify (true)        缩小输出 CSS。
- sourceMaps (true)    生成 CSS 源映射。
-```
-
-### findSCSS(searchDir, options)
-
-此函数搜索传递的 `searchDir` 字符串中的所有 SCSS 文件（对于发现 [`compile()`](#compileinputpath-options) 将处理哪些文件很有用）并返回包含其文件路径的数组。
-
-选项是布尔值，作为对象属性传递。 例如：
-
-```js
-scssToCSS.findSCSS(searchDir, { recursive: false });
-// 返回包含恰好位于 `searchDir` 中的 SCSS 文件的文件路径的数组
-```
-
-可能的参数（及其默认设置）有：
-
-```
- recursive (true)     如果传递目录路径，则递归搜索嵌套文件。
- verbose (false)      在控制台/终端中显示日志记录。
- dotFolders (false)   在文件搜索中包括点文件夹。
-```
-
-<br>
-
-## 💖 支持
-
-如果这对您有帮助，请考虑[给予 GitHub ⭐](https://github.com/adamlui/js-utils)！
-<br><br>
-
-## 🏛️ MIT 许可证
-
-**版权所有 © 2023–2024 [刘展鹏 (Adam Lui)](https://github.com/adamlui)**
-
-特此免费向任何获得副本的人授予许可本软件和相关文档文件（『软件』），处理在软件中不受限制，包括但不限于权利使用、复制、修改、合并、发布、分发、再许可和/或出售该软件的副本，并允许该软件是提供这样做，但须满足以下条件：
-
-上述版权声明和本许可声明应包含在所有软件的副本或重要部分。
-
-本软件『按原样』提供，不提供任何形式的明示或保证暗示的，包括但不限于适销性保证，适用于特定目的和非侵权。 在任何情况下都不得作者或版权持有人对任何索赔、损害或其他责任，无论是在合同、侵权或其他方面的行为中，由以下原因引起，出于或与软件或使用或其他交易有关软件。
-
-<br>
-
-<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png">
-
-<a href="https://github.com/adamlui/js-utils">**家**</a> /
-<a href="https://github.com/adamlui/js-utils/discussions">讨论</a> /
-<a href="#--scss-to-css">回到顶部 ↑</a>

package/docs/zh-cn/SECURITY.md

@@ -1,17 +0,0 @@
-<div align="right">
-    <h6>
-        <picture>
-            <source type="image/svg+xml" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/earth-icon/white/icon32.svg">
-            <img height=14 src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/earth-icon/black/icon32.svg">
-        </picture>
-        &nbsp;简体中文 |
-        <a href="../SECURITY.md">English</a> |
-        <a href="../zh-tw/SECURITY.md">繁體中文</a>
-    </h6>
-</div>
-
-# 🛡️ 安全政策
-
-如果您发现漏洞，请打开[安全公告草案](https://github.com/adamlui/js-utils/security/advisories/new)。
-
-也欢迎拉取请求，但出于安全原因，请发送电子邮件至 <adam@kudoai.com> 并等待回复后再公开。

package/docs/zh-tw/LICENSE.md

@@ -1,21 +0,0 @@
-<div align="right">
-    <h6>
-        <picture>
-            <source type="image/svg+xml" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/earth-icon/white/icon32.svg">
-            <img height=14 src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/earth-icon/black/icon32.svg">
-        </picture>
-        &nbsp;繁體中文 |
-        <a href="../LICENSE.md">English</a> |
-        <a href="../zh-cn/LICENSE.md">简体中文</a>
-    </h6>
-</div>
-
-# 🏛️ MIT 许可证
-
-**版權所有 © 2023–2024 [刘展鹏 (Adam Lui)](https://github.com/adamlui)**
-
-特此免費授予任何取得副本的人許可本軟體和相關文件文件（『軟體』），處理在軟體中不受限制，包括但不限於權利使用、複製、修改、合併、發布、分發、再授權和/或出售該軟體的副本，並允許該軟體是提供這樣做，但須滿足以下條件：
-
-上述版權聲明和本許可聲明應包含在所有軟體的副本或重要部分。
-
-本軟體『依現況』提供，不提供任何形式的明示或保證暗示的，包括但不限於適銷性保證，適用於特定目的和非侵權。 在任何情況下都不得作者或版權持有人對任何索賠、損害或其他責任，無論是在合約、侵權或其他方面的行為中，由以下原因引起，出於或與軟體或使用或其他交易有關軟體。

package/docs/zh-tw/README.md

@@ -1,227 +0,0 @@
-<div align="right">
-    <h6>
-        <picture>
-            <source type="image/svg+xml" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/earth-icon/white/icon32.svg">
-            <img height=14 src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/earth-icon/black/icon32.svg">
-        </picture>
-        &nbsp;繁體中文 |
-        <a href="../..#readme">English</a> |
-        <a href="../zh-cn#readme">简体中文</a>
-    </h6>
-</div>
-
-# { } scss-to-css.js 
-
-### 將所有 SCSS 檔案遞歸編譯為縮小的 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?label=%E4%B8%8B%E8%BC%89&logo=npm&logoColor=white&labelColor=464646&style=for-the-badge"></a>
-<a href="#%EF%B8%8F-mit-%E8%AE%B8%E5%8F%AF%E8%AF%81"><img height=31 src="https://img.shields.io/badge/許可證-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/最新版本-1.6.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=code"><img height=31 src="https://img.shields.io/npm/unpacked-size/%40adamlui%2Fscss-to-css?label=%E6%8B%86%E5%B0%81%E5%B0%BA%E5%AF%B8&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=%E6%BC%8F%E6%B4%9E&color=gold"></a>
-
-<img height=8px width="100%" src="https://github.com/adamlui/js-utils/blob/main/docs/images/aqua-separator.png">
-
-## ⚡ 如何安裝
-
-作為**全域實用程式**：
-
-```
-npm install -g @adamlui/scss-to-css
-```
-
-作為**開發人員依賴**（例如，對於建置腳本）：
-
-```
-npm install -D @adamlui/scss-to-css
-```
-
-作為**運行時依賴**（例如，用於動態編譯）：
-
-```
-npm install @adamlui/scss-to-css
-```
-
-## 💻 命令列使用
-
-基本的**全域命令**是：
-
-```
-scss-to-css
-```
-
-範例輸出：
-
-<img src="https://github.com/adamlui/js-utils/blob/main/scss-to-css/media/images/sample-output.png">
-
-**💡 筆記：** 預設也會產生來源映射，除非傳遞 `-S` 或 `--no-source-maps`。
-
-#
-
-指定**輸入/輸出**路徑：
-   
-```
-scss-to-css [input_path] [output_path]
-```
-
-- `[input_path]`: SCSS 檔案或包含要編譯的 SCSS 檔案的目錄的路徑，相對於目前工作目錄。
-- `[output_path]`: 將儲存 CSS + 來源對應檔案的檔案或目錄的路徑，相對於原始檔案位置（如果未提供，則使用 `css/`）。
-
-**💡 注意：** 如果傳遞資料夾，檔案將被遞歸處理，除非傳遞 `-R` 或 `--no-recursion`。
-
-#
-
-若要用作 **套件腳本**，請在專案的 `package.json` 中：
-
-```json
-  "scripts": {
-    "build:css": "<scss-to-css-cmd>"
-  },
-```
-
-將 `<scss-to-css-cmd>` 替換為 `scss-to-css` + 可選參數。 然後，可以使用 `npm run build:css` 來執行該指令。
-<br><br>
-
-### 命令範例
-
-編譯 **目前目錄** 中的所有 SCSS 檔案（輸出到 `css/`）：
-
-```
-scss-to-css
-```
-
-編譯 **特定目錄** 中的所有 SCSS 檔案（輸出到 `path/to/your/directory/css/`）：
-
-```
-scss-to-css path/to/your/directory
-```
-
-編譯一個**特定檔案**（輸出到 `path/to/your/css/file.min.css`）：
-
-```
-scss-to-css path/to/your/file.scss
-```
-
-指定 **輸入和輸出** 目錄（輸出到 `output_folder/`）：
-
-```
-scss-to-css input_folder output_folder
-```
-
-**💡 注意：** 除非傳遞 `-M` 或 `--no-minify` ，否則輸出 CSS 會被縮小。
-<br><br>
-
-### 命令列選項
-
-```
-配置選項：
- -n, --dry-run               實際上並不會縮小文件，只是顯示它們是否會被處理。
- -d, --include-dotfolders    在檔案搜尋中包含點資料夾。
- -S, --no-source-maps        防止產生來源映射。
- -M, --no-minify             禁用輸出 CSS 的縮小。
- -R, --no-recursion          停用遞歸檔案搜尋。
- -q, --quiet                 禁止錯誤以外的所有日誌記錄。
-
-訊息命令：
- -h, --help                  顯示幫助畫面。
- -v, --version               顯示版本號。
-```
-
-## 🔌 API 參考
-
-您也可以將 **scss-to-css** 匯入您的應用程式以使用其 API 方法，無論是作為 ECMAScript 模組還是 CommonJS 模組。
-
-#### ESM:
-
-```js
-import * as scssToCSS from '@adamlui/scss-to-css';
-```
-
-#### CJS:
-
-```js
-const scssToCSS = require('@adamlui/scss-to-css');
-```
-
-### compile(inputPath, options)
-
-此函數將在 `inputPath` 中找到的 SCSS 編譯為 CSS 資料。
-
-如果傳遞 **檔案路徑**，則檔案的程式碼將編譯為 CSS，然後傳回一個包含 `srcPath` + `code` + `error` 的物件：
-
-```js
-const compileResult = scssToCSS.compile('assets/style.scss');
-console.log(compileResult.error); // 執行階段錯誤，如果沒有錯誤則為 `undefined`
-console.log(compileResult.code);  // 編譯後的 assets/style.scss CSS 輸出
-```
-
-如果传递 **目录路径**，则搜索 SCSS 文件（默认情况下递归），加载每个文件的代码并编译，然后返回包含 `srcPath` + `code` + `error` 的对象数组：
-
-```js
-const results = scssToCSS.compile('.');
-results.forEach(result =>
-    console.log(result.srcPath) // 工作目錄 + 所有巢狀目錄中 SCSS 檔案的路徑
-);
-console.log(results[1].code);   // 如果找到，則編譯第二個 SCSS 檔案的 CSS 輸出，如果找不到，則為 `undefined`
-```
-
-選項是布林值，作為物件屬性傳遞。 例如：
-
-```js
-scssToCSS.compile(inputDir, { minify: false });
-// 傳回 `.code` 包含未縮小 CSS 的資料對象
-```
-
-可能的參數（及其預設設定）有：
-
-```
- recursive (true)     如果傳遞目錄路徑，則遞歸搜尋巢狀檔案。
- verbose (true)       在控制台/終端機中顯示日誌記錄。
- dotFolders (false)   在檔案搜尋中包含點資料夾。
- minify (true)        縮小輸出 CSS。
- sourceMaps (true)    產生 CSS 來源映射。
-```
-
-### findSCSS(searchDir, options)
-
-此函數搜尋傳遞的 `searchDir` 字串中的所有 SCSS 檔案（對於發現 [`compile()`](#compileinputpath-options) 將處理哪些檔案很有用）並傳回包含其檔案路徑的陣列。
-
-選項是布林值，作為物件屬性傳遞。 例如：
-
-```js
-scssToCSS.findSCSS(searchDir, { recursive: false });
-// 傳回包含恰好位於 `searchDir` 中的 SCSS 檔案的檔案路徑的陣列
-```
-
-可能的參數（及其預設設定）有：
-
-```
- recursive (true)     如果傳遞目錄路徑，則遞歸搜尋巢狀檔案。
- verbose (false)      在控制台/終端機中顯示日誌記錄。
- dotFolders (false)   在檔案搜尋中包含點資料夾。
-```
-
-<br>
-
-## 💖 支援
-
-如果這對您有幫助，請考慮[給予 GitHub ⭐](https://github.com/adamlui/js-utils)！
-<br><br>
-
-## 🏛️ MIT 许可证
-
-**版權所有 © 2023–2024 [刘展鹏 (Adam Lui)](https://github.com/adamlui)**
-
-特此免費授予任何取得副本的人許可本軟體和相關文件文件（『軟體』），處理在軟體中不受限制，包括但不限於權利使用、複製、修改、合併、發布、分發、再授權和/或出售該軟體的副本，並允許該軟體是提供這樣做，但須滿足以下條件：
-
-上述版權聲明和本許可聲明應包含在所有軟體的副本或重要部分。
-
-本軟體『依現況』提供，不提供任何形式的明示或保證暗示的，包括但不限於適銷性保證，適用於特定目的和非侵權。 在任何情況下都不得作者或版權持有人對任何索賠、損害或其他責任，無論是在合約、侵權或其他方面的行為中，由以下原因引起，出於或與軟體或使用或其他交易有關軟體。
-
-<br>
-
-<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png">
-
-<a href="https://github.com/adamlui/js-utils">**家**</a> /
-<a href="https://github.com/adamlui/js-utils/discussions">讨论</a> /
-<a href="#--scss-to-css">回到顶部 ↑</a>

package/docs/zh-tw/SECURITY.md

@@ -1,17 +0,0 @@
-<div align="right">
-    <h6>
-        <picture>
-            <source type="image/svg+xml" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/earth-icon/white/icon32.svg">
-            <img height=14 src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/earth-icon/black/icon32.svg">
-        </picture>
-        &nbsp;繁體中文 |
-        <a href="../SECURITY.md">English</a> |
-        <a href="../zh-cn/SECURITY.md">简体中文</a>
-    </h6>
-</div>
-
-# 🛡️ 安全策略
-
-如果您發現漏洞，請打開[安全公告草案](https://github.com/adamlui/js-utils/security/advisories/new)。
-
-也歡迎拉取請求，但出於安全原因，請發送電子郵件至 <adam@kudoai.com> 並等待回復後再公開。