@danielx/civet 0.4.19-pre.9 → 0.4.21

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Daniel X Moore and other 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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -53,6 +53,8 @@ Things Kept from CoffeeScript
 - `is` -> `===`
 - `or` -> `||`
 - `and` -> `&&`
+- `or=` -> `||=`
+- `and=` -> `&&=`
 - `loop` -> `while(true)`
 - `unless exp` -> `if(!exp)`
 - `until condition` -> `while(!condition)`
@@ -88,6 +90,11 @@ Things Kept from CoffeeScript
 - Simplified number method calls `1.toFixed()` -> `1..toFixed()`
 - `if`/`switch`/`for`/`loop`/`while`/`throw` expressions
 - Destructuring object assignment doesn't require being wrapped in parens at the statement level `{a, b} = c` -> `({a, b} = c)`
+- Prefix or postfix rest/splats `[...a]`, `x = [a...]`
+- RestProperty in any position `{a, ...b, c} = d` -> `{a, c, ...b} = d`
+- RestElement/RestParameter in any position `(first, ...midle, last) ->` -> `function(first, ...middle) { let [last] = middle.splice(-1)}`
+- `///` Heregexp
+  - With some [changes](#things-changed-from-coffeescript).
 - JSX 😿
 
 Things Removed from CoffeeScript
@@ -108,7 +115,6 @@ Civet.
 - `for from` (use JS `for of`, `"civet coffeeCompat"`, or `"civet coffeeForLoops"`)
 - `for own of` (use JS `for in` and check manually, switch to `Map#keys/values/entries`, or use `Object.create(null)`, or `"civet coffeeCompat"`, or `"civet coffeeForLoops"`)
 - `for ... when <condition>` (use `continue if exp` inside loop, `"civet coffeeCompat"`, or `"civet coffeeForLoops"`)
-- `and=`, `or=` (don't mix and match words and symbols)
 - `a ? b` (use `a ?? b`, though it doesn't check for undeclared variables, `"civet coffeeCompat"`, or `"civet coffeeBinaryExistential"` enables this at the cost of losing JS ternary operator)
 - `a of b` (use `a in b` matching JS, or `"civet coffeeCompat"`, or `"civet coffeeOf"`)
 - Iteration expression results
@@ -117,7 +123,6 @@ Civet.
   - Optional assignment `x?.y = 3` -> `x != null ? x.y = 3 : undefined`
   - Conditional assignment `a?[x] = 3` -> `a ? a[x] = 3 : undefined`
 - Might add later
-  - `///` Heregexp
   - Rest parameter in any assignment position
   - Multiple slice assignment `otherNumbers[0...] = numbers[3..6] = [-3, -4, -5, -6]`
 
@@ -127,7 +132,6 @@ Things Changed from CoffeeScript
 - `==` -> `==` rather than `===` (can be kept with `"civet coffeeCompat"` or `"civet coffeeEq"`)
 - `!=` -> `!=` rather than `!==` (can be kept with `"civet coffeeCompat"` or `"civet coffeeEq"`)
 - `for in` and `for of` are no longer swapped and become their JS equivalents.
-- `a...` is now `...a` just like JS
 - `a in b` is now `a in b` rather than `b.indexOf(a) >= 0`
 - `x?.y` now compiles to `x?.y` rather than the `if typeof x !== 'undefined' && x !== null` if check
 - Existential `x?` -> `(x != null)` no longer checks for undeclared variables.
@@ -150,6 +154,15 @@ Things Changed from CoffeeScript
     x    +    3
   ```
   remains as is.
+- Heregex
+  - Allows both kinds of substitutions `#{..}`, `${..}`.
+  - Also allows both kinds of single line comments `//`, `#`.
+  - Keeps non-newline whitespace inside of character classes.
+  - Doesn't require escaping `#` after space inside of character classes.
+  - `#` is always the start of a comment outside of character classes regardless of leading space (CoffeeScript treats
+  `\s+#` as comment starts inside and outside of character classes).
+  - Might later add a compat flag to get more CoffeeScript compatibility.
+  - Might also later add a compat flag to only use ES interpolations and comments inside Heregexes.
 
 Things Added that CoffeeScript didn't
 ---
@@ -228,21 +241,22 @@ CoffeeScript Compatibility
 
 Civet provides a compatability prologue directive that aims to be 97+% compatible with existing CoffeeScript2 code (still a work in progress).
 
-```
-autoVar        (declare implicit vars based on assignment to undeclared identifiers)
-coffeeBooleans (yes/no/on/off)
-coffeeComment  (# single line comments)
-coffeeDo       ( `do ->`, disables ES6 do/while)
-coffeeEq       (`==` -> `===`, `!=` -> `!==`)
-coffeeForLoops (for in, of, from loops behave like they do in CoffeeScript)
-coffeeInterpolation (`"a string with #{myVar}"`)
-coffeeIsnt     (`isnt` -> `!==`)
-coffeeNot      (`not` -> "!") (currently doesn't support `not instanceof`, `not of`)
-coffeeOf       (`a of b` -> `a in b`, `a in b` -> `b.indexOf(a) >= 0`, `a not in b` -> `b.indexOf(a) < 0`)
-```
+| Configuration       | What it enables |
+|---------------------|---------------------------------------------------------------------|
+| autoVar             | declare implicit vars based on assignment to undeclared identifiers |
+| coffeeBooleans      | `yes`, `no`, `on`, `off` |
+| coffeeComment       | `# single line comments` |
+| coffeeDo            | `do ->`, disables ES6 do/while |
+| coffeeEq            | `==` -> `===`, `!=` -> `!==` |
+| coffeeForLoops      | for in, of, from loops behave like they do in CoffeeScript |
+| coffeeInterpolation | `"a string with #{myVar}"` |
+| coffeeIsnt          | `isnt` -> `!==` |
+| coffeeNot           | `not` -> `!`, `a not instanceof b` -> `!(a instanceof b)`; `not of` is not yet supported  |
+| coffeeOf            | `a of b` -> `a in b`, `a in b` -> `b.indexOf(a) >= 0`, `a not in b` -> `b.indexOf(a) < 0` |
+
 
 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"`.
+Another possibility 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