Merge pull request #37 from derTobsch/upgrade-clean-css

Upgrade clean css and add basic tests

Author: matthew-dean

.editorconfig

@@ -0,0 +1,16 @@
+# @see http://editorconfig.org/
+
+# the buck stops here
+root = true
+
+# all files
+[*]
+end_of_line = LF
+indent_style = space
+indent_size = 4
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.yml,*.yaml}]
+indent_size = 2

.github/workflows/build.yml

@@ -0,0 +1,21 @@
+name: build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: setup node 20
+        uses: actions/setup-node@v3
+        with:
+          node-version: "20"
+          cache: 'npm'
+      - run: npm ci
+      - run: npm test

README.md

@@ -6,25 +6,35 @@ Compresses the css output from less using [clean-css](https://github.com/jakubpa
 
 ## lessc usage
 
+First of all install less via
+
+```bash
+npm install -g less
 ```
+
+then install the `less-plugin-clean-css`
+
+```bash
 npm install -g less-plugin-clean-css
 ```
 
 and then on the command line,
 
-```
+```bash
 lessc file.less --clean-css="--s1 --advanced --compatibility=ie8"
 ```
 
-See [clean-css](https://github.com/jakubpawlowicz/clean-css/tree/v3.0.1#how-to-use-clean-css-programmatically) for the available command options - the only differences are `advanced` and `rebase` which we default to false, because it is not always entirely safe.
+See [clean-css](https://github.com/jakubpawlowicz/clean-css/tree/v3.0.1#how-to-use-clean-css-programmatically) for the
+available command options - the only differences are `advanced` and `rebase` which we default to false, because it is
+not always entirely safe.
 
 ## Programmatic usage
 
 ```js
 var LessPluginCleanCSS = require('less-plugin-clean-css'),
     cleanCSSPlugin = new LessPluginCleanCSS({advanced: true});
-less.render(lessString, { plugins: [cleanCSSPlugin] })
-  .then(
+less.render(lessString, {plugins: [cleanCSSPlugin]})
+    .then(
 ```
 
 ## Browser usage

lib/clean-css-processor.js

@@ -1,15 +1,15 @@
 "use strict";
 
-var CleanCSS = require("clean-css");
+const CleanCSS = require("clean-css");
 
-module.exports = function() {
+module.exports = function () {
     function CleanCSSProcessor(options) {
         this.options = options || {};
     }
 
     CleanCSSProcessor.prototype = {
         process: function (css, extra) {
-            var options = this.options,
+            let options = this.options,
                 sourceMap = extra.sourceMap,
                 sources,
                 sourcesContent;
@@ -18,7 +18,7 @@ module.exports = function() {
                 options.sourceMap = sourceMap.getExternalSourceMap();
                 if (options.sourceMap) {
                     options.sourceMap = options.sourceMap.toString();
-                    var sourceMapObj = JSON.parse(options.sourceMap);
+                    const sourceMapObj = JSON.parse(options.sourceMap);
                     if (sourceMapObj.sourcesContent) {
                         sourcesContent = sourceMapObj.sourcesContent;
                         sources = sourceMapObj.sources;
@@ -39,24 +39,24 @@ module.exports = function() {
                 options.advanced = false;
             }
 
-            var output = new CleanCSS(options).minify(css);
+            const output = new CleanCSS(options).minify(css);
 
             if (sourceMap) {
                 if (sourcesContent) {
-                    for (var source = 0; source < sources.length; source++) {
+                    for (let source = 0; source < sources.length; source++) {
                         output.sourceMap.setSourceContent(sources[source], sourcesContent[source]);
                     }
                 }
                 sourceMap.setExternalSourceMap(JSON.stringify(output.sourceMap));
             }
 
-            var css = output.styles;
+            let outputCSS = output.styles;
             if (sourceMap) {
-                var sourceMapURL = sourceMap.getSourceMapURL();
-                css += sourceMap.getCSSAppendage();
+                const sourceMapURL = sourceMap.getSourceMapURL();
+                outputCSS += sourceMap.getCSSAppendage();
             }
 
-            return css;
+            return outputCSS;
         }
     };
 

lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 
-var getCleanCSSProcessor = require("./clean-css-processor"),
+const getCleanCSSProcessor = require("./clean-css-processor"),
     usage = require("./usage"),
     parseOptions = require("./parse-options");
 
@@ -9,14 +9,14 @@ function LessPluginCleanCSS(options) {
 }
 
 LessPluginCleanCSS.prototype = {
-    install: function(less, pluginManager) {
-        var CleanCSSProcessor = getCleanCSSProcessor(less);
+    install: function (less, pluginManager) {
+        const CleanCSSProcessor = getCleanCSSProcessor(less);
         pluginManager.addPostProcessor(new CleanCSSProcessor(this.options));
     },
     printUsage: function () {
         usage.printUsage();
     },
-    setOptions: function(options) {
+    setOptions: function (options) {
         this.options = parseOptions(options);
     },
     minVersion: [2, 1, 0]

lib/parse-options.js

@@ -1,12 +1,12 @@
 "use strict";
 
-module.exports = function(options) {
+module.exports = function (options) {
     if (typeof options === "string") {
-        var cleanOptionArgs = options.split(" ");
+        const cleanOptionArgs = options.split(" ");
         options = {};
 
-        for (var i = 0; i < cleanOptionArgs.length; i++) {
-            var argSplit = cleanOptionArgs[i].split("="),
+        for (let i = 0; i < cleanOptionArgs.length; i++) {
+            const argSplit = cleanOptionArgs[i].split("="),
                 argName = argSplit[0].replace(/^-+/, "");
 
             switch (argName) {
@@ -21,7 +21,7 @@ module.exports = function(options) {
                     options.keepSpecialComments = 1;
                     break;
                 case "keepSpecialComments":
-                    var specialCommentOption = argSplit[1];
+                    let specialCommentOption = argSplit[1];
                     if (specialCommentOption !== "*") {
                         specialCommentOption = Number(specialCommentOption);
                     }

lib/usage.js

@@ -1,7 +1,7 @@
 "use strict";
 
 module.exports = {
-    printUsage: function() {
+    printUsage: function () {
         console.log("");
         console.log("Clean CSS Plugin");
         console.log("specify plugin with --clean-css");
@@ -13,7 +13,7 @@ module.exports = {
         this.printOptions();
         console.log("");
     },
-    printOptions: function() {
+    printOptions: function () {
         console.log("we support the following arguments... 'keep-line-breaks', 'b'");
         console.log("'s0', 's1', 'advanced', 'rebase', 'keepSpecialComments', compatibility', 'rounding-precision'");
         console.log("'skip-aggressive-merging', 'skip-shorthand-compacting'");