@danielx/civet 0.4.9 → 0.4.10

package/README.md

@@ -91,20 +91,21 @@ Things Kept from CoffeeScript
 - `@` `this` shorthand `@` -> `this`, `@id` -> `this.id`
 - Prototype shorthand `X::` -> `X.prototype`, `X::a` -> `X.prototype.a`
 - Class static shorthand `@`
+- Chained comparisons `a < b < c` -> `a < b && b < c`
 - Postfix `if/unless`
 - Block Strings `"""` / `'''`
   - `#{exp}` interpolation in `"""` strings
+- `when` inside `switch` automatically breaks
 - Multiple `,` separated `case`/`when` expressions
 - `else` -> `default` in `switch`
 - Implicit returns
+- Simplified number method calls `1.toFixed()` -> `1..toFixed()`
 - JSX 😿
-- TODO
-  - [ ] Chained comparisons
 
 Things Removed from CoffeeScript
 ---
 
-- `on/yes/off/no` (use `true/false`)
+- `on/yes/off/no` (use `true/false`, `"civet coffeeCompat"`)
 - `isnt` (use `!==`)
 - `not` (use `!`)
 - `do` keyword (replaced with JS `do`, invoke using existing `(-> ...)()` syntax)
@@ -125,8 +126,8 @@ Things Removed from CoffeeScript
 Things Changed from CoffeeScript
 ---
 
-- `==` -> `==` rather than `===` (can be kept with `"use coffee-compat"`)
-- `!=` -> `!=` rather than `!==` (can be kept with `"use coffee-compat"`)
+- `==` -> `==` rather than `===` (can be kept with `"civet coffeeCompat"`)
+- `!=` -> `!=` rather than `!==` (can be kept with `"civet coffeeCompat"`)
 - `for in` and `for of` are no longer swapped and become their JS equivalents.
 - `a...` is now `...a` just like JS
 - `x?.y` now compiles to `x?.y` rather than the `if typeof x !== 'undefined' && x !== null` if check
@@ -134,7 +135,8 @@ Things Changed from CoffeeScript
 - Embedded JS `\`\`` has been replaced with JS template literals.
 - No longer allowing multiple postfix `if/unless` on the same line.
 - No `else` block on `unless` (negate condition and use `if`)
-- `#{}` interpolation in `""` strings only when `"use coffee-compat"`
+- `#{}` interpolation in `""` strings only when `"civet coffeeCompat"`
+- Expanded chained comparisons to work on more operators `a in b instanceof C` -> `a in b && b instanceof C`
 - Civet tries to keep the transpiled output verbatim as much as possible.
   In Coffee `(x)` -> `x;` but in Civet `(x)` -> `(x);`.
   Also in Coffee
@@ -202,6 +204,24 @@ Things Changed from ES6
   application without parens is also convenient.
 - Disallow comma operator in conditionals.
 - Comma operator in case/when becomes multiple conditions.
+- When exponent follows a dot it is treated as a property access since we simplified `1.toString()` -> `1..toString()` and an exponent
+could be a valid property `1.e10` -> `1..e10`. The workaround is to add a trailing zero `1.0e10` or remove the dot before the exponent `1e10`.
+
+CoffeeScript Compatibility
+---
+
+Civet provides a compatability prologue directive that aims to be 97+% compatible with existing CoffeeScript2 code (still a work in progress).
+
+```
+coffeeBooleans (yes/no/on/off)
+coffeeComment  (# single line comments)
+coffeeEq       (`==` -> `===`, `!=` -> `!==`)
+coffeeInterpolation (`"a string with {myVar}"`)
+```
+
+You can use these with `"civet coffeeCompat"` to opt in to all or use them bit by bit with `"civet coffeeComment coffeeEq coffeeInterpolation"`.
+Another posibility is to slowly remove them to provide a way to migrate files a little at a time `"civet coffeeCompat -coffeeBooleans -coffeeComment -coffeeEq"`.
+Both camel case and hyphens work when specifying options `"civet coffee-compat"`. More options will be added over time until 97+% compatibility is achieved.
 
 Using Civet in your Node.js Environment
 ---