More tests, fixes, documentation and new version

lukeapage · lukeapage · commit 8519aadc88dc · 2015-07-24T08:13:06.000+01:00
diff --git a/README.md b/README.md
@@ -34,8 +34,74 @@ $ npm install -g less-plugin-rtl
 $ lessc --rtl file.less out.css
 ```
 
-and to run in LTR mode..
+Variables
+=========
+
+Three variables are injected `ltr` and `rtl` which will be set to true or false and `dir` which will be set to `rtl` or `ltr`.
+
+Property Reversing
+==================
+
+To be more in control of properties that get reversed, you can specify property directives
+ 
+```
+.test {
+    -ltr-padding: 0; // rule only appears in LTR
+    -rtl-margin: 3px; // rule only appears in RTL
+    -ltr-rtl-float: left; // rule does not get reversed in either direction if autoReverse is on
+    -rtl-ltr-float: left; // rule does not get reversed in either direction if autoReverse is on
+    -ltr-reverse-text-align: left; // rule gets reversed for LTR, so in this case RTL = left, LTR = right
+    -rtl-reverse-text-align: left; // rule gets reversed for RTL, so in this case RTL = right, LTR = left
+}
+```
+
+Note: The reverse rules only make sense if autoreverse is off.
+
+And this produces in RTL..
+```
+.test {
+    margin: 3px;
+    float: left;
+    float: left;
+    text-align: left;
+    text-align: right;
+}
+```
+
+and in LTR...
+```
+.test {
+    padding: 0;
+    float: left;
+    float: left;
+    text-align: right;
+    text-align: left;
+}
+```
+
+CLI Options
+===========
 
 ```bash
-$ lessc --rtl="dir=LTR" file.less out.css
-```
+$ lessc --rtl="dir=LTR auto-reverse=false vars=false" file.less out.css
+```
+
+auto-reverse
+------------
+
+Whether rules should be auto reversed or require property directives as above. Defaults to true.
+
+vars
+----
+
+Whether the variables should be available. Defaults to true.
+
+dir
+---
+
+The intended direction. Defaults to RTL.
+
+Programmatic Options
+====================
+
+As above, but use `dir`, `vars` and `autoReverse` on the options object.
diff --git a/lib/index.js b/lib/index.js
@@ -31,18 +31,18 @@ LessPluginRTL.prototype = {
             spaceSepOptions.forEach(function(arg) {
                 var match = arg.match(/^(--)?dir=(RTL|LTR)$/);
                 if (match) {
-                    options.dir = match[1];
+                    options.dir = match[2];
                     return;
                 }
                 match = arg.match(/^(--)?vars(=(true|false))?$/);
                 if (match) {
-                    options.vars = match[1] !== false;
+                    options.vars = match[2] !== "false";
                     return;
                 }
 
                 match = arg.match(/^(--)?auto-reverse(=(true|false))?$/);
                 if (match) {
-                    options.autoReverse = match[1] !== false;
+                    options.autoReverse = match[2] !== "false";
                     return;
                 }
 
@@ -52,7 +52,7 @@ LessPluginRTL.prototype = {
 
         options.autoReverse = options.autoReverse !== false;
         options.vars = options.vars !== false;
-        options.dir = options.dir || "LTR";
+        options.dir = options.dir || "RTL";
 
         if (options.dir !== "LTR" && options.dir !== "RTL") {
             throw new Error("Bad direction - use LTR or RTL");
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "less-plugin-rtl",
-    "version": "0.1.0",
+    "version": "1.0.0",
     "description": "ltr to rtl less plugin",
     "homepage": "http://lesscss.org",
     "author": {
diff --git a/test/css/properties-ltr/test.css b/test/css/properties-ltr/test.css
@@ -0,0 +1,27 @@
+.reverse {
+  float: right;
+  float: left;
+  float: left;
+  margin-right: 5px;
+  margin-left: 5px;
+  margin-left: 5px;
+  font-size: 12px;
+  /* unchanged*/
+  right: 3px;
+  left: 3px;
+  left: 3px;
+}
+.shorthands {
+  margin: 5px;
+  margin: 6px 7px;
+  margin: 1px 7px 3px;
+  margin: 1px 4px 3px 2px;
+  margin: 5px;
+  margin: 6px 7px;
+  margin: 1px 7px 3px;
+  margin: 1px 2px 3px 4px;
+  margin: 5px;
+  margin: 6px 7px;
+  margin: 1px 7px 3px;
+  margin: 1px 2px 3px 4px;
+}
diff --git a/test/css/properties-rtl/test.css b/test/css/properties-rtl/test.css
@@ -1,27 +1,27 @@
 .reverse {
-  float: right;
-  float: left;
   float: left;
-  margin-right: 5px;
-  margin-left: 5px;
+  float: right;
+  float: right;
   margin-left: 5px;
+  margin-right: 5px;
+  margin-right: 5px;
   font-size: 12px;
   /* unchanged*/
-  right: 3px;
-  left: 3px;
   left: 3px;
+  right: 3px;
+  right: 3px;
 }
 .shorthands {
   margin: 5px;
   margin: 6px 7px;
   margin: 1px 7px 3px;
-  margin: 1px 4px 3px 2px;
+  margin: 1px 2px 3px 4px;
   margin: 5px;
   margin: 6px 7px;
   margin: 1px 7px 3px;
-  margin: 1px 2px 3px 4px;
+  margin: 1px 4px 3px 2px;
   margin: 5px;
   margin: 6px 7px;
   margin: 1px 7px 3px;
-  margin: 1px 2px 3px 4px;
+  margin: 1px 4px 3px 2px;
 }
diff --git a/test/index.js b/test/index.js
@@ -5,6 +5,7 @@ var less = require("less"),
     rtlPlugin = new Plugin(),
     ltrPlugin = new Plugin("dir=LTR --auto-reverse vars=true"),
     propertiesRtlPlugin = new Plugin("dir=RTL --auto-reverse=false"),
+    propertiesLtrPlugin = new Plugin("dir=LTR --auto-reverse=false"),
     stylize = less.lesscHelper.stylize;
 
 console.log("\n" + stylize("LESS - RTL", 'underline') + "\n");
@@ -20,6 +21,9 @@ lessTester.runTestSet(
   {strictMath: true, relativeUrls: true, silent: true, plugins: [propertiesRtlPlugin] },
   "properties-rtl/");
 
+lessTester.runTestSet(
+  {strictMath: true, relativeUrls: true, silent: true, plugins: [propertiesLtrPlugin] },
+  "properties-ltr/");
 
 if (lessTester.finish) {
 	lessTester.finish();
diff --git a/test/less/properties-ltr/test.less b/test/less/properties-ltr/test.less
@@ -0,0 +1,47 @@
+.reverse {
+  -ltr-reverse-float: left;
+  -ltr-float: left;
+  -rtl-reverse-float: left;
+  -rtl-float: left;
+
+  -ltr-reverse-margin-left: 5px;
+  -ltr-margin-left: 5px;
+  -rtl-reverse-margin-left: 5px;
+  -rtl-margin-left: 5px;
+
+  font-size: 12px; /* unchanged*/
+
+  -ltr-reverse-left: 3px;
+  -ltr-left: 3px;
+  -rtl-reverse-left: 3px;
+  -rtl-left: 3px;
+}
+.shorthands {
+  @top: 1px;
+  @right: 2px;
+  @bottom: 3px;
+  @left: 4px;
+  @all: 5px;
+  @vertical: 6px;
+  @horizontal: 7px;
+
+  -ltr-reverse-margin: @all;
+  -ltr-reverse-margin: @vertical @horizontal;
+  -ltr-reverse-margin: @top @horizontal @bottom;
+  -ltr-reverse-margin: @top @right @bottom @left;
+
+  -ltr-margin: @all;
+  -ltr-margin: @vertical @horizontal;
+  -ltr-margin: @top @horizontal @bottom;
+  -ltr-margin: @top @right @bottom @left;
+
+  -rtl-reverse-margin: @all;
+  -rtl-reverse-margin: @vertical @horizontal;
+  -rtl-reverse-margin: @top @horizontal @bottom;
+  -rtl-reverse-margin: @top @right @bottom @left;
+
+  -rtl-margin: @all;
+  -rtl-margin: @vertical @horizontal;
+  -rtl-margin: @top @horizontal @bottom;
+  -rtl-margin: @top @right @bottom @left;
+}

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "less-plugin-rtl",`
`3`		`- "version": "0.1.0",`
	`3`	`+ "version": "1.0.0",`
`4`	`4`	`"description": "ltr to rtl less plugin",`
`5`	`5`	`"homepage": "http://lesscss.org",`
`6`	`6`	`"author": {`