Save the rust version of settings (#5563)

* ensure we save the correct value for the settings versus relying on tomlStringify

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* more exact functions

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fmt

Signed-off-by: Jess Frazelle <github@jessfraz.com>

---------

Signed-off-by: Jess Frazelle <github@jessfraz.com>

.eslintignore

@@ -1,3 +1,4 @@
 src/wasm-lib/*
 *.typegen.ts
 packages/codemirror-lsp-client/dist/*
+e2e/playwright/snapshots/prompt-to-edit/*

.github/workflows/build-apps.yml

@@ -7,14 +7,11 @@ on:
       - main
     tags:
       - 'v[0-9]+.[0-9]+.[0-9]+'
-  schedule:
-    - cron: '0 4 * * *'
-  # Daily at 04:00 AM UTC
-  # Will checkout the last commit from the default branch (main as of 2023-10-04)
+      - 'nightly-v[0-9]+.[0-9]+.[0-9]+'
 
 env:
-  IS_RELEASE: ${{ github.ref_type == 'tag' }}
-  IS_NIGHTLY: ${{ github.event_name == 'schedule' }}
+  IS_RELEASE: ${{ github.ref_type == 'tag' && startsWith(github.ref_name, 'v') }}
+  IS_NIGHTLY: ${{ github.ref_type == 'tag' && startsWith(github.ref_name, 'nightly-v') }}
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
@@ -32,6 +29,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
+          cache: 'yarn'
 
       - run: yarn install
 
@@ -52,7 +50,10 @@ jobs:
 
       - name: Set nightly version, product name, release notes, and icons
         if: ${{ env.IS_NIGHTLY == 'true' }}
-        run: yarn files:flip-to-nightly
+        run: |
+          export VERSION=${GITHUB_REF_NAME#nightly-v}
+          yarn files:set-version
+          yarn files:flip-to-nightly
 
       - name: Set release version
         if: ${{ env.IS_RELEASE == 'true' }}
@@ -123,9 +124,11 @@ jobs:
           cp prepared-files/assets/icon.ico assets/icon.ico
           cp prepared-files/assets/icon.png assets/icon.png
 
-      - uses: actions/setup-node@v4
+      - name: Sync node version and setup cache
+        uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
+          cache: 'yarn' # Set this to npm, yarn or pnpm.
 
       - name: yarn install
         # Windows is picky sometimes and fails on fetch. Step takes about ~30s
@@ -270,7 +273,7 @@ jobs:
     runs-on: ubuntu-22.04
     permissions:
       contents: write
-    if: ${{ github.ref_type == 'tag' || github.event_name == 'schedule' }}
+    if: ${{ github.ref_type == 'tag' }}
     env:
       VERSION_NO_V: ${{ needs.prepare-files.outputs.version }}
       VERSION: ${{ format('v{0}', needs.prepare-files.outputs.version) }}
@@ -327,8 +330,8 @@ jobs:
         env:
           NOTES: ${{ needs.prepare-files.outputs.notes }}
           PUB_DATE: ${{ github.event.repository.updated_at }}
-          WEBSITE_DIR: ${{ github.event_name == 'schedule' && 'dl.zoo.dev/releases/modeling-app/nightly' || 'dl.zoo.dev/releases/modeling-app' }}
-          URL_CODED_NAME: ${{ github.event_name == 'schedule' && 'Zoo%20Modeling%20App%20%28Nightly%29' || 'Zoo%20Modeling%20App' }}
+          WEBSITE_DIR: ${{ env.IS_NIGHTLY == 'true' && 'dl.zoo.dev/releases/modeling-app/nightly' || 'dl.zoo.dev/releases/modeling-app' }}
+          URL_CODED_NAME: ${{ env.IS_NIGHTLY == 'true' && 'Zoo%20Modeling%20App%20%28Nightly%29' || 'Zoo%20Modeling%20App' }}
         run: |
           RELEASE_DIR=https://${WEBSITE_DIR}
           jq --null-input \
@@ -383,7 +386,7 @@ jobs:
           # see https://github.com/actions/checkout/issues/1471
           git fetch --prune --unshallow --tags
           export TAG="nightly-${VERSION}"
-          export PREVIOUS_TAG=$(git describe --tags --match="nightly-v[0-9]*" --abbrev=0)
+          export PREVIOUS_TAG=$(git tag --list --sort=-committerdate "nightly-v[0-9]*" | head -n2 | tail -n1)
           export NOTES=$(./scripts/get-nightly-changelog.sh)
           yarn files:set-notes
 
@@ -411,14 +414,3 @@ jobs:
       - name: Invalidate bucket cache on latest*.yml and last_download.json files
         if: ${{ env.IS_NIGHTLY == 'true' }}
         run: yarn files:invalidate-bucket:nightly
-
-      - name: Tag nightly commit
-        if: ${{ env.IS_NIGHTLY == 'true' }}
-        uses: actions/github-script@v7
-        with:
-          script: |
-            const { VERSION } = process.env          
-            const { owner, repo } = context.repo
-            const { sha } = context
-            const ref = `refs/tags/nightly-${VERSION}`
-            github.rest.git.createRef({ owner, repo, sha, ref })

.github/workflows/e2e-tests.yml

@@ -142,7 +142,7 @@ jobs:
       # TODO: break this in its own job, for now it's not slowing down the overall execution as ubuntu is the quickest,
       # but we could do better. This forces a large 1/1 shard of all 20 snapshot tests that runs in about 3 minutes.
       run: |
-        PLATFORM=web yarn playwright test --config=playwright.config.ts --retries="3" --update-snapshots --grep=@snapshot  --shard=1/1
+        PLATFORM=web yarn playwright test --config=playwright.config.ts --retries="3" --update-snapshots --grep=@snapshot --trace=on --shard=1/1
       env:
         CI: true
         NODE_ENV: development
@@ -153,7 +153,7 @@ jobs:
     - uses: actions/upload-artifact@v4
       if: ${{ !cancelled() && (success() || failure()) }}
       with:
-        name: playwright-report-${{ matrix.os }}-snapshot-${{ matrix.shardIndex }}-${{ github.sha }}
+        name: playwright-report-snapshots-${{ matrix.os }}-snapshot-${{ matrix.shardIndex }}-${{ github.sha }}
         path: playwright-report/
         include-hidden-files: true
         retention-days: 30
@@ -167,7 +167,7 @@ jobs:
       shell: bash
       id: git-check
       run: |
-          git add e2e/playwright/snapshot-tests.spec.ts-snapshots
+          git add e2e/playwright/snapshot-tests.spec.ts-snapshots e2e/playwright/snapshots
           if git status | grep -q "Changes to be committed"
           then echo "modified=true" >> $GITHUB_OUTPUT
           else echo "modified=false" >> $GITHUB_OUTPUT
@@ -176,7 +176,7 @@ jobs:
       if: steps.git-check.outputs.modified == 'true'
       shell: bash
       run: |
-        git add e2e/playwright/snapshot-tests.spec.ts-snapshots
+        git add e2e/playwright/snapshot-tests.spec.ts-snapshots e2e/playwright/snapshots
         git config --local user.email "github-actions[bot]@users.noreply.github.com"
         git config --local user.name "github-actions[bot]"
         git remote set-url origin https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git

.github/workflows/tag-nightly.yml

@@ -0,0 +1,39 @@
+name: tag-nightly
+
+permissions:
+  contents: write
+on:
+  schedule:
+    - cron: '0 4 * * *'
+  # Daily at 04:00 AM UTC
+  # Will checkout the last commit from the default branch (main as of 2023-10-04)
+  
+jobs:
+  tag-nightly:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/create-github-app-token@v1
+        id: app-token
+        with:
+          app-id: ${{ secrets.MODELING_APP_GH_APP_ID }}
+          private-key: ${{ secrets.MODELING_APP_GH_APP_PRIVATE_KEY }}
+          owner: ${{ github.repository_owner }}
+
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ steps.app-token.outputs.token }}
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+
+      - run: yarn install
+
+      - name: Push tag
+        run: |
+          VERSION_NO_V=$(date +'%-y.%-m.%-d')
+          TAG="nightly-v$VERSION_NO_V"
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git tag $TAG
+          git push origin tag $TAG

.gitignore

@@ -24,7 +24,7 @@ yarn-debug.log*
 yarn-error.log*
 
 .idea
-# .vscode
+.vscode
 .helix
 src/wasm-lib/.idea
 src/wasm-lib/.vscode
@@ -71,3 +71,4 @@ venv
 
 # electron
 out/
+*.snap.new

.prettierignore

@@ -10,6 +10,7 @@ target
 src/wasm-lib/pkg
 src/wasm-lib/kcl/bindings
 e2e/playwright/export-snapshots
+e2e/playwright/snapshots/prompt-to-edit
 
 
 # XState generated files

.vscode/settings.json

@@ -1,5 +0,0 @@
-{
-    "rust-analyzer.linkedProjects": [
-        "src/wasm-lib/Cargo.toml"
-    ]
-}

docs/kcl/QUARTER_TURN.md

@@ -1,15 +0,0 @@
----
-title: "QUARTER_TURN"
-excerpt: ""
-layout: manual
----
-
-
-
-
-
-```js
-QUARTER_TURN: number(deg) = 90deg
-```
-
-

docs/kcl/THREE_QUARTER_TURN.md

@@ -1,15 +0,0 @@
----
-title: "THREE_QUARTER_TURN"
-excerpt: ""
-layout: manual
----
-
-
-
-
-
-```js
-THREE_QUARTER_TURN: number(deg) = 270deg
-```
-
-

docs/kcl/angleToMatchLengthX.md

@@ -9,7 +9,11 @@ Returns the angle to match the given length for x.
 
 
 ```js
-angleToMatchLengthX(tag: TagIdentifier, to: number, sketch: Sketch) -> number
+angleToMatchLengthX(
+  tag: TagIdentifier,
+  to: number,
+  sketch: Sketch,
+) -> number
 ```
 
 

docs/kcl/angleToMatchLengthY.md

@@ -9,7 +9,11 @@ Returns the angle to match the given length for y.
 
 
 ```js
-angleToMatchLengthY(tag: TagIdentifier, to: number, sketch: Sketch) -> number
+angleToMatchLengthY(
+  tag: TagIdentifier,
+  to: number,
+  sketch: Sketch,
+) -> number
 ```
 
 

docs/kcl/angledLine.md

@@ -9,7 +9,11 @@ Draw a line segment relative to the current origin using the polar
 measure of some angle and distance.
 
 ```js
-angledLine(data: AngledLineData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+angledLine(
+  data: AngledLineData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ angledLine(data: AngledLineData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> yLineTo(15, %)
   |> angledLine({ angle = 30, length = 15 }, %)

docs/kcl/angledLineOfXLength.md

@@ -9,7 +9,11 @@ Create a line segment from the current 2-dimensional sketch origin
 along some angle (in degrees) for some relative length in the 'x' dimension.
 
 ```js
-angledLineOfXLength(data: AngledLineData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+angledLineOfXLength(
+  data: AngledLineData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ angledLineOfXLength(data: AngledLineData, sketch: Sketch, tag?: TagDeclarator) -
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLineOfXLength({ angle = 45, length = 10 }, %, $edge1)
   |> angledLineOfXLength({ angle = -15, length = 20 }, %, $edge2)

docs/kcl/angledLineOfYLength.md

@@ -9,7 +9,11 @@ Create a line segment from the current 2-dimensional sketch origin
 along some angle (in degrees) for some relative length in the 'y' dimension.
 
 ```js
-angledLineOfYLength(data: AngledLineData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+angledLineOfYLength(
+  data: AngledLineData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ angledLineOfYLength(data: AngledLineData, sketch: Sketch, tag?: TagDeclarator) -
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [10, 0])
   |> angledLineOfYLength({ angle = 45, length = 10 }, %)

docs/kcl/angledLineThatIntersects.md

@@ -9,7 +9,11 @@ Draw an angled line from the current origin, constructing a line segment
 such that the newly created line intersects the desired target line segment.
 
 ```js
-angledLineThatIntersects(data: AngledLineThatIntersectsData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+angledLineThatIntersects(
+  data: AngledLineThatIntersectsData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ angledLineThatIntersects(data: AngledLineThatIntersectsData, sketch: Sketch, tag
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(endAbsolute = [5, 10])
   |> line(endAbsolute = [-10, 10], tag = $lineToIntersect)

docs/kcl/angledLineToX.md

@@ -9,7 +9,11 @@ Create a line segment from the current 2-dimensional sketch origin
 along some angle (in degrees) for some length, ending at the provided value in the 'x' dimension.
 
 ```js
-angledLineToX(data: AngledLineToData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+angledLineToX(
+  data: AngledLineToData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ angledLineToX(data: AngledLineToData, sketch: Sketch, tag?: TagDeclarator) -> Sk
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLineToX({ angle = 30, to = 10 }, %)
   |> line(end = [0, 10])

docs/kcl/angledLineToY.md

@@ -9,7 +9,11 @@ Create a line segment from the current 2-dimensional sketch origin
 along some angle (in degrees) for some length, ending at the provided value in the 'y' dimension.
 
 ```js
-angledLineToY(data: AngledLineToData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+angledLineToY(
+  data: AngledLineToData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ angledLineToY(data: AngledLineToData, sketch: Sketch, tag?: TagDeclarator) -> Sk
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLineToY({ angle = 60, to = 20 }, %)
   |> line(end = [-20, 0])

docs/kcl/arc.md

@@ -11,7 +11,11 @@ The arc is constructed such that the current position of the sketch is placed al
 Unless this makes a lot of sense and feels like what you're looking for to construct your shape, you're likely looking for tangentialArc.
 
 ```js
-arc(data: ArcData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+arc(
+  data: ArcData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -31,7 +35,7 @@ arc(data: ArcData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [10, 0])
   |> arc({

docs/kcl/arcTo.md

@@ -9,7 +9,11 @@ Draw a 3 point arc.
 The arc is constructed such that the start point is the current position of the sketch and two more points defined as the end and interior point. The interior point is placed between the start point and end point. The radius of the arc will be controlled by how far the interior point is placed from the start and end.
 
 ```js
-arcTo(data: ArcToData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+arcTo(
+  data: ArcToData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ arcTo(data: ArcToData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> arcTo({ end = [10, 0], interior = [5, 5] }, %)
   |> close()

docs/kcl/assert.md

@@ -9,7 +9,10 @@ Check a value at runtime, and raise an error if the argument provided
 is false.
 
 ```js
-assert(data: bool, message: string) -> ()
+assert(
+  data: bool,
+  message: string,
+) -> ()
 ```
 
 

docs/kcl/assertEqual.md

@@ -9,7 +9,12 @@ Check that a numerical value equals another at runtime,
 otherwise raise an error.
 
 ```js
-assertEqual(left: number, right: number, epsilon: number, message: string) -> ()
+assertEqual(
+  left: number,
+  right: number,
+  epsilon: number,
+  message: string,
+) -> ()
 ```
 
 

docs/kcl/assertGreaterThan.md

@@ -9,7 +9,11 @@ Check that a numerical value is greater than another at runtime,
 otherwise raise an error.
 
 ```js
-assertGreaterThan(left: number, right: number, message: string) -> ()
+assertGreaterThan(
+  left: number,
+  right: number,
+  message: string,
+) -> ()
 ```
 
 

docs/kcl/assertGreaterThanOrEq.md

@@ -9,7 +9,11 @@ Check that a numerical value is greater than or equal to another at runtime,
 otherwise raise an error.
 
 ```js
-assertGreaterThanOrEq(left: number, right: number, message: string) -> ()
+assertGreaterThanOrEq(
+  left: number,
+  right: number,
+  message: string,
+) -> ()
 ```
 
 

docs/kcl/assertLessThan.md

@@ -9,7 +9,11 @@ Check that a numerical value is less than to another at runtime,
 otherwise raise an error.
 
 ```js
-assertLessThan(left: number, right: number, message: string) -> ()
+assertLessThan(
+  left: number,
+  right: number,
+  message: string,
+) -> ()
 ```
 
 

docs/kcl/assertLessThanOrEq.md

@@ -9,7 +9,11 @@ Check that a numerical value is less than or equal to another at runtime,
 otherwise raise an error.
 
 ```js
-assertLessThanOrEq(left: number, right: number, message: string) -> ()
+assertLessThanOrEq(
+  left: number,
+  right: number,
+  message: string,
+) -> ()
 ```
 
 

docs/kcl/atan2.md

@@ -9,7 +9,10 @@ Compute the four quadrant arctangent of Y and X (in radians).
 
 
 ```js
-atan2(y: number, x: number) -> number
+atan2(
+  y: number,
+  x: number,
+) -> number
 ```
 
 ### Tags

docs/kcl/bezierCurve.md

@@ -9,7 +9,11 @@ Draw a smooth, continuous, curved line segment from the current origin to
 the desired (x, y), using a number of control points to shape the curve's shape.
 
 ```js
-bezierCurve(data: BezierData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+bezierCurve(
+  data: BezierData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ bezierCurve(data: BezierData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [0, 10])
   |> bezierCurve({

docs/kcl/chamfer.md

@@ -9,7 +9,12 @@ Cut a straight transitional edge along a tagged path.
 Chamfer is similar in function and use to a fillet, except a fillet will blend the transition along an edge, rather than cut a sharp, straight transitional edge.
 
 ```js
-chamfer(solid: Solid, length: number, tags: [EdgeReference], tag?: TagDeclarator) -> Solid
+chamfer(
+  solid: Solid,
+  length: number,
+  tags: [EdgeReference],
+  tag?: TagDeclarator,
+) -> Solid
 ```
 
 

docs/kcl/circle.md

@@ -9,7 +9,11 @@ Construct a 2-dimensional circle, of the specified radius, centered at
 the provided (x, y) origin point.
 
 ```js
-circle(data: CircleData, sketchSurfaceOrGroup: SketchOrSurface, tag?: TagDeclarator) -> Sketch
+circle(
+  data: CircleData,
+  sketchSurfaceOrGroup: SketchOrSurface,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 

docs/kcl/circleThreePoint.md

@@ -9,7 +9,13 @@ Construct a circle derived from 3 points.
 
 
 ```js
-circleThreePoint(p1: [number], p2: [number], p3: [number], sketchSurfaceOrGroup: SketchOrSurface, tag?: TagDeclarator) -> Sketch
+circleThreePoint(
+  p1: [number],
+  p2: [number],
+  p3: [number],
+  sketchSurfaceOrGroup: SketchOrSurface,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 

docs/kcl/const_HALF_TURN.md

@@ -1,15 +0,0 @@
----
-title: "HALF_TURN"
-excerpt: ""
-layout: manual
----
-
-
-
-
-
-```js
-HALF_TURN: number(deg) = 180deg
-```
-
-

docs/kcl/const_QUARTER_TURN.md

@@ -1,15 +0,0 @@
----
-title: "QUARTER_TURN"
-excerpt: ""
-layout: manual
----
-
-
-
-
-
-```js
-QUARTER_TURN: number(deg) = 90deg
-```
-
-

docs/kcl/const_THREE_QUARTER_TURN.md

@@ -1,15 +0,0 @@
----
-title: "THREE_QUARTER_TURN"
-excerpt: ""
-layout: manual
----
-
-
-
-
-
-```js
-THREE_QUARTER_TURN: number(deg) = 270deg
-```
-
-

docs/kcl/const_std-XY.md

@@ -1,5 +1,5 @@
 ---
-title: "ZERO"
+title: "std::XY"
 excerpt: ""
 layout: manual
 ---
@@ -9,7 +9,7 @@ layout: manual
 
 
 ```js
-ZERO: number = 0
+std::XY
 ```
 
 

docs/kcl/const_std-XZ.md

@@ -1,5 +1,5 @@
 ---
-title: "ZERO"
+title: "std::XZ"
 excerpt: ""
 layout: manual
 ---
@@ -9,7 +9,7 @@ layout: manual
 
 
 ```js
-ZERO: number = 0
+std::XZ
 ```
 
 

docs/kcl/const_std-YZ.md

@@ -1,5 +1,5 @@
 ---
-title: "HALF_TURN"
+title: "std::YZ"
 excerpt: ""
 layout: manual
 ---
@@ -9,7 +9,7 @@ layout: manual
 
 
 ```js
-HALF_TURN: number(deg) = 180deg
+std::YZ
 ```
 
 

docs/kcl/extrude.md

@@ -9,7 +9,10 @@ Extend a 2-dimensional sketch through a third dimension in order to
 create new 3-dimensional volume, or if extruded into an existing volume, cut into an existing solid.
 
 ```js
-extrude(sketchSet: SketchSet, length: number) -> SolidSet
+extrude(
+  sketchSet: SketchSet,
+  length: number,
+) -> SolidSet
 ```
 
 

docs/kcl/fillet.md

@@ -9,7 +9,13 @@ Blend a transitional edge along a tagged path, smoothing the sharp edge.
 Fillet is similar in function and use to a chamfer, except a chamfer will cut a sharp transition along an edge while fillet will smoothly blend the transition.
 
 ```js
-fillet(solid: Solid, radius: number, tags: [EdgeReference], tolerance?: number, tag?: TagDeclarator) -> Solid
+fillet(
+  solid: Solid,
+  radius: number,
+  tags: [EdgeReference],
+  tolerance?: number,
+  tag?: TagDeclarator,
+) -> Solid
 ```
 
 

docs/kcl/helix.md

@@ -9,7 +9,14 @@ Create a helix.
 
 
 ```js
-helix(revolutions: number, angleStart: number, ccw?: bool, radius: number, axis: Axis3dOrEdgeReference, length?: number) -> HelixValue
+helix(
+  revolutions: number,
+  angleStart: number,
+  ccw?: bool,
+  radius: number,
+  axis: Axis3dOrEdgeReference,
+  length?: number,
+) -> HelixValue
 ```
 
 

docs/kcl/helixRevolutions.md

@@ -9,7 +9,10 @@ Create a helix on a cylinder.
 
 
 ```js
-helixRevolutions(data: HelixRevolutionsData, solid: Solid) -> Solid
+helixRevolutions(
+  data: HelixRevolutionsData,
+  solid: Solid,
+) -> Solid
 ```
 
 

docs/kcl/hole.md

@@ -9,7 +9,10 @@ Use a 2-dimensional sketch to cut a hole in another 2-dimensional sketch.
 
 
 ```js
-hole(holeSketch: SketchSet, sketch: Sketch) -> Sketch
+hole(
+  holeSketch: SketchSet,
+  sketch: Sketch,
+) -> Sketch
 ```
 
 
@@ -28,7 +31,7 @@ hole(holeSketch: SketchSet, sketch: Sketch) -> Sketch
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XY')
+exampleSketch = startSketchOn(XY)
   |> startProfileAt([0, 0], %)
   |> line(end = [0, 5])
   |> line(end = [5, 0])
@@ -44,7 +47,7 @@ example = extrude(exampleSketch, length = 1)
 
 ```js
 fn squareHoleSketch() {
-  squareSketch = startSketchOn('-XZ')
+  squareSketch = startSketchOn(-XZ)
     |> startProfileAt([-1, -1], %)
     |> line(end = [2, 0])
     |> line(end = [0, 2])
@@ -53,7 +56,7 @@ fn squareHoleSketch() {
   return squareSketch
 }
 
-exampleSketch = startSketchOn('-XZ')
+exampleSketch = startSketchOn(-XZ)
   |> circle({ center = [0, 0], radius = 3 }, %)
   |> hole(squareHoleSketch(), %)
 example = extrude(exampleSketch, length = 1)

docs/kcl/hollow.md

@@ -9,7 +9,10 @@ Make the inside of a 3D object hollow.
 Remove volume from a 3-dimensional shape such that a wall of the provided thickness remains around the exterior of the shape.
 
 ```js
-hollow(thickness: number, solid: Solid) -> Solid
+hollow(
+  thickness: number,
+  solid: Solid,
+) -> Solid
 ```
 
 

docs/kcl/import.md

@@ -15,7 +15,10 @@ For formats lacking unit data (such as STL, OBJ, or PLY files), the default unit
 Note: The import command currently only works when using the native Modeling App.
 
 ```js
-import(filePath: String, options?: ImportFormat) -> ImportedGeometry
+import(
+  filePath: String,
+  options?: ImportFormat,
+) -> ImportedGeometry
 ```
 
 

docs/kcl/index.md

@@ -6,13 +6,22 @@ layout: manual
 
 ## Table of Contents
 
-* [Types](kcl/types)
-* [Modules](kcl/modules)
-* [Known Issues](kcl/KNOWN-ISSUES)
+### Language
+
+* [`Types`](kcl/types)
+* [`Modules`](kcl/modules)
+* [`Settings`](kcl/settings)
+* [`Known Issues`](kcl/known-issues)
+
+### Standard library
+
 * **`std`**
   * [`HALF_TURN`](kcl/const_std-HALF_TURN)
   * [`QUARTER_TURN`](kcl/const_std-QUARTER_TURN)
   * [`THREE_QUARTER_TURN`](kcl/const_std-THREE_QUARTER_TURN)
+  * [`XY`](kcl/const_std-XY)
+  * [`XZ`](kcl/const_std-XZ)
+  * [`YZ`](kcl/const_std-YZ)
   * [`ZERO`](kcl/const_std-ZERO)
   * [`abs`](kcl/abs)
   * [`acos`](kcl/acos)
@@ -90,7 +99,9 @@ layout: manual
   * [`reduce`](kcl/reduce)
   * [`rem`](kcl/rem)
   * [`revolve`](kcl/revolve)
+  * [`rotate`](kcl/rotate)
   * [`round`](kcl/round)
+  * [`scale`](kcl/scale)
   * [`segAng`](kcl/segAng)
   * [`segEnd`](kcl/segEnd)
   * [`segEndX`](kcl/segEndX)
@@ -110,6 +121,7 @@ layout: manual
   * [`tangentialArcToRelative`](kcl/tangentialArcToRelative)
   * [`toDegrees`](kcl/toDegrees)
   * [`toRadians`](kcl/toRadians)
+  * [`translate`](kcl/translate)
   * [`xLine`](kcl/xLine)
   * [`xLineTo`](kcl/xLineTo)
   * [`yLine`](kcl/yLine)

docs/kcl/legAngX.md

@@ -9,7 +9,10 @@ Compute the angle of the given leg for x.
 
 
 ```js
-legAngX(hypotenuse: number, leg: number) -> number
+legAngX(
+  hypotenuse: number,
+  leg: number,
+) -> number
 ```
 
 ### Tags

docs/kcl/legAngY.md

@@ -9,7 +9,10 @@ Compute the angle of the given leg for y.
 
 
 ```js
-legAngY(hypotenuse: number, leg: number) -> number
+legAngY(
+  hypotenuse: number,
+  leg: number,
+) -> number
 ```
 
 ### Tags

docs/kcl/legLen.md

@@ -9,7 +9,10 @@ Compute the length of the given leg.
 
 
 ```js
-legLen(hypotenuse: number, leg: number) -> number
+legLen(
+  hypotenuse: number,
+  leg: number,
+) -> number
 ```
 
 ### Tags

docs/kcl/line.md

@@ -9,7 +9,12 @@ Extend the current sketch with a new straight line.
 
 
 ```js
-line(sketch: Sketch, endAbsolute?: [number], end?: [number], tag?: TagDeclarator) -> Sketch
+line(
+  sketch: Sketch,
+  endAbsolute?: [number],
+  end?: [number],
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -30,7 +35,7 @@ line(sketch: Sketch, endAbsolute?: [number], end?: [number], tag?: TagDeclarator
 ### Examples
 
 ```js
-triangle = startSketchOn("XZ")
+triangle = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   // The 'end' argument means it ends at exactly [10, 0].
   // This is an absolute measurement, it is NOT relative to
@@ -41,7 +46,7 @@ triangle = startSketchOn("XZ")
   |> close()
   |> extrude(length = 5)
 
-box = startSketchOn("XZ")
+box = startSketchOn(XZ)
   |> startProfileAt([10, 10], %)
   // The 'to' argument means move the pen this much.
   // So, [10, 0] is a relative distance away from the current point.

docs/kcl/loft.md

@@ -9,7 +9,13 @@ Create a 3D surface or solid by interpolating between two or more sketches.
 The sketches need to closed and on the same plane.
 
 ```js
-loft(sketches: [Sketch], vDegree: NonZeroU32, bezApproximateRational: bool, baseCurveIndex?: integer, tolerance?: number) -> Solid
+loft(
+  sketches: [Sketch],
+  vDegree: NonZeroU32,
+  bezApproximateRational: bool,
+  baseCurveIndex?: integer,
+  tolerance?: number,
+) -> Solid
 ```
 
 

docs/kcl/log.md

@@ -9,7 +9,10 @@ Compute the logarithm of the number with respect to an arbitrary base.
 The result might not be correctly rounded owing to implementation details; `log2()` can produce more accurate results for base 2, and `log10()` can produce more accurate results for base 10.
 
 ```js
-log(num: number, base: number) -> number
+log(
+  num: number,
+  base: number,
+) -> number
 ```
 
 ### Tags

docs/kcl/map.md

@@ -9,7 +9,10 @@ Apply a function to every element of a list.
 Given a list like `[a, b, c]`, and a function like `f`, returns `[f(a), f(b), f(c)]`
 
 ```js
-map(array: [KclValue], mapFn: FunctionSource) -> [KclValue]
+map(
+  array: [KclValue],
+  mapFn: FunctionSource,
+) -> [KclValue]
 ```
 
 

docs/kcl/mirror2d.md

@@ -11,7 +11,10 @@ Only works on unclosed sketches for now.
 Mirror occurs around a local sketch axis rather than a global axis.
 
 ```js
-mirror2d(data: Mirror2dData, sketchSet: SketchSet) -> [Sketch]
+mirror2d(
+  data: Mirror2dData,
+  sketchSet: SketchSet,
+) -> [Sketch]
 ```
 
 

docs/kcl/modules.md

@@ -20,7 +20,7 @@ export fn increment(x) {
 Other files in the project can now import functions that have been exported.
 This makes them available to use in another file.
 
-```
+```norun
 // main.kcl
 import increment from "util.kcl"
 
@@ -48,13 +48,13 @@ export fn decrement(x) {
 
 When importing, you can import multiple functions at once.
 
-```
+```norun
 import increment, decrement from "util.kcl"
 ```
 
 Imported symbols can be renamed for convenience or to avoid name collisions.
 
-```
+```norun
 import increment as inc, decrement as dec from "util.kcl"
 ```
 
@@ -63,13 +63,13 @@ import increment as inc, decrement as dec from "util.kcl"
 `import` can also be used to import files from other CAD systems. The format of the statement is the
 same as for KCL files. You can only import the whole file, not items from it. E.g.,
 
-```
+```norun
 import "tests/inputs/cube.obj"
 
 // Use `cube` just like a KCL object.
 ```
 
-```
+```norun
 import "tests/inputs/cube-2.sldprt" as cube
 
 // Use `cube` just like a KCL object.
@@ -78,7 +78,7 @@ import "tests/inputs/cube-2.sldprt" as cube
 You can make the file format explicit using a format attribute (useful if using a different
 extension), e.g.,
 
-```
+```norun
 @(format = obj)
 import "tests/inputs/cube"
 ```
@@ -87,7 +87,7 @@ For formats lacking unit data (such as STL, OBJ, or PLY files), the default
 unit of measurement is millimeters. Alternatively you may specify the unit
 by using an attirbute. Likewise, you can also specify a coordinate system. E.g.,
 
-```
+```norun
 @(unitLength = ft, coords = opengl)
 import "tests/inputs/cube.obj"
 ```

docs/kcl/offsetPlane.md

@@ -9,7 +9,10 @@ Offset a plane by a distance along its normal.
 For example, if you offset the 'XZ' plane by 10, the new plane will be parallel to the 'XZ' plane and 10 units away from it.
 
 ```js
-offsetPlane(plane: PlaneData, offset: number) -> Plane
+offsetPlane(
+  plane: PlaneData,
+  offset: number,
+) -> Plane
 ```
 
 

docs/kcl/patternCircular2d.md

@@ -9,7 +9,14 @@ Repeat a 2-dimensional sketch some number of times along a partial or
 complete circle some specified number of times. Each object may additionally be rotated along the circle, ensuring orentation of the solid with respect to the center of the circle is maintained.
 
 ```js
-patternCircular2d(sketchSet: SketchSet, instances: integer, center: [number], arcDegrees: number, rotateDuplicates: bool, useOriginal?: bool) -> [Sketch]
+patternCircular2d(
+  sketchSet: SketchSet,
+  instances: integer,
+  center: [number],
+  arcDegrees: number,
+  rotateDuplicates: bool,
+  useOriginal?: bool,
+) -> [Sketch]
 ```
 
 

docs/kcl/patternLinear2d.md

@@ -9,7 +9,13 @@ Repeat a 2-dimensional sketch along some dimension, with a dynamic amount
 of distance between each repetition, some specified number of times.
 
 ```js
-patternLinear2d(sketchSet: SketchSet, instances: integer, distance: number, axis: [number], useOriginal?: bool) -> [Sketch]
+patternLinear2d(
+  sketchSet: SketchSet,
+  instances: integer,
+  distance: number,
+  axis: [number],
+  useOriginal?: bool,
+) -> [Sketch]
 ```
 
 

docs/kcl/patternTransform.md

@@ -35,7 +35,12 @@ The transform function returns a transform object. All properties of the object
    - `rotation.origin` (either "local" i.e. rotate around its own center, "global" i.e. rotate around the scene's center, or a 3D point, defaults to "local")
 
 ```js
-patternTransform(solidSet: SolidSet, instances: integer, transform: FunctionSource, useOriginal?: bool) -> [Solid]
+patternTransform(
+  solidSet: SolidSet,
+  instances: integer,
+  transform: FunctionSource,
+  useOriginal?: bool,
+) -> [Solid]
 ```
 
 

docs/kcl/patternTransform2d.md

@@ -9,7 +9,12 @@ Just like patternTransform, but works on 2D sketches not 3D solids.
 
 
 ```js
-patternTransform2d(sketchSet: SketchSet, instances: integer, transform: FunctionSource, useOriginal?: bool) -> [Sketch]
+patternTransform2d(
+  sketchSet: SketchSet,
+  instances: integer,
+  transform: FunctionSource,
+  useOriginal?: bool,
+) -> [Sketch]
 ```
 
 

docs/kcl/polygon.md

@@ -9,7 +9,11 @@ Create a regular polygon with the specified number of sides that is either inscr
 
 
 ```js
-polygon(data: PolygonData, sketchSurfaceOrGroup: SketchOrSurface, tag?: TagDeclarator) -> Sketch
+polygon(
+  data: PolygonData,
+  sketchSurfaceOrGroup: SketchOrSurface,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 

docs/kcl/pow.md

@@ -9,7 +9,10 @@ Compute the number to a power.
 
 
 ```js
-pow(num: number, pow: number) -> number
+pow(
+  num: number,
+  pow: number,
+) -> number
 ```
 
 ### Tags

docs/kcl/profileStart.md

@@ -27,7 +27,7 @@ profileStart(sketch: Sketch) -> [number]
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XY')
+sketch001 = startSketchOn(XY)
   |> startProfileAt([5, 2], %)
   |> angledLine({ angle = 120, length = 50 }, %, $seg01)
   |> angledLine({

docs/kcl/profileStartX.md

@@ -27,7 +27,7 @@ profileStartX(sketch: Sketch) -> number
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XY')
+sketch001 = startSketchOn(XY)
   |> startProfileAt([5, 2], %)
   |> angledLine([-26.6, 50], %)
   |> angledLine([90, 50], %)

docs/kcl/profileStartY.md

@@ -27,7 +27,7 @@ profileStartY(sketch: Sketch) -> number
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XY')
+sketch001 = startSketchOn(XY)
   |> startProfileAt([5, 2], %)
   |> angledLine({ angle = -60, length = 14 }, %)
   |> angledLineToY({ angle = 30, to = profileStartY(%) }, %)

docs/kcl/push.md

@@ -9,7 +9,10 @@ Append an element to the end of an array.
 Returns a new array with the element appended.
 
 ```js
-push(array: [KclValue], elem: KclValue) -> KclValue
+push(
+  array: [KclValue],
+  elem: KclValue,
+) -> KclValue
 ```
 
 

docs/kcl/reduce.md

@@ -9,7 +9,11 @@ Take a starting value. Then, for each element of an array, calculate the next va
 using the previous value and the element.
 
 ```js
-reduce(array: [KclValue], start: KclValue, reduceFn: FunctionSource) -> KclValue
+reduce(
+  array: [KclValue],
+  start: KclValue,
+  reduceFn: FunctionSource,
+) -> KclValue
 ```
 
 

docs/kcl/rem.md

@@ -9,7 +9,10 @@ Compute the remainder after dividing `num` by `div`.
 If `num` is negative, the result will be too.
 
 ```js
-rem(num: number, divisor: number) -> number
+rem(
+  num: number,
+  divisor: number,
+) -> number
 ```
 
 ### Tags

docs/kcl/revolve.md

@@ -11,7 +11,10 @@ This, like extrude, is able to create a 3-dimensional solid from a 2-dimensional
 Revolve occurs around a local sketch axis rather than a global axis.
 
 ```js
-revolve(data: RevolveData, sketch: Sketch) -> Solid
+revolve(
+  data: RevolveData,
+  sketch: Sketch,
+) -> Solid
 ```
 
 

docs/kcl/settings.md

@@ -0,0 +1,30 @@
+---
+title: "KCL settings"
+excerpt: "Documentation of settings for the KCL language and Zoo Modeling App."
+layout: manual
+---
+
+# Per-file settings
+
+Settings which affect a single file are configured using the settings attribute.
+This must be at the top of the KCL file (comments before the attribute are permitted).
+E.g.,
+
+```
+// The settings attribute.
+@settings(defaultLengthUnit = in)
+
+// The rest of your KCL code goes below...
+
+x = 42 // Represents 42 inches.
+```
+
+The settings attribute may contain multiple properties separated by commas.
+Valid properties are:
+
+- `defaultLengthUnit`: the default length unit to use for numbers declared in this file.
+  - Accepted values: `mm`, `cm`, `m`, `in` (inches), `ft` (feet), `yd` (yards).
+- `defaultAngleUnit`: the default angle unit to use for numbers declared in this file.
+  - Accepted values: `deg` (degrees), `rad` (radians).
+
+These settings override any project-wide settings (configured in project.toml or via the UI).

docs/kcl/shell.md

@@ -9,7 +9,11 @@ Remove volume from a 3-dimensional shape such that a wall of the
 provided thickness remains, taking volume starting at the provided face, leaving it open in that direction.
 
 ```js
-shell(solidSet: SolidSet, thickness: number, faces: [FaceTag]) -> SolidSet
+shell(
+  solidSet: SolidSet,
+  thickness: number,
+  faces: [FaceTag],
+) -> SolidSet
 ```
 
 

docs/kcl/tangentialArc.md

@@ -9,7 +9,11 @@ Draw a curved line segment along part of an imaginary circle.
 The arc is constructed such that the last line segment is placed tangent to the imaginary circle of the specified radius. The resulting arc is the segment of the imaginary circle from that tangent point for 'offset' degrees along the imaginary circle.
 
 ```js
-tangentialArc(data: TangentialArcData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+tangentialArc(
+  data: TangentialArcData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ tangentialArc(data: TangentialArcData, sketch: Sketch, tag?: TagDeclarator) -> S
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({ angle = 60, length = 10 }, %)
   |> tangentialArc({ radius = 10, offset = -120 }, %)

docs/kcl/tangentialArcTo.md

@@ -9,7 +9,11 @@ Starting at the current sketch's origin, draw a curved line segment along
 some part of an imaginary circle until it reaches the desired (x, y) coordinates.
 
 ```js
-tangentialArcTo(to: [number], sketch: Sketch, tag?: TagDeclarator) -> Sketch
+tangentialArcTo(
+  to: [number],
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ tangentialArcTo(to: [number], sketch: Sketch, tag?: TagDeclarator) -> Sketch
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({ angle = 60, length = 10 }, %)
   |> tangentialArcTo([15, 15], %)

docs/kcl/tangentialArcToRelative.md

@@ -9,7 +9,11 @@ Starting at the current sketch's origin, draw a curved line segment along
 some part of an imaginary circle until it reaches a point the given (x, y) distance away.
 
 ```js
-tangentialArcToRelative(delta: [number], sketch: Sketch, tag?: TagDeclarator) -> Sketch
+tangentialArcToRelative(
+  delta: [number],
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ tangentialArcToRelative(delta: [number], sketch: Sketch, tag?: TagDeclarator) ->
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({ angle = 45, length = 10 }, %)
   |> tangentialArcToRelative([0, -10], %)

docs/kcl/types.md

@@ -74,18 +74,15 @@ fn myFn(x) {
 
 As you can see above `myFn` just returns whatever it is given.
 
-KCL's early drafts used positional arguments, but we now use keyword arguments. If you declare a
-function like this:
+KCL's early drafts used positional arguments, but we now use keyword arguments:
 
 ```
+// If you declare a function like this
 fn add(left, right) {
   return left + right
 }
-```
 
-You can call it like this:
-
-```
+// You can call it like this:
 total = add(left = 1, right = 2)
 ```
 
@@ -111,14 +108,14 @@ three = add(1, delta = 2)
 
 It can be hard to read repeated function calls, because of all the nested brackets.
 
-```
+```norun
 i = 1
 x = h(g(f(i)))
 ```
 
 You can make this easier to read by breaking it into many declarations, but that is a bit annoying.
 
-```
+```norun
 i  = 1
 x0 = f(i)
 x1 = g(x0)
@@ -133,12 +130,12 @@ the `%` in the right-hand side.
 So, this means `x |> f(%) |> g(%)` is shorthand for `g(f(x))`. The code example above, with its
 somewhat-clunky `x0` and `x1` constants could be rewritten as
 
-```
+```norun
 i = 1
 x = i
-|> f(%)
-|> g(%)
-|> h(%)
+  |> f(%)
+  |> g(%)
+  |> h(%)
 ```
 
 This helps keep your code neat and avoid unnecessary declarations.
@@ -147,12 +144,12 @@ This helps keep your code neat and avoid unnecessary declarations.
 
 Say you have a long pipeline of sketch functions, like this:
 
-```
-startSketch()
-|> line(%, end = [3, 4])
-|> line(%, end = [10, 10])
-|> line(%, end = [-13, -14])
-|> close(%)
+```norun
+startSketchOn('XZ')
+  |> line(%, end = [3, 4])
+  |> line(%, end = [10, 10])
+  |> line(%, end = [-13, -14])
+  |> close(%)
 ```
 
 In this example, each function call outputs a sketch, and it gets put into the next function call via
@@ -162,12 +159,12 @@ If a function call uses an unlabeled first parameter, it will default to `%` if
 means that `|> line(%, end = [3, 4])` and `|> line(end = [3, 4])` are equivalent! So the above
 could be rewritten as 
 
-```
-startSketch()
-|> line(end = [3, 4])
-|> line(end = [10, 10])
-|> line(end = [-13, -14])
-|> close()
+```norun
+startSketchOn('XZ')
+ |> line(end = [3, 4])
+ |> line(end = [10, 10])
+ |> line(end = [-13, -14])
+ |> close()
 ```
 
 Note that we are still in the process of migrating KCL's standard library to use keyword arguments. So some
@@ -184,7 +181,7 @@ Tags are used to give a name (tag) to a specific path.
 The syntax for declaring a tag is `$myTag` you would use it in the following
 way:
 
-```
+```norun
 startSketchOn('XZ')
   |> startProfileAt(origin, %)
   |> angledLine({angle = 0, length = 191.26}, %, $rectangleSegmentA001)
@@ -216,7 +213,7 @@ use the tag `rectangleSegmentA001` in any function or expression in the file.
 
 However if the code was written like this:
 
-```
+```norun
 fn rect(origin) {
   return startSketchOn('XZ')
     |> startProfileAt(origin, %)
@@ -244,7 +241,7 @@ However you likely want to use those tags somewhere outside the `rect` function.
 Tags are accessible through the sketch group they are declared in.
 For example the following code works.
 
-```
+```norun
 fn rect(origin) {
   return startSketchOn('XZ')
     |> startProfileAt(origin, %)

docs/kcl/types/PlaneType.md

@@ -34,6 +34,18 @@ A custom plane.
 
 
 
+----
+A custom plane which has not been sent to the engine. It must be sent before it is used.
+
+**enum:** `Uninit`
+
+
+
+
+
+
+
+
 ----
 
 

docs/kcl/xLine.md

@@ -9,7 +9,11 @@ Draw a line relative to the current origin to a specified distance away
 from the current position along the 'x' axis.
 
 ```js
-xLine(length: number, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+xLine(
+  length: number,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ xLine(length: number, sketch: Sketch, tag?: TagDeclarator) -> Sketch
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> xLine(15, %)
   |> angledLine({ angle = 80, length = 15 }, %)

docs/kcl/xLineTo.md

@@ -9,7 +9,11 @@ Draw a line parallel to the X axis, that ends at the given X.
 E.g. if the previous line ended at (1, 1), then xLineTo(4) draws a line from (1, 1) to (4, 1)
 
 ```js
-xLineTo(to: number, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+xLineTo(
+  to: number,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ xLineTo(to: number, sketch: Sketch, tag?: TagDeclarator) -> Sketch
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> xLineTo(15, %)
   |> angledLine({ angle = 80, length = 15 }, %)

docs/kcl/yLine.md

@@ -9,7 +9,11 @@ Draw a line relative to the current origin to a specified distance away
 from the current position along the 'y' axis.
 
 ```js
-yLine(length: number, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+yLine(
+  length: number,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ yLine(length: number, sketch: Sketch, tag?: TagDeclarator) -> Sketch
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> yLine(15, %)
   |> angledLine({ angle = 30, length = 15 }, %)

docs/kcl/yLineTo.md

@@ -9,7 +9,11 @@ Draw a line parallel to the Y axis, that ends at the given Y.
 E.g. if the previous line ended at (1, 1), then yLineTo(4) draws a line from (1, 1) to (1, 4)
 
 ```js
-yLineTo(to: number, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+yLineTo(
+  to: number,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ yLineTo(to: number, sketch: Sketch, tag?: TagDeclarator) -> Sketch
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({ angle = 50, length = 45 }, %)
   |> yLineTo(0, %)

e2e/playwright/command-bar-tests.spec.ts

@@ -125,6 +125,12 @@ test.describe('Command bar tests', { tag: ['@skipWin'] }, () => {
     await expect(cmdSearchBar).toBeVisible()
     await expect(cmdSearchBar).toBeFocused()
 
+    await test.step(`Pressing backspace in the command selection step does not dismiss`, async () => {
+      await page.keyboard.press('Backspace')
+      await expect(cmdSearchBar).toBeVisible()
+      await expect(cmdSearchBar).toBeFocused()
+    })
+
     // Try typing in the command bar
     await cmdSearchBar.fill(commandName)
     await expect(commandOption).toBeVisible()

e2e/playwright/fixtures/cmdBarFixture.ts

@@ -1,5 +1,7 @@
-import type { Page, Locator } from '@playwright/test'
-import { expect } from '@playwright/test'
+import type { Page, Locator, Route, Request } from '@playwright/test'
+import { expect, TestInfo } from '@playwright/test'
+import * as fs from 'fs'
+import * as path from 'path'
 
 type CmdBarSerialised =
   | {
@@ -187,4 +189,71 @@ export class CmdBarFixture {
   selectOption = (options: Parameters<typeof this.page.getByRole>[1]) => {
     return this.page.getByRole('option', options)
   }
+
+  /**
+   * Captures a snapshot of the request sent to the text-to-cad API endpoint
+   * and saves it to a file named after the current test.
+   *
+   * The snapshot file will be saved in the specified directory with a filename
+   * derived from the test's full path (including describe blocks).
+   *
+   * @param testInfoInOrderToGetTestTitle The TestInfo object from the test context
+   * @param customOutputDir Optional custom directory for the output file
+   */
+  async captureTextToCadRequestSnapshot(
+    testInfoInOrderToGetTestTitle: TestInfo,
+    customOutputDir = 'e2e/playwright/snapshots/prompt-to-edit'
+  ) {
+    // First sanitize each title component individually
+    const sanitizedTitleComponents = [
+      ...testInfoInOrderToGetTestTitle.titlePath.slice(0, -1), // Get all parent titles
+      testInfoInOrderToGetTestTitle.title, // Add the test title
+    ].map(
+      (component) =>
+        component
+          .replace(/[^a-z0-9]/gi, '-') // Replace non-alphanumeric chars with hyphens
+          .toLowerCase()
+          .replace(/-+/g, '-') // Replace multiple consecutive hyphens with a single one
+          .replace(/^-|-$/g, '') // Remove leading/trailing hyphens
+    )
+
+    // Join the sanitized components with -- as a clear separator
+    const sanitizedTestName = sanitizedTitleComponents.join('--')
+
+    // Create the output path
+    const outputPath = path.join(
+      customOutputDir,
+      `${sanitizedTestName}.snap.json`
+    )
+
+    // Create a handler function that saves request bodies to a file
+    const requestHandler = (route: Route, request: Request) => {
+      try {
+        const requestBody = request.postDataJSON()
+
+        // Ensure directory exists
+        const dir = path.dirname(outputPath)
+        if (!fs.existsSync(dir)) {
+          fs.mkdirSync(dir, { recursive: true })
+        }
+
+        // Write the request body to the file
+        fs.writeFileSync(outputPath, JSON.stringify(requestBody, null, 2))
+
+        console.log(`Saved text-to-cad API request to: ${outputPath}`)
+      } catch (error) {
+        console.error('Error processing text-to-cad request:', error)
+      }
+
+      // Use void to explicitly mark the promise as ignored
+      void route.continue()
+    }
+
+    // Start monitoring requests
+    await this.page.route('**/ml/text-to-cad/iteration', requestHandler)
+
+    console.log(
+      `Monitoring text-to-cad API requests. Output will be saved to: ${outputPath}`
+    )
+  }
 }

