@danielx/civet 0.2.9 → 0.2.12

package/README.md

@@ -5,11 +5,18 @@ Civet
 
 A new CoffeeScript. Much closer to ES2015+ (for better or worse).
 
-Also TypeScript, the sky is the limit.
+Also TypeScript, the sky is the limit. [Online Civet Playground](https://civet-web.vercel.app/)
+
+Quickstart Guide
+---
 
 ```bash
+# Install
 npm install -g @danielx/civet
+# Compile civet source file to typescript
 civet < source.civet > output.ts
+# Execute a civet source file in node
+node --loader @danielx/civet/register.mjs source.civet
 ```
 
 ![image](https://user-images.githubusercontent.com/18894/184558519-b675a903-7490-43ba-883e-0d8addacd4b9.png)
@@ -20,7 +27,7 @@ Code Sample
 ```typescript
 import ts, {CompilerOptions} from "typescript"
 
-const DefaultCompilerOptions : CompilerOptions =
+DefaultCompilerOptions : CompilerOptions :=
   allowNonTsExtensions: true
   allowJs: true
   target: ts.ScriptTarget.Latest
@@ -29,13 +36,13 @@ const DefaultCompilerOptions : CompilerOptions =
   allowSyntheticDefaultImports: true
   experimentalDecorators: true
 
-const fileCache : Record<string, any> = {}
+fileCache : Record<string, any> := {}
 
-const createCompilerHost = (options: CompilerOptions, moduleSearchLocations : string[]) ->
-  const fileExists = (fileName: string) : boolean ->
+createCompilerHost := (options: CompilerOptions, moduleSearchLocations : string[]) ->
+  fileExists := (fileName: string) : boolean ->
     return fileCache[fileName]?
 
-  const readFile = (fileName: string) ->
+  readFile := (fileName: string) ->
     return fileCache[fileName]
 ```
 
@@ -46,6 +53,8 @@ Things Kept from CoffeeScript
 - `or` -> `||`
 - `and` -> `&&`
 - `loop` -> `while(true)`
+- `unless` conditional (without the `else`)
+- `until condition` -> `while(!condition)`
 - Object literal syntax
   ```coffee
   x =
@@ -58,8 +67,8 @@ Things Kept from CoffeeScript
 - Optional semi-colons
 - Indentation based block syntax
 - OptionalChain shorthand for index and function application `a?[b]` -> `a?.[b]`, `a?(b)` -> `a?.(b)`
-- `@` -> `this`
-- `@id` -> `this.id`
+- `@` This shorthand `@` -> `this`, `@id` -> `this.id`
+- Prototype shorthand `X::` -> `X.prototype`, `X::a` -> `X.prototype.a`
 - Postfix `if/unless`
 - JSX 😿
 - TODO
@@ -70,14 +79,18 @@ Things Removed from CoffeeScript
 ---
 
 - `on/yes/off/no` (use `true/false`)
+- `isnt` (use `!==`)
+- `not` (use `!`)
 - `do` keyword (replaced with JS `do`)
 - `for from` (use JS `for of`)
 - Array slices `list[0...2]` (use `list.slice(0, 2)`)
+- Slice assignment `numbers[3..6] = [-3, -4, -5, -6]`
 - Comprensions (a case could be made for keeping them)
 - Iteration expression results
 - Implicit declarations
 - Implicit returns (will probably add later)
 - Rest parameter in any assignment position (might add later)
+- Postfix `while/until`
 - `///` Heregexp
 - Embedded JS
 
@@ -92,10 +105,15 @@ Things Changed from CoffeeScript
 - Existential `x?` -> `(x != null)` no longer checks for undeclared variables.
 - 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`)
+- 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.
 
 Things Added that CoffeeScript didn't
 ---
 
+- TypeScript Types
 - JS Compatability
   - `var`, `let`, `const`
   - JS Comment Syntax `//` and `/* */`
@@ -103,8 +121,7 @@ Things Added that CoffeeScript didn't
   - OptionalChain longhand
   - ConditionalExpression
   - `case` statement
-  - `while`
-  - `do`
+  - `do`, `do { ... } until condition`
 - Const assignment shorthand `a := b` -> `const a = b`; `{a, b} := c` -> `const {a, b} = c`
 - Convenience for ES6+ Features
   - `<` as `extends` shorthand
@@ -112,17 +129,16 @@ Things Added that CoffeeScript didn't
 - ClassStaticBlock
 - `get`/`set` method definitions
 - Private identifiers `#id`
-- Shebang line
+- Shebang line is kept unmodified in output
   ```civet
   #!./node_modules/.bin/ts-node
   console.log "hi"
   ```
-- TypeScript Types
 
 Things Changed from ES6
 ---
 
 - Disallow no parens on single argument arrow function. `x => ...` must become `(x) => ...`
-  The reasoning is `x -> ` => `x(function() ...)` in CoffeeScript and having `->` and `=>`
+  The reasoning is `x -> ...` => `x(function() ...)` in CoffeeScript and having `->` and `=>`
   behave more differently than they already do is bad. Passing an anonymous function to an
   application without parens is also convenient.