@danielx/civet 0.4.5 → 0.4.7

package/README.md

@@ -26,7 +26,7 @@ Code Sample
 ---
 
 ```typescript
-import ts, {CompilerOptions} from "typescript"
+ts, {CompilerOptions} from typescript
 
 DefaultCompilerOptions : CompilerOptions :=
   allowNonTsExtensions: true
@@ -94,7 +94,9 @@ Things Kept from CoffeeScript
 - Postfix `if/unless`
 - Block Strings `"""` / `'''`
   - `#{exp}` interpolation in `"""` strings
-- Multiple `case`/`when` expressions
+- Multiple `,` separated `case`/`when` expressions
+- `else` -> `default` in `switch`
+- Implicit returns
 - JSX 😿
 - TODO
   - [ ] Chained comparisons
@@ -108,17 +110,17 @@ Things Removed from CoffeeScript
 - `do` keyword (replaced with JS `do`, invoke using existing `(-> ...)()` syntax)
 - `for from` (use JS `for of`)
 - `and=`, `or=` (don't mix and match words and symbols)
-- Array slices `list[0...2]` (use `list.slice(0, 2)`)
-- Slice assignment `numbers[3..6] = [-3, -4, -5, -6]` (use `numbers.splice(3, 4, -3, -4, -5, -6)`)
-- Ranges `[0...10]`
-- Comprensions (a case could be made for keeping them)
 - Iteration expression results
 - Implicit declarations
-- Implicit returns (will probably add later at least for single line functions)
-- Rest parameter in any assignment position (might add later)
 - Postfix `while/until`
 - `///` Heregexp
-- Embedded JS
+- Backtick Embedded JS (replaced by template literals)
+- Might add later
+  - Comprensions (a case could be made for keeping them)
+  - Array slices `list[0...2]` (use `list.slice(0, 2)`)
+  - Slice assignment `numbers[3..6] = [-3, -4, -5, -6]` (use `numbers.splice(3, 4, -3, -4, -5, -6)`)
+  - Ranges `[0...10]`
+  - Rest parameter in any assignment position
 
 Things Changed from CoffeeScript
 ---
@@ -132,9 +134,19 @@ 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"`
 - Civet tries to keep the transpiled output verbatim as much as possible.
   In Coffee `(x)` -> `x;` but in Civet `(x)` -> `(x);`.
-  Also in Coffee `x    +    3` -> `x + 3` but in Civet `x    +    3` remains as is.
+  Also in Coffee
+  ```coffee
+    x    +    3
+  ```
+  -> `x + 3` without the spacing
+  In Civet
+  ```typescript
+    x    +    3
+  ```
+  remains as is.
 
 Things Added that CoffeeScript didn't
 ---
@@ -159,21 +171,22 @@ Things Added that CoffeeScript didn't
 - JS Compatability
   - `var`, `let`, `const`
   - JS Comment Syntax `//` and `/* */`
+  - `function` keyword
   - Braced Blocks
-  - OptionalChain longhand
-  - ConditionalExpression
+  - `f?.(x)` function application and `a?.[x]` index OptionalChain longhand
+  - `a ? b : c` ConditionalExpression
   - `case` statement
   - `do`, `do { ... } until condition`
-- Const assignment shorthand `a := b` -> `const a = b`; `{a, b} := c` -> `const {a, b} = c`
+  - `get`/`set` method definitions
+  - Private identifiers `#id`
 - Convenience for ES6+ Features
+  - Const assignment shorthand `a := b` -> `const a = b`; `{a, b} := c` -> `const {a, b} = c`
   - `<` as `extends` shorthand
   - `@#id` -> `this.#id` shorthand for private identifiers
   - `import` shorthand `x from ./x` -> `import x from "./x"`
-  - `\`\`\`` Block Template Strings
-- Class constructor shorthand `@( ... )`
-- ClassStaticBlock
-- `get`/`set` method definitions
-- Private identifiers `#id`
+  - `\`\`\`` Block Template Strings remove leading indentation for clarity
+  - Class constructor shorthand `@( ... )`
+  - ClassStaticBlock `@ { ... }`
 - Shebang line is kept unmodified in output
   ```civet
   #!./node_modules/.bin/ts-node