e2e/playwright/fixtures/editorFixture.ts

@@ -171,4 +171,22 @@ export class EditorFixture {
       { text, placeCursor }
     )
   }
+  async selectText(text: string) {
+    // First make sure the code pane is open
+    const wasPaneOpen = await this.checkIfPaneIsOpen()
+    if (!wasPaneOpen) {
+      await this.openPane()
+    }
+
+    // Use Playwright's built-in text selection on the code content
+    // it seems to only select whole divs, which works out to align with syntax highlighting
+    // for code mirror, so you can probably select "sketch002 = startSketchOn('XZ')"
+    // but less so for exactly "sketch002 = startS"
+    await this.codeContent.getByText(text).first().selectText()
+
+    // Reset pane state if needed
+    if (!wasPaneOpen) {
+      await this.closePane()
+    }
+  }
 }

e2e/playwright/point-click.spec.ts

@@ -9,7 +9,7 @@ import { Locator } from '@playwright/test'
 
 // test file is for testing point an click code gen functionality that's not sketch mode related
 
-test.describe('Point-and-click tests', { tag: ['@skipWin'] }, () => {
+test.describe('Point-and-click tests', () => {
   test('verify extruding circle works', async ({
     context,
     homePage,

e2e/playwright/prompt-to-edit-snapshot-tests.spec.ts

@@ -0,0 +1,98 @@
+import { test, expect } from './zoo-test'
+/* eslint-disable jest/no-conditional-expect */
+
+/**
+ * Snapshot Tests for Text-to-CAD API Requests
+ *
+ * These tests are primarily designed to capture the requests sent to the Text-to-CAD API
+ * rather than to verify application behavior. Unlike regular tests, these tests:
+ *
+ * 1. Don't assert much about the application's response or state changes
+ * 2. Focus on setting up specific scenarios and triggering API requests
+ * 3. Use the captureTextToCadRequestSnapshot() method to save request payloads to snapshot files
+ *
+ * The main purpose is to maintain a collection of real-world API request examples that can be:
+ * - Used for regression testing the (AI) API
+ * - Referenced when making changes to the Text-to-CAD integration, particularly the meta-prompts
+ *   the frontend adds to the user's prompt
+ *
+ * These tests intentionally don't wait for or verify responses, as we're primarily
+ * interested in capturing the outgoing requests for documentation and analysis.
+ *
+ */
+
+const file = `sketch001 = startSketchOn('XZ')
+profile001 = startProfileAt([57.81, 250.51], sketch001)
+  |> line(end = [121.13, 56.63], tag = $seg02)
+  |> line(end = [83.37, -34.61], tag = $seg01)
+  |> line(end = [19.66, -116.4])
+  |> line(end = [-221.8, -41.69])
+  |> line(endAbsolute = [profileStartX(%), profileStartY(%)])
+  |> close()
+extrude001 = extrude(profile001, length = 200)
+sketch002 = startSketchOn('XZ')
+  |> startProfileAt([-73.64, -42.89], %)
+  |> xLine(173.71, %)
+  |> line(end = [-22.12, -94.4])
+  |> xLine(-156.98, %)
+  |> line(endAbsolute = [profileStartX(%), profileStartY(%)])
+  |> close()
+extrude002 = extrude(sketch002, length = 50)
+sketch003 = startSketchOn('XY')
+  |> startProfileAt([52.92, 157.81], %)
+  |> angledLine([0, 176.4], %, $rectangleSegmentA001)
+  |> angledLine([
+       segAng(rectangleSegmentA001) - 90,
+       53.4
+     ], %, $rectangleSegmentB001)
+  |> angledLine([
+       segAng(rectangleSegmentA001),
+       -segLen(rectangleSegmentA001)
+     ], %, $rectangleSegmentC001)
+  |> line(endAbsolute = [profileStartX(%), profileStartY(%)])
+  |> close()
+extrude003 = extrude(sketch003, length = 20)
+`
+
+test(
+  `change colour`,
+  { tag: '@snapshot' },
+  async ({ context, homePage, cmdBar, editor, page, scene }) => {
+    await context.addInitScript((file) => {
+      localStorage.setItem('persistCode', file)
+    }, file)
+    await homePage.goToModelingScene()
+    await scene.waitForExecutionDone()
+
+    const body1CapCoords = { x: 571, y: 351 }
+    const [clickBody1Cap] = scene.makeMouseHelpers(
+      body1CapCoords.x,
+      body1CapCoords.y
+    )
+    const yellow: [number, number, number] = [179, 179, 131]
+    const submittingToast = page.getByText('Submitting to Text-to-CAD API...')
+
+    await test.step('wait for scene to load select body and check selection came through', async () => {
+      await scene.expectPixelColor([134, 134, 134], body1CapCoords, 15)
+      await clickBody1Cap()
+      await scene.expectPixelColor(yellow, body1CapCoords, 20)
+      await editor.expectState({
+        highlightedCode: '',
+        activeLines: ['|>startProfileAt([-73.64,-42.89],%)'],
+        diagnostics: [],
+      })
+    })
+
+    await test.step('fire off edit prompt', async () => {
+      await cmdBar.captureTextToCadRequestSnapshot(test.info())
+      await cmdBar.openCmdBar('promptToEdit')
+      // being specific about the color with a hex means asserting pixel color is more stable
+      await page
+        .getByTestId('cmd-bar-arg-value')
+        .fill('make this neon green please, use #39FF14')
+      await page.waitForTimeout(100)
+      await cmdBar.progressCmdBar()
+      await expect(submittingToast).toBeVisible()
+    })
+  }
+)

e2e/playwright/prompt-to-edit.spec.ts

@@ -36,7 +36,7 @@ extrude003 = extrude(sketch003, length = 20)
 `
 
 test.describe('Prompt-to-edit tests', { tag: '@skipWin' }, () => {
-  test.fixme('Check the happy path, for basic changing color', () => {
+  test.describe('Check the happy path, for basic changing color', () => {
     const cases = [
       {
         desc: 'User accepts change',
@@ -70,7 +70,7 @@ test.describe('Prompt-to-edit tests', { tag: '@skipWin' }, () => {
           body1CapCoords.y
         )
         const yellow: [number, number, number] = [179, 179, 131]
-        const green: [number, number, number] = [108, 152, 75]
+        const green: [number, number, number] = [128, 194, 88]
         const notGreen: [number, number, number] = [132, 132, 132]
         const body2NotGreen: [number, number, number] = [88, 88, 88]
         const submittingToast = page.getByText(
@@ -109,7 +109,7 @@ test.describe('Prompt-to-edit tests', { tag: '@skipWin' }, () => {
         })
 
         await test.step('verify initial change', async () => {
-          await scene.expectPixelColor(green, greenCheckCoords, 15)
+          await scene.expectPixelColor(green, greenCheckCoords, 20)
           await scene.expectPixelColor(body2NotGreen, body2WallCoords, 15)
           await editor.expectEditor.toContain('appearance(')
         })
@@ -142,7 +142,7 @@ test.describe('Prompt-to-edit tests', { tag: '@skipWin' }, () => {
     }
   })
 
-  test(`bad edit prompt`, async ({
+  test('bad edit prompt', async ({
     context,
     homePage,
     cmdBar,
@@ -195,4 +195,150 @@ test.describe('Prompt-to-edit tests', { tag: '@skipWin' }, () => {
       await expect(failToast).toBeVisible()
     })
   })
+
+  test(`manual code selection rename`, async ({
+    context,
+    homePage,
+    cmdBar,
+    editor,
+    page,
+    scene,
+  }) => {
+    const body1CapCoords = { x: 571, y: 351 }
+
+    await context.addInitScript((file) => {
+      localStorage.setItem('persistCode', file)
+    }, file)
+    await homePage.goToModelingScene()
+    await scene.waitForExecutionDone()
+
+    const submittingToast = page.getByText('Submitting to Text-to-CAD API...')
+    const successToast = page.getByText('Prompt to edit successful')
+    const acceptBtn = page.getByRole('button', { name: 'checkmark Accept' })
+
+    await test.step('wait for scene to load and select code in editor', async () => {
+      // Find and select the text "sketch002" in the editor
+      await editor.selectText('sketch002')
+
+      // Verify the selection was made
+      await editor.expectState({
+        highlightedCode: '',
+        activeLines: ["sketch002 = startSketchOn('XZ')"],
+        diagnostics: [],
+      })
+    })
+
+    await test.step('fire off edit prompt', async () => {
+      await scene.expectPixelColor([134, 134, 134], body1CapCoords, 15)
+      await cmdBar.openCmdBar('promptToEdit')
+      await page
+        .getByTestId('cmd-bar-arg-value')
+        .fill('Please rename to mySketch')
+      await page.waitForTimeout(100)
+      await cmdBar.progressCmdBar()
+      await expect(submittingToast).toBeVisible()
+      await expect(submittingToast).not.toBeVisible({
+        timeout: 2 * 60_000,
+      })
+      await expect(successToast).toBeVisible()
+    })
+
+    await test.step('verify rename change and accept it', async () => {
+      await editor.expectEditor.toContain('mySketch = startSketchOn')
+      await editor.expectEditor.not.toContain('sketch002 = startSketchOn')
+      await editor.expectEditor.toContain(
+        'extrude002 = extrude(mySketch, length = 50)'
+      )
+
+      await acceptBtn.click()
+      await expect(successToast).not.toBeVisible()
+    })
+  })
+
+  test('multiple body selections', async ({
+    context,
+    homePage,
+    cmdBar,
+    editor,
+    page,
+    scene,
+  }) => {
+    const body1CapCoords = { x: 571, y: 351 }
+    const body2WallCoords = { x: 620, y: 152 }
+    const [clickBody1Cap] = scene.makeMouseHelpers(
+      body1CapCoords.x,
+      body1CapCoords.y
+    )
+    const [clickBody2Cap] = scene.makeMouseHelpers(
+      body2WallCoords.x,
+      body2WallCoords.y
+    )
+    const grey: [number, number, number] = [132, 132, 132]
+
+    await context.addInitScript((file) => {
+      localStorage.setItem('persistCode', file)
+    }, file)
+    await homePage.goToModelingScene()
+    await scene.waitForExecutionDone()
+
+    const submittingToast = page.getByText('Submitting to Text-to-CAD API...')
+    const successToast = page.getByText('Prompt to edit successful')
+    const acceptBtn = page.getByRole('button', { name: 'checkmark Accept' })
+
+    await test.step('select multiple bodies and fire prompt', async () => {
+      // Initial color check
+      await scene.expectPixelColor(grey, body1CapCoords, 15)
+
+      // Open command bar first (without selection)
+      await cmdBar.openCmdBar('promptToEdit')
+
+      // Select first body
+      await page.waitForTimeout(100)
+      await clickBody1Cap()
+
+      // Hold shift and select second body
+      await editor.expectState({
+        highlightedCode: '',
+        activeLines: ['|>startProfileAt([-73.64,-42.89],%)'],
+        diagnostics: [],
+      })
+      await page.keyboard.down('Shift')
+      await page.waitForTimeout(100)
+      await clickBody2Cap()
+      await editor.expectState({
+        highlightedCode:
+          'line(end=[121.13,56.63],tag=$seg02)extrude(profile001,length=200)',
+        activeLines: [
+          '|>line(end=[121.13,56.63],tag=$seg02)',
+          '|>startProfileAt([-73.64,-42.89],%)',
+        ],
+        diagnostics: [],
+      })
+      await page.keyboard.up('Shift')
+      await page.waitForTimeout(100)
+      await cmdBar.progressCmdBar()
+
+      // Enter prompt and submit
+      await page
+        .getByTestId('cmd-bar-arg-value')
+        .fill('make these neon green please, use #39FF14')
+      await page.waitForTimeout(100)
+      await cmdBar.progressCmdBar()
+
+      // Wait for API response
+      await expect(submittingToast).toBeVisible()
+      await expect(submittingToast).not.toBeVisible({
+        timeout: 2 * 60_000,
+      })
+      await expect(successToast).toBeVisible()
+    })
+
+    await test.step('verify code changed', async () => {
+      await editor.expectEditor.toContain('appearance(')
+
+      // Accept changes
+      await acceptBtn.click()
+      await expect(successToast).not.toBeVisible()
+    })
+  })
 })