Added option to prepend comment in built CSS to compile()

adamlui · May 5, 2024 · 94a4d9a · 94a4d9a
1 parent fc48e66
commit 94a4d9a
Show file tree

Hide file tree

Showing 17 changed files with 118 additions and 89 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -184,14 +184,15 @@ scssToCSS.compile(inputDir, { minify: false });
 
 Available parameters (and their default settings) are:
 
-Name          | Type    | Desciption                                              | Default value
---------------|---------|---------------------------------------------------------|---------------
-`recursive`   | Boolean | Recursively search for nested files if dir path passed. | `true`
-`verbose`     | Boolean | Show logging in console/terminal.                       | `true`
-`dotFolders`  | Boolean | Include dotfolders in file search.                      | `false`
-`minify`      | Boolean | Minify output CSS.                                      | `true`
-`sourceMaps`  | Boolean | Generate CSS source maps.                               | `true`
-`ignoreFiles` | Array   | Files (by name) to exclude from compilation.            | `[]`
+Name          | Type    | Desciption                                                       | Default value
+--------------|---------|------------------------------------------------------------------|---------------
+`recursive`   | Boolean | Recursively search for nested files if dir path passed.          | `true`
+`verbose`     | Boolean | Show logging in console/terminal.                                | `true`
+`dotFolders`  | Boolean | Include dotfolders in file search.                               | `false`
+`minify`      | Boolean | Minify output CSS.                                               | `true`
+`sourceMaps`  | Boolean | Generate CSS source maps.                                        | `true`
+`ignoreFiles` | Array   | Files (by name) to exclude from compilation.                     | `[]`
+`comment`     | String  | Comment to prepend to compiled CSS. Separate by line using '\n'. | `''`
 
 #
 

diff --git a/node.js/README.md b/node.js/README.md
@@ -212,14 +212,15 @@ scssToCSS.compile(inputDir, { minify: false });
 
 Available parameters (and their default settings) are:
 
-Name          | Type    | Desciption                                              | Default value
---------------|---------|---------------------------------------------------------|---------------
-`recursive`   | Boolean | Recursively search for nested files if dir path passed. | `true`
-`verbose`     | Boolean | Show logging in console/terminal.                       | `true`
-`dotFolders`  | Boolean | Include dotfolders in file search.                      | `false`
-`minify`      | Boolean | Minify output CSS.                                      | `true`
-`sourceMaps`  | Boolean | Generate CSS source maps.                               | `true`
-`ignoreFiles` | Array   | Files (by name) to exclude from compilation.            | `[]`
+Name          | Type    | Desciption                                                       | Default value
+--------------|---------|------------------------------------------------------------------|---------------
+`recursive`   | Boolean | Recursively search for nested files if dir path passed.          | `true`
+`verbose`     | Boolean | Show logging in console/terminal.                                | `true`
+`dotFolders`  | Boolean | Include dotfolders in file search.                               | `false`
+`minify`      | Boolean | Minify output CSS.                                               | `true`
+`sourceMaps`  | Boolean | Generate CSS source maps.                                        | `true`
+`ignoreFiles` | Array   | Files (by name) to exclude from compilation.                     | `[]`
+`comment`     | String  | Comment to prepend to compiled CSS. Separate by line using '\n'. | `''`
 
 #
 

diff --git a/node.js/docs/README.md b/node.js/docs/README.md
@@ -212,14 +212,15 @@ scssToCSS.compile(inputDir, { minify: false });
 
 Available parameters (and their default settings) are:
 
-Name          | Type    | Desciption                                              | Default value
---------------|---------|---------------------------------------------------------|---------------
-`recursive`   | Boolean | Recursively search for nested files if dir path passed. | `true`
-`verbose`     | Boolean | Show logging in console/terminal.                       | `true`
-`dotFolders`  | Boolean | Include dotfolders in file search.                      | `false`
-`minify`      | Boolean | Minify output CSS.                                      | `true`
-`sourceMaps`  | Boolean | Generate CSS source maps.                               | `true`
-`ignoreFiles` | Array   | Files (by name) to exclude from compilation.            | `[]`
+Name          | Type    | Desciption                                                       | Default value
+--------------|---------|------------------------------------------------------------------|---------------
+`recursive`   | Boolean | Recursively search for nested files if dir path passed.          | `true`
+`verbose`     | Boolean | Show logging in console/terminal.                                | `true`
+`dotFolders`  | Boolean | Include dotfolders in file search.                               | `false`
+`minify`      | Boolean | Minify output CSS.                                               | `true`
+`sourceMaps`  | Boolean | Generate CSS source maps.                                        | `true`
+`ignoreFiles` | Array   | Files (by name) to exclude from compilation.                     | `[]`
+`comment`     | String  | Comment to prepend to compiled CSS. Separate by line using '\n'. | `''`
 
 #
 

diff --git a/node.js/docs/bn/README.md b/node.js/docs/bn/README.md
@@ -208,14 +208,15 @@ scssToCSS.compile(inputDir, { minify: false });
 
 উপলব্ধ প্যারামিটার (এবং তাদের ডিফল্ট সেটিংস) হল:
 
-নাম           | টাইপ    | বর্ণনা                                                                     | ডিফল্ট মান
---------------|---------|--------------------------------------------------------------------------|------------
-`recursive`   | বুলিয়ান  | ডিরেক্টরি পাথ পাস হলে নেস্টেড ফাইলগুলির জন্য পুনরাবৃত্তিমূলকভাবে অনুসন্ধান করুন। | `true`
-`verbose`     | বুলিয়ান  | কনসোল/টার্মিনালে লগইন দেখান।                                              | `true`
-`dotFolders`  | বুলিয়ান  | ফাইল অনুসন্ধানে ডটফোল্ডার অন্তর্ভুক্ত করুন।                                    | `false`
-`minify`      | বুলিয়ান  | আউটপুট CSS ছোট করুন।                                                   | `true`
-`sourceMaps`  | বুলিয়ান  | CSS সোর্স ম্যাপ তৈরি করুন।                                                  | `true`
-`ignoreFiles` | অ্যারে   | ফাইল (নাম দ্বারা) সংকলন থেকে বাদ দিতে।                                     | `[]`
+নাম           | টাইপ    | বর্ণনা                                                                            | ডিফল্ট মান
+--------------|---------|---------------------------------------------------------------------------------|------------
+`recursive`   | বুলিয়ান  | ডিরেক্টরি পাথ পাস হলে নেস্টেড ফাইলগুলির জন্য পুনরাবৃত্তিমূলকভাবে অনুসন্ধান করুন।        | `true`
+`verbose`     | বুলিয়ান  | কনসোল/টার্মিনালে লগইন দেখান।                                                     | `true`
+`dotFolders`  | বুলিয়ান  | ফাইল অনুসন্ধানে ডটফোল্ডার অন্তর্ভুক্ত করুন।                                           | `false`
+`minify`      | বুলিয়ান  | আউটপুট CSS ছোট করুন।                                                          | `true`
+`sourceMaps`  | বুলিয়ান  | CSS সোর্স ম্যাপ তৈরি করুন।                                                         | `true`
+`ignoreFiles` | অ্যারে   | ফাইল (নাম দ্বারা) সংকলন থেকে বাদ দিতে।                                            | `[]`
+`comment`     | স্ট্রিং    | কম্পাইল করা CSS-এ প্রিপেন্ড করতে মন্তব্য করুন। '\n' ব্যবহার করে লাইন দ্বারা আলাদা করুন। | `''`
 
 #
 

diff --git a/node.js/docs/de/README.md b/node.js/docs/de/README.md
@@ -216,6 +216,7 @@ Name          | Typ             | Beschreibung
 `minify`      | Boolescher Wert | Ausgabe-CSS minimieren.                                                                | `true`
 `sourceMaps`  | Boolescher Wert | Generieren Sie CSS-Quellkarten.                                                        | `true`
 `ignoreFiles` | Array           | Dateien (nach Namen), die von der Kompilierung ausgeschlossen werden sollen.           | `[]`
+`comment`     | Zeichenfolge    | Kommentar, der dem kompilierten CSS vorangestellt wird. Mit „\n“ zeilenweise trennen.  | `''`
 
 #
 

diff --git a/node.js/docs/es/README.md b/node.js/docs/es/README.md
@@ -216,6 +216,7 @@ Nombre        | Tipo      | Descripción
 `minify`      | Booleano  | Minimizar CSS de salida.                                                   | `true`
 `sourceMaps`  | Booleano  | Generar mapas fuente CSS.                                                  | `true`
 `ignoreFiles` | Formación | Archivos (por nombre) para excluir de la compilación.                      | `[]`
+`comment`     | Cadena    | Comentario para anteponer al CSS compilado. Separe por línea usando '\n'.  | `''`
 
 #
 

diff --git a/node.js/docs/fr/README.md b/node.js/docs/fr/README.md
@@ -216,6 +216,7 @@ Nom           | Taper   | Description
 `minify`      | Booléen | Réduire la sortie CSS.                                                                   | `true`
 `sourceMaps`  | Booléen | Générer des cartes sources CSS.                                                          | `true`
 `ignoreFiles` | Tableau | Fichiers (par nom) à exclure de la compilation.                                          | `[]`
+`comment`     | Chaîne  | Commentaire à ajouter au CSS compilé. Séparez par ligne en utilisant '\n'.               | `''`
 
 #
 

diff --git a/node.js/docs/hi/README.md b/node.js/docs/hi/README.md
@@ -207,14 +207,15 @@ scssToCSS.compile(inputDir, { minify: false });
 
 उपलब्ध पैरामीटर (और उनकी डिफ़ॉल्ट सेटिंग्स) हैं:
 
-नाम           | प्रकार  | विवरण                                                           | डिफ़ॉल्ट मान
---------------|-------|-----------------------------------------------------------------|------------
-`recursive`   | बूलियन | यदि निर्देशिका पथ पारित हो गया है तो नेस्टेड फ़ाइलों को पुनरावर्ती रूप से खोजें। | `true`
-`verbose`     | बूलियन | कंसोल/टर्मिनल में लॉगिंग दिखाएँ।                                       | `true`
-`dotFolders`  | बूलियन | फ़ाइल खोज में डॉटफ़ोल्डर शामिल करें।                                  | `false`
-`minify`      | बूलियन | आउटपुट CSS को छोटा करें।                                          | `true`
-`sourceMaps`  | बूलियन | CSS स्रोत मानचित्र तैयार करें।                                          | `true`
-`ignoreFiles` | सरणी  | संकलन से बाहर करने के लिए फ़ाइलें (नाम से)।                           | `[]`
+नाम           | प्रकार  | विवरण                                                                      | डिफ़ॉल्ट मान
+--------------|-------|----------------------------------------------------------------------------|------------
+`recursive`   | बूलियन | यदि निर्देशिका पथ पारित हो गया है तो नेस्टेड फ़ाइलों को पुनरावर्ती रूप से खोजें।            | `true`
+`verbose`     | बूलियन | कंसोल/टर्मिनल में लॉगिंग दिखाएँ।                                                  | `true`
+`dotFolders`  | बूलियन | फ़ाइल खोज में डॉटफ़ोल्डर शामिल करें।                                             | `false`
+`minify`      | बूलियन | आउटपुट CSS को छोटा करें।                                                     | `true`
+`sourceMaps`  | बूलियन | CSS स्रोत मानचित्र तैयार करें।                                                     | `true`
+`ignoreFiles` | सरणी  | संकलन से बाहर करने के लिए फ़ाइलें (नाम से)।                                      | `[]`
+`comment`     | स्ट्रिंग   | संकलित सीएसएस को जोड़ने के लिए टिप्पणी करें। '\n' का उपयोग करके लाइन से अलग करें। | `''`
 
 #
 

diff --git a/node.js/docs/it/README.md b/node.js/docs/it/README.md
@@ -216,6 +216,7 @@ Nome          | Tipo     | Descrizione
 `minify`      | Booleano | Minimizza il CSS di output.                                                       | `true`
 `sourceMaps`  | Booleano | Genera mappe di origine CSS.                                                      | `true`
 `ignoreFiles` | Vettore  | File (per nome) da escludere dalla compilazione.                                  | `[]`
+`comment`     | Stringa  | Commento da anteporre al CSS compilato. Separare per riga utilizzando '\n'.       | `''`
 
 #
 

diff --git a/node.js/docs/ja/README.md b/node.js/docs/ja/README.md
@@ -208,14 +208,15 @@ scssToCSS.compile(inputDir, { minify: false });
 
 利用可能なパラメータ (およびそのデフォルト設定) は次のとおりです:
 
-名前          | タイプ    | 説明                                                                | デフォルト値
---------------|----------|---------------------------------------------------------------------|-------------
-`recursive`   | ブール値 | ディレクトリパスが渡された場合、ネストされたファイルを再帰的に検索します。 | `true`
-`verbose`     | ブール値 | コンソール/ターミナルにログを表示します。                               | `true`
-`dotFolders`  | ブール値 | ファイル検索にドットフォルダーを含めます。                              | `false`
-`minify`      | ブール値 | 出力 CSS を縮小します。                                               | `true`
-`sourceMaps`  | ブール値 | CSS ソースマップを生成します。                                         | `true`
-`ignoreFiles` | 配列     | コンパイルから除外するファイル (名前別)。                               | `[]`
+名前          | タイプ    | 説明                                                                      | デフォルト値
+--------------|----------|---------------------------------------------------------------------------|-------------
+`recursive`   | ブール値 | ディレクトリパスが渡された場合、ネストされたファイルを再帰的に検索します。       | `true`
+`verbose`     | ブール値 | コンソール/ターミナルにログを表示します。                                     | `true`
+`dotFolders`  | ブール値 | ファイル検索にドットフォルダーを含めます。                                    | `false`
+`minify`      | ブール値 | 出力 CSS を縮小します。                                                     | `true`
+`sourceMaps`  | ブール値 | CSS ソースマップを生成します。                                               | `true`
+`ignoreFiles` | 配列     | コンパイルから除外するファイル (名前別)。                                     | `[]`
+`comment`     | 文字列   | コンパイルされた CSS の先頭に追加するコメント。 「\n」を使用して行で区切ります。 | `''`
 
 #
 

diff --git a/node.js/docs/mr/README.md b/node.js/docs/mr/README.md
@@ -208,14 +208,15 @@ scssToCSS.compile(inputDir, { minify: false });
 
 उपलब्ध पॅरामीटर्स (आणि त्यांची डीफॉल्ट सेटिंग्ज) आहेत:
 
-नाव           | प्रकार  | वर्णन                                             | डीफॉल्ट मूल्य
---------------|-------|-------------------------------------------------|------------
-`recursive`   | बुलियन | डिरेक्टरी मार्ग पास झाल्यास नेस्टेड फाइल्ससाठी वारंवार शोधा. | `true`
-`verbose`     | बुलियन | कन्सोल/टर्मिनलमध्ये लॉग इन दाखवा.                    | `true`
-`dotFolders`  | बुलियन | फाइल शोधात डॉटफोल्डर समाविष्ट करा.                  | `false`
-`minify`      | बुलियन | आउटपुट CSS कमी करा.                             | `true`
-`sourceMaps`  | बुलियन | CSS स्त्रोत नकाशे व्युत्पन्न करा.                         | `true`
-`ignoreFiles` | रचना  | फाइल्स (नावानुसार) संकलनातून वगळण्यासाठी.             | `[]`
+नाव           | प्रकार  | वर्णन                                                              | डीफॉल्ट मूल्य
+--------------|-------|------------------------------------------------------------------|------------
+`recursive`   | बुलियन | डिरेक्टरी मार्ग पास झाल्यास नेस्टेड फाइल्ससाठी वारंवार शोधा.                  | `true`
+`verbose`     | बुलियन | कन्सोल/टर्मिनलमध्ये लॉग इन दाखवा.                                     | `true`
+`dotFolders`  | बुलियन | फाइल शोधात डॉटफोल्डर समाविष्ट करा.                                   | `false`
+`minify`      | बुलियन | आउटपुट CSS कमी करा.                                              | `true`
+`sourceMaps`  | बुलियन | CSS स्त्रोत नकाशे व्युत्पन्न करा.                                          | `true`
+`ignoreFiles` | रचना  | फाइल्स (नावानुसार) संकलनातून वगळण्यासाठी.                              | `[]`
+`comment`     | स्ट्रिंग  | संकलित CSS वर प्रीपेंड करण्यासाठी टिप्पणी. '\n' वापरून ओळीनुसार विभक्त करा. | `''`
 
 #