@danielx/civet 0.5.19 → 0.5.21

package/README.md

@@ -140,6 +140,8 @@ Things Changed from CoffeeScript
 - `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.
 - `x?()` → `x?.()` instead of `if (typeof x === 'function') { x() }`
+- Functions don't implicitly return the last value if there's a semicolon
+  at the end: `-> x` returns `x` but `-> x;` does not
 - Backtick embedded JS has been replaced with JS template literals.
 - No longer allowing multiple postfix `if/unless` on the same line (use `&&` or `and` to combine conditions).
 - `#{}` interpolation in `""` strings only when `"civet coffeeCompat"` or `"civet coffeeInterpolation"`
@@ -193,6 +195,9 @@ Things Added that CoffeeScript didn't
   - Private identifiers `#id`
 - Convenience for ES6+ Features
   - Const assignment shorthand: `a := b` → `const a = b`, `{a, b} := c` → `const {a, b} = c`
+  - Let assignment shorthand (experimental): `a .= b` or `a ::= b` → `let a = b`
+  - Typed versions of above: `a: number .= 5` → `let a: number = 5`
+    (but note that `a: number = 5` is the object literal `{a: (number = 5)}`).
   - `@#id` → `this.#id` shorthand for private identifiers
   - `import` shorthand: `x from ./x` → `import x from "./x"`
   - Dynamic `import` shorthand: `import './x'` not at top level
@@ -209,6 +214,13 @@ Things Added that CoffeeScript didn't
   - Function call: `x.map &.callback a, b` → `x.map($ => $.callback(a, b))`
   - Unary operators: `x.map !!&` → `x.map($ => !!$)`
   - Binary operators: `x.map &+1` → `x.map($ => $+1)`
+- Pipe operator (based on [F# pipes](https://learn.microsoft.com/en-us/dotnet/fsharp/language-reference/symbol-and-operator-reference/#function-symbols-and-operators), [Hack pipes](https://docs.hhvm.com/hack/expressions-and-operators/pipe) and the [TC39 proposal](https://github.com/tc39/proposal-pipeline-operator))
+  - `data |> Object.keys |> console.log` equivalent to
+    `console.log(Object.keys(data))`
+  - Use single-argument arrow functions or `&` shorthand
+    to specify how to use left-hand side
+  - `|> await`, `|> yield`, and `|> return` (at end)
+    for wrapping left-hand side with that operation
 - Flagging shorthand [from LiveScript](https://livescript.net/#literals) `{+debug, -live}` → `{debug: true, live: false}`
 - JSX enhancements (inspired by [solid-dsl discussions](https://github.com/solidjs-community/solid-dsl/discussions)):
   - Indentation: instead of explicitly closing `<tag>`s or `<>`s,
@@ -252,7 +264,9 @@ Things Added that CoffeeScript didn't
 Things Changed from ES6
 ---
 
-- Implicit returns
+- Implicit returns, even for multi-statement functions
+  (avoid by adding a trailing `;`, an explicit `return`, or
+  via the directive `"civet -implicitReturns"`)
 - Disallow no parens on single argument arrow function. `x => ...` must become `(x) => ...`
   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
@@ -298,6 +312,16 @@ You can use these with `"civet coffeeCompat"` to opt in to all or use them bit b
 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.
 
+ECMAScript Compatibility
+---
+
+You can also specify `"civet"` prologue directives to increase
+compatibility with ECMAScript/TypeScript:
+
+| Configuration       | What it enables |
+|---------------------|---------------------------------------|
+| -implicit-returns   | turn off implicit return of last value in functions |
+
 Other Options
 ---
 

package/dist/browser.js

@@ -441,6 +441,7 @@ ${input.slice(result.pos)}
         ParenthesizedExpression,
         ClassDeclaration,
         ClassExpression,
+        ClassBinding,
         ClassHeritage,
         ExtendsClause,
         ExtendsToken,
@@ -692,6 +693,7 @@ ${input.slice(result.pos)}
         Whitespace,
         ExpressionDelimiter,
         StatementDelimiter,
+        SemicolonDelimiter,
         NonIdContinue,
         Loc,
         Abstract,
@@ -2104,7 +2106,8 @@ ${input.slice(result.pos)}
       }
       var PipelineTailItem$0 = Await;
       var PipelineTailItem$1 = Yield;
-      var PipelineTailItem$2 = PipelineHeadItem;
+      var PipelineTailItem$2 = Return;
+      var PipelineTailItem$3 = PipelineHeadItem;
       function PipelineTailItem(state) {
         if (state.events) {
           const result = state.events.enter?.("PipelineTailItem", state);
@@ -2112,12 +2115,12 @@ ${input.slice(result.pos)}
             return result.cache;
         }
         if (state.tokenize) {
-          const result = $TOKEN("PipelineTailItem", state, PipelineTailItem$0(state) || PipelineTailItem$1(state) || PipelineTailItem$2(state));
+          const result = $TOKEN("PipelineTailItem", state, PipelineTailItem$0(state) || PipelineTailItem$1(state) || PipelineTailItem$2(state) || PipelineTailItem$3(state));
           if (state.events)
             state.events.exit?.("PipelineTailItem", state, result);
           return result;
         } else {
-          const result = PipelineTailItem$0(state) || PipelineTailItem$1(state) || PipelineTailItem$2(state);
+          const result = PipelineTailItem$0(state) || PipelineTailItem$1(state) || PipelineTailItem$2(state) || PipelineTailItem$3(state);
           if (state.events)
             state.events.exit?.("PipelineTailItem", state, result);
           return result;
@@ -2202,7 +2205,7 @@ ${input.slice(result.pos)}
           return result;
         }
       }
-      var ClassExpression$0 = $TS($S($E(Decorators), $E($S(Abstract, __)), Class, $E($S(BindingIdentifier, $E(TypeParameters))), $E(ClassHeritage), ClassBody), function($skip, $loc, $0, $1, $2, $3, $4, $5, $6) {
+      var ClassExpression$0 = $TS($S($E(Decorators), $E($S(Abstract, __)), Class, $E(ClassBinding), $E(ClassHeritage), ClassBody), function($skip, $loc, $0, $1, $2, $3, $4, $5, $6) {
         return $0;
       });
       function ClassExpression(state) {
@@ -2223,6 +2226,27 @@ ${input.slice(result.pos)}
           return result;
         }
       }
+      var ClassBinding$0 = $T($S($N(EOS), BindingIdentifier, $E(TypeParameters)), function(value) {
+        return [value[1], value[2]];
+      });
+      function ClassBinding(state) {
+        if (state.events) {
+          const result = state.events.enter?.("ClassBinding", state);
+          if (result)
+            return result.cache;
+        }
+        if (state.tokenize) {
+          const result = $TOKEN("ClassBinding", state, ClassBinding$0(state));
+          if (state.events)
+            state.events.exit?.("ClassBinding", state, result);
+          return result;
+        } else {
+          const result = ClassBinding$0(state);
+          if (state.events)
+            state.events.exit?.("ClassBinding", state, result);
+          return result;
+        }
+      }
       var ClassHeritage$0 = $S(ExtendsClause, $E(ImplementsClause));
       var ClassHeritage$1 = ImplementsClause;
       function ClassHeritage(state) {
@@ -4065,7 +4089,7 @@ ${input.slice(result.pos)}
           return result;
         }
       }
-      var SingleLineStatements$0 = $TS($S($S($Q(TrailingComment), Statement), $Q($S($S($Q(TrailingComment), Semicolon, $Q(TrailingComment)), Statement))), function($skip, $loc, $0, $1, $2) {
+      var SingleLineStatements$0 = $TS($S($S($Q(TrailingComment), Statement), $Q($S(SemicolonDelimiter, $E(Statement)))), function($skip, $loc, $0, $1, $2) {
         var first = $1;
         var rest = $2;
         if (rest.length) {
@@ -5301,7 +5325,7 @@ ${input.slice(result.pos)}
           ts: true
         };
       });
-      var MethodDefinition$1 = $TS($S(MethodSignature, BracedBlock), function($skip, $loc, $0, $1, $2) {
+      var MethodDefinition$1 = $TS($S(MethodSignature, BracedOrEmptyBlock), function($skip, $loc, $0, $1, $2) {
         var signature = $1;
         var block = $2;
         return {
@@ -9256,7 +9280,7 @@ ${input.slice(result.pos)}
           return result;
         }
       }
-      var StatementDelimiter$0 = $S($Q(TrailingComment), Semicolon, $Q(TrailingComment));
+      var StatementDelimiter$0 = SemicolonDelimiter;
       var StatementDelimiter$1 = $Y(EOS);
       function StatementDelimiter(state) {
         if (state.events) {
@@ -9276,6 +9300,30 @@ ${input.slice(result.pos)}
           return result;
         }
       }
+      var SemicolonDelimiter$0 = $TS($S($Q(TrailingComment), Semicolon, $Q(TrailingComment)), function($skip, $loc, $0, $1, $2, $3) {
+        return {
+          type: "SemicolonDelimiter",
+          children: $0
+        };
+      });
+      function SemicolonDelimiter(state) {
+        if (state.events) {
+          const result = state.events.enter?.("SemicolonDelimiter", state);
+          if (result)
+            return result.cache;
+        }
+        if (state.tokenize) {
+          const result = $TOKEN("SemicolonDelimiter", state, SemicolonDelimiter$0(state));
+          if (state.events)
+            state.events.exit?.("SemicolonDelimiter", state, result);
+          return result;
+        } else {
+          const result = SemicolonDelimiter$0(state);
+          if (state.events)
+            state.events.exit?.("SemicolonDelimiter", state, result);
+          return result;
+        }
+      }
       var NonIdContinue$0 = $R$0($EXPECT($R43, fail, "NonIdContinue /(?!\\p{ID_Continue})/"));
       function NonIdContinue(state) {
         if (state.events) {
@@ -11155,7 +11203,23 @@ ${input.slice(result.pos)}
             if (stringPart) {
               exprs.unshift(JSON.stringify(stringPart), ", ");
             }
-            classValue = ["{[", ...exprs, '].filter(Boolean).join(" ")}'];
+            if (exprs.length === 1) {
+              let root = exprs[0];
+              while (root.length && module.isWhitespaceOrEmpty(root[root.length - 1])) {
+                root = root.slice(0, -1);
+              }
+              while (root?.length === 1)
+                root = root[0];
+              if (root?.children)
+                root = root.children;
+              if (root?.[0]?.token === "`") {
+                classValue = ["{", ...exprs, "}"];
+              } else {
+                classValue = ["{(", ...exprs, ') || ""}'];
+              }
+            } else {
+              classValue = ["{[", ...exprs, '].filter(Boolean).join(" ")}'];
+            }
           } else {
             classValue = JSON.stringify(stringPart);
           }
@@ -13987,6 +14051,8 @@ ${input.slice(result.pos)}
                 insertReturn(exp.children[2][3]);
               return;
           }
+          if (node[node.length - 1]?.type === "SemicolonDelimiter")
+            return;
           node.splice(1, 0, "return ");
         }
         module.isWhitespaceOrEmpty = function(node) {
@@ -13994,6 +14060,8 @@ ${input.slice(result.pos)}
             return true;
           if (node.token)
             return node.token.match(/^\s*$/);
+          if (node.children)
+            node = node.children;
           if (!node.length)
             return true;
           if (typeof node === "string")
@@ -14588,6 +14656,8 @@ ${input.slice(result.pos)}
                 insertBeforeAssignment(node, ["let ", undeclaredIdentifiers.join(", "), "\n"]);
               }
             } else if (node.type == "Declaration") {
+              if (node.children && node.children.length)
+                createLetDecs(node.children, scopes);
               node.names.forEach((name) => currentScope.add(name));
             } else {
               let block = node;
@@ -14646,7 +14716,7 @@ ${input.slice(result.pos)}
           }
         };
         module.constructPipeStep = function(caller, callee) {
-          if (caller.expr.token === "yield" || caller.expr.token === "await") {
+          if (caller.expr.token === "yield" || caller.expr.token === "await" || caller.expr.token === "return") {
             return [caller.leadingComment, caller.expr, caller.trailingComment, " ", callee.leadingComment, callee.expr, callee.trailingComment];
           }
           return module.constructInvocation(caller, callee);

package/dist/main.js

@@ -440,6 +440,7 @@ ${input.slice(result.pos)}
       ParenthesizedExpression,
       ClassDeclaration,
       ClassExpression,
+      ClassBinding,
       ClassHeritage,
       ExtendsClause,
       ExtendsToken,
@@ -691,6 +692,7 @@ ${input.slice(result.pos)}
       Whitespace,
       ExpressionDelimiter,
       StatementDelimiter,
+      SemicolonDelimiter,
       NonIdContinue,
       Loc,
       Abstract,
@@ -2103,7 +2105,8 @@ ${input.slice(result.pos)}
     }
     var PipelineTailItem$0 = Await;
     var PipelineTailItem$1 = Yield;
-    var PipelineTailItem$2 = PipelineHeadItem;
+    var PipelineTailItem$2 = Return;
+    var PipelineTailItem$3 = PipelineHeadItem;
     function PipelineTailItem(state) {
       if (state.events) {
         const result = state.events.enter?.("PipelineTailItem", state);
@@ -2111,12 +2114,12 @@ ${input.slice(result.pos)}
           return result.cache;
       }
       if (state.tokenize) {
-        const result = $TOKEN("PipelineTailItem", state, PipelineTailItem$0(state) || PipelineTailItem$1(state) || PipelineTailItem$2(state));
+        const result = $TOKEN("PipelineTailItem", state, PipelineTailItem$0(state) || PipelineTailItem$1(state) || PipelineTailItem$2(state) || PipelineTailItem$3(state));
         if (state.events)
           state.events.exit?.("PipelineTailItem", state, result);
         return result;
       } else {
-        const result = PipelineTailItem$0(state) || PipelineTailItem$1(state) || PipelineTailItem$2(state);
+        const result = PipelineTailItem$0(state) || PipelineTailItem$1(state) || PipelineTailItem$2(state) || PipelineTailItem$3(state);
         if (state.events)
           state.events.exit?.("PipelineTailItem", state, result);
         return result;
@@ -2201,7 +2204,7 @@ ${input.slice(result.pos)}
         return result;
       }
     }
-    var ClassExpression$0 = $TS($S($E(Decorators), $E($S(Abstract, __)), Class, $E($S(BindingIdentifier, $E(TypeParameters))), $E(ClassHeritage), ClassBody), function($skip, $loc, $0, $1, $2, $3, $4, $5, $6) {
+    var ClassExpression$0 = $TS($S($E(Decorators), $E($S(Abstract, __)), Class, $E(ClassBinding), $E(ClassHeritage), ClassBody), function($skip, $loc, $0, $1, $2, $3, $4, $5, $6) {
       return $0;
     });
     function ClassExpression(state) {
@@ -2222,6 +2225,27 @@ ${input.slice(result.pos)}
         return result;
       }
     }
+    var ClassBinding$0 = $T($S($N(EOS), BindingIdentifier, $E(TypeParameters)), function(value) {
+      return [value[1], value[2]];
+    });
+    function ClassBinding(state) {
+      if (state.events) {
+        const result = state.events.enter?.("ClassBinding", state);
+        if (result)
+          return result.cache;
+      }
+      if (state.tokenize) {
+        const result = $TOKEN("ClassBinding", state, ClassBinding$0(state));
+        if (state.events)
+          state.events.exit?.("ClassBinding", state, result);
+        return result;
+      } else {
+        const result = ClassBinding$0(state);
+        if (state.events)
+          state.events.exit?.("ClassBinding", state, result);
+        return result;
+      }
+    }
     var ClassHeritage$0 = $S(ExtendsClause, $E(ImplementsClause));
     var ClassHeritage$1 = ImplementsClause;
     function ClassHeritage(state) {
@@ -4064,7 +4088,7 @@ ${input.slice(result.pos)}
         return result;
       }
     }
-    var SingleLineStatements$0 = $TS($S($S($Q(TrailingComment), Statement), $Q($S($S($Q(TrailingComment), Semicolon, $Q(TrailingComment)), Statement))), function($skip, $loc, $0, $1, $2) {
+    var SingleLineStatements$0 = $TS($S($S($Q(TrailingComment), Statement), $Q($S(SemicolonDelimiter, $E(Statement)))), function($skip, $loc, $0, $1, $2) {
       var first = $1;
       var rest = $2;
       if (rest.length) {
@@ -5300,7 +5324,7 @@ ${input.slice(result.pos)}
         ts: true
       };
     });
-    var MethodDefinition$1 = $TS($S(MethodSignature, BracedBlock), function($skip, $loc, $0, $1, $2) {
+    var MethodDefinition$1 = $TS($S(MethodSignature, BracedOrEmptyBlock), function($skip, $loc, $0, $1, $2) {
       var signature = $1;
       var block = $2;
       return {
@@ -9255,7 +9279,7 @@ ${input.slice(result.pos)}
         return result;
       }
     }
-    var StatementDelimiter$0 = $S($Q(TrailingComment), Semicolon, $Q(TrailingComment));
+    var StatementDelimiter$0 = SemicolonDelimiter;
     var StatementDelimiter$1 = $Y(EOS);
     function StatementDelimiter(state) {
       if (state.events) {
@@ -9275,6 +9299,30 @@ ${input.slice(result.pos)}
         return result;
       }
     }
+    var SemicolonDelimiter$0 = $TS($S($Q(TrailingComment), Semicolon, $Q(TrailingComment)), function($skip, $loc, $0, $1, $2, $3) {
+      return {
+        type: "SemicolonDelimiter",
+        children: $0
+      };
+    });
+    function SemicolonDelimiter(state) {
+      if (state.events) {
+        const result = state.events.enter?.("SemicolonDelimiter", state);
+        if (result)
+          return result.cache;
+      }
+      if (state.tokenize) {
+        const result = $TOKEN("SemicolonDelimiter", state, SemicolonDelimiter$0(state));
+        if (state.events)
+          state.events.exit?.("SemicolonDelimiter", state, result);
+        return result;
+      } else {
+        const result = SemicolonDelimiter$0(state);
+        if (state.events)
+          state.events.exit?.("SemicolonDelimiter", state, result);
+        return result;
+      }
+    }
     var NonIdContinue$0 = $R$0($EXPECT($R43, fail, "NonIdContinue /(?!\\p{ID_Continue})/"));
     function NonIdContinue(state) {
       if (state.events) {
@@ -11154,7 +11202,23 @@ ${input.slice(result.pos)}
           if (stringPart) {
             exprs.unshift(JSON.stringify(stringPart), ", ");
           }
-          classValue = ["{[", ...exprs, '].filter(Boolean).join(" ")}'];
+          if (exprs.length === 1) {
+            let root = exprs[0];
+            while (root.length && module2.isWhitespaceOrEmpty(root[root.length - 1])) {
+              root = root.slice(0, -1);
+            }
+            while (root?.length === 1)
+              root = root[0];
+            if (root?.children)
+              root = root.children;
+            if (root?.[0]?.token === "`") {
+              classValue = ["{", ...exprs, "}"];
+            } else {
+              classValue = ["{(", ...exprs, ') || ""}'];
+            }
+          } else {
+            classValue = ["{[", ...exprs, '].filter(Boolean).join(" ")}'];
+          }
         } else {
           classValue = JSON.stringify(stringPart);
         }
@@ -13986,6 +14050,8 @@ ${input.slice(result.pos)}
               insertReturn(exp.children[2][3]);
             return;
         }
+        if (node[node.length - 1]?.type === "SemicolonDelimiter")
+          return;
         node.splice(1, 0, "return ");
       }
       module2.isWhitespaceOrEmpty = function(node) {
@@ -13993,6 +14059,8 @@ ${input.slice(result.pos)}
           return true;
         if (node.token)
           return node.token.match(/^\s*$/);
+        if (node.children)
+          node = node.children;
         if (!node.length)
           return true;
         if (typeof node === "string")
@@ -14587,6 +14655,8 @@ ${input.slice(result.pos)}
               insertBeforeAssignment(node, ["let ", undeclaredIdentifiers.join(", "), "\n"]);
             }
           } else if (node.type == "Declaration") {
+            if (node.children && node.children.length)
+              createLetDecs(node.children, scopes);
             node.names.forEach((name) => currentScope.add(name));
           } else {
             let block = node;
@@ -14645,7 +14715,7 @@ ${input.slice(result.pos)}
         }
       };
       module2.constructPipeStep = function(caller, callee) {
-        if (caller.expr.token === "yield" || caller.expr.token === "await") {
+        if (caller.expr.token === "yield" || caller.expr.token === "await" || caller.expr.token === "return") {
           return [caller.leadingComment, caller.expr, caller.trailingComment, " ", callee.leadingComment, callee.expr, callee.trailingComment];
         }
         return module2.constructInvocation(caller, callee);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@danielx/civet",
-  "version": "0.5.19",
+  "version": "0.5.21",
   "description": "CoffeeScript style syntax for TypeScript",
   "main": "dist/main.js",
   "exports": {
@@ -22,8 +22,9 @@
   },
   "scripts": {
     "build": "bash ./build/build.sh",
-    "civet.dev": "bash ./build/site.sh",
-    "npm-release": "bash ./build/npm-release.sh",
+    "docs:dev": "vitepress dev civet.dev",
+    "docs:build": "vitepress build civet.dev",
+    "docs:preview": "vitepress preview civet.dev",
     "prepublishOnly": "yarn build && yarn test",
     "test": "c8 mocha"
   },
@@ -42,7 +43,9 @@
     "mocha": "^10.0.0",
     "ts-node": "^10.9.1",
     "tslib": "^2.4.0",
-    "typescript": "^4.7.4"
+    "typescript": "^4.7.4",
+    "vitepress": "^1.0.0-alpha.35",
+    "vue": "^3.2.45"
   },
   "c8": {
     "all": true,