KCL: Improve error msg format when typechecking tag declarators

* Amend project open test to show failing case

* Fix command config to use live context value

* A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubuntu-8-cores)

* Update src/lib/commandBarConfigs/projectsCommandConfig.ts

Co-authored-by: Jonathan Tran <jonnytran@gmail.com>

* A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubuntu-8-cores)

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Jonathan Tran <jonnytran@gmail.com>

.codespellrc

@@ -1,3 +1,3 @@
 [codespell]
-ignore-words-list: crate,everytime,inout,co-ordinate,ot,nwo,atleast,ue,afterall
+ignore-words-list: crate,everytime,inout,co-ordinate,ot,nwo,atleast,ue,afterall,ser
 skip: **/target,node_modules,build,dist,./out,**/Cargo.lock,./docs/kcl/*.md,.yarn.lock,**/yarn.lock,./openapi/*.json,./packages/codemirror-lang-kcl/test/all.test.ts,tsconfig.tsbuildinfo

.github/workflows/build-and-store-wasm.yml

@@ -27,7 +27,7 @@ jobs:
 
 
       # Upload the WASM bundle as an artifact
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: wasm-bundle
           path: src/wasm-lib/pkg

.github/workflows/build-apps.yml

@@ -126,7 +126,13 @@ jobs:
           node-version-file: '.nvmrc'
           cache: 'yarn' # Set this to npm, yarn or pnpm.
 
-      - run: yarn install
+      - name: yarn install
+        # Windows is picky sometimes and fails on fetch. Step takes about ~30s
+        uses: nick-fields/retry@v3.0.0
+        with:
+          timeout_minutes: 2
+          max_attempts: 3
+          command: yarn install
 
       - run: yarn tronb:vite
 

.github/workflows/cargo-bench.yml

@@ -1,44 +0,0 @@
-on:
-  push:
-    branches:
-      - main
-    paths:
-      - '**.rs'
-      - '**/Cargo.toml'
-      - '**/Cargo.lock'
-      - '**/rust-toolchain.toml'
-      - .github/workflows/cargo-bench.yml
-  pull_request:
-    paths:
-      - '**.rs'
-      - '**/Cargo.toml'
-      - '**/Cargo.lock'
-      - '**/rust-toolchain.toml'
-      - .github/workflows/cargo-bench.yml
-  workflow_dispatch:
-permissions: read-all
-concurrency:
-  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
-  cancel-in-progress: true
-name: cargo bench
-jobs:
-  cargo-bench:
-    name: Benchmark with iai
-    runs-on: ubuntu-latest-8-cores
-    steps:
-      - uses: actions/checkout@v4
-      - uses: dtolnay/rust-toolchain@stable
-      - name: Install dependencies
-        run: |
-          cargo install cargo-criterion
-          sudo apt update
-          sudo apt install -y valgrind
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2.6.1
-      - name: Benchmark kcl library
-        shell: bash
-        run: |-
-          cd src/wasm-lib/kcl; cargo bench --all-features -- iai
-        env:
-          KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
-

.github/workflows/e2e-tests.yml

@@ -126,20 +126,20 @@ jobs:
     - name: build electron
       shell: bash
       run: yarn tron:package
-    - name: Run ubuntu/chrome snapshots
+    # - name: Run ubuntu/chrome snapshots
-      if: ${{ matrix.os == 'namespace-profile-ubuntu-8-cores' && matrix.shardIndex == 1 }}
+    #   if: ${{ matrix.os == 'namespace-profile-ubuntu-8-cores' && matrix.shardIndex == 1 }}
-      shell: bash
+    #   shell: bash
-      # TODO: break this in its own job, for now it's not slowing down the overall execution as ubuntu is the quickest,
+    #   # 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.
+    #   # but we could do better. This forces a large 1/1 shard of all 20 snapshot tests that runs in about 3 minutes.
-      run: |
+    #   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  --shard=1/1
-      env:
+    #   env:
-        CI: true
+    #     CI: true
-        NODE_ENV: development
+    #     NODE_ENV: development
-        VITE_KC_DEV_TOKEN: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
+    #     VITE_KC_DEV_TOKEN: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
-        VITE_KC_SKIP_AUTH: true
+    #     VITE_KC_SKIP_AUTH: true
-        token: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
+    #     token: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
-        snapshottoken: ${{ secrets.KITTYCAD_API_TOKEN }}
+    #     snapshottoken: ${{ secrets.KITTYCAD_API_TOKEN }}
     - uses: actions/upload-artifact@v4
       if: ${{ !cancelled() && (success() || failure()) }}
       with:
@@ -162,20 +162,20 @@ jobs:
           then echo "modified=true" >> $GITHUB_OUTPUT
           else echo "modified=false" >> $GITHUB_OUTPUT
           fi
-    - name: Commit changes, if any
+    # - name: Commit changes, if any
-      if: steps.git-check.outputs.modified == 'true'
+    #   if: steps.git-check.outputs.modified == 'true'
-      shell: bash
+    #   shell: bash
-      run: |
+    #   run: |
-        git add .
+    #     git add .
-        git config --local user.email "github-actions[bot]@users.noreply.github.com"
+    #     git config --local user.email "github-actions[bot]@users.noreply.github.com"
-        git config --local user.name "github-actions[bot]"
+    #     git config --local user.name "github-actions[bot]"
-        git remote set-url origin https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git
+    #     git remote set-url origin https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git
-        git fetch origin
+    #     git fetch origin
-        echo ${{ github.head_ref }}
+    #     echo ${{ github.head_ref }}
-        git checkout ${{ github.head_ref }}
+    #     git checkout ${{ github.head_ref }}
-        git commit -am "A snapshot a day keeps the bugs away! 📷🐛 (OS: ${{matrix.os}})" || true
+    #     git commit -am "A snapshot a day keeps the bugs away! 📷🐛 (OS: ${{matrix.os}})" || true
-        git push
+    #     git push
-        git push origin ${{ github.head_ref }}
+    #     git push origin ${{ github.head_ref }}
     # only upload artifacts if there's actually changes
     - uses: actions/upload-artifact@v4
       if: steps.git-check.outputs.modified == 'true'

.gitignore

@@ -25,6 +25,7 @@ yarn-error.log*
 
 .idea
 .vscode
+.helix
 src/wasm-lib/.idea
 src/wasm-lib/.vscode
 
@@ -44,7 +45,7 @@ e2e/playwright/temp3.png
 e2e/playwright/export-snapshots/*
 !e2e/playwright/export-snapshots/*.png
 
-
+/kcl-samples
 /test-results/
 /playwright-report/
 /blob-report/

.helix/config.toml

@@ -0,0 +1,2 @@
+[editor]
+auto-format = true

.helix/languages.toml

@@ -0,0 +1,10 @@
+[language-server.eslint]
+args = ["--stdio"]
+command = "vscode-eslint-language-server"
+
+[[language]]
+name = "typescript"
+auto-format = true
+formatter = { command = "node_modules/.bin/prettier", args = ["--parser", "typescript"] }
+language-servers = [ { name = "eslint", only-features = [ "diagnostics" ] }, "typescript-language-server" ]
+

docs/kcl/KNOWN-ISSUES.md

@@ -24,5 +24,3 @@ once fixed in engine will just start working here with no language changes.
     chamfer cases work currently.
 
 - **Appearance**: Changing the appearance on a loft does not work.
-
-- **Helix**: Currently sweeping a helix does not work.

docs/kcl/appearance.md

@@ -31,12 +31,12 @@ appearance(data: AppearanceData, solid_set: SolidSet) -> SolidSet
 // Add color to an extruded solid.
 exampleSketch = startSketchOn("XZ")
   |> startProfileAt([0, 0], %)
-  |> lineTo([10, 0], %)
+  |> line(endAbsolute = [10, 0])
-  |> lineTo([0, 10], %)
+  |> line(endAbsolute = [0, 10])
-  |> lineTo([-10, 0], %)
+  |> line(endAbsolute = [-10, 0])
-  |> close(%)
+  |> close()
 
-example = extrude(5, exampleSketch)
+example = extrude(exampleSketch, length = 5)
   |> appearance({
        color = '#ff0000',
        metalness = 50,
@@ -65,11 +65,11 @@ sketch001 = startSketchOn('XY')
 fn cube(center) {
   return startSketchOn('XY')
     |> startProfileAt([center[0] - 10, center[1] - 10], %)
-    |> lineTo([center[0] + 10, center[1] - 10], %)
+    |> line(endAbsolute = [center[0] + 10, center[1] - 10])
-    |> lineTo([center[0] + 10, center[1] + 10], %)
+    |> line(endAbsolute = [center[0] + 10, center[1] + 10])
-    |> lineTo([center[0] - 10, center[1] + 10], %)
+    |> line(endAbsolute = [center[0] - 10, center[1] + 10])
-    |> close(%)
+    |> close()
-    |> extrude(10, %)
+    |> extrude(length = 10)
 }
 
 example0 = cube([0, 0])
@@ -95,11 +95,11 @@ appearance({
 // This example shows setting the appearance _after_ the shell.
 firstSketch = startSketchOn('XY')
   |> startProfileAt([-12, 12], %)
-  |> line([24, 0], %)
+  |> line(end = [24, 0])
-  |> line([0, -24], %)
+  |> line(end = [0, -24])
-  |> line([-24, 0], %)
+  |> line(end = [-24, 0])
-  |> close(%)
+  |> close()
-  |> extrude(6, %)
+  |> extrude(length = 6)
 
 shell({ faces = ['end'], thickness = 0.25 }, firstSketch)
   |> appearance({
@@ -116,11 +116,11 @@ shell({ faces = ['end'], thickness = 0.25 }, firstSketch)
 // This example shows setting the appearance _before_ the shell.
 firstSketch = startSketchOn('XY')
   |> startProfileAt([-12, 12], %)
-  |> line([24, 0], %)
+  |> line(end = [24, 0])
-  |> line([0, -24], %)
+  |> line(end = [0, -24])
-  |> line([-24, 0], %)
+  |> line(end = [-24, 0])
-  |> close(%)
+  |> close()
-  |> extrude(6, %)
+  |> extrude(length = 6)
   |> appearance({
        color = '#ff0000',
        metalness = 90,
@@ -137,12 +137,12 @@ shell({ faces = ['end'], thickness = 0.25 }, firstSketch)
 // This example shows _before_ the pattern.
 exampleSketch = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
-  |> line([0, 2], %)
+  |> line(end = [0, 2])
-  |> line([3, 1], %)
+  |> line(end = [3, 1])
-  |> line([0, -4], %)
+  |> line(end = [0, -4])
-  |> close(%)
+  |> close()
 
-example = extrude(1, exampleSketch)
+example = extrude(exampleSketch, length = 1)
   |> appearance({
        color = '#ff0000',
        metalness = 90,
@@ -162,12 +162,12 @@ example = extrude(1, exampleSketch)
 // This example shows _after_ the pattern.
 exampleSketch = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
-  |> line([0, 2], %)
+  |> line(end = [0, 2])
-  |> line([3, 1], %)
+  |> line(end = [3, 1])
-  |> line([0, -4], %)
+  |> line(end = [0, -4])
-  |> close(%)
+  |> close()
 
-example = extrude(1, exampleSketch)
+example = extrude(exampleSketch, length = 1)
   |> patternLinear3d({
        axis = [1, 0, 1],
        instances = 7,
@@ -186,10 +186,10 @@ example = extrude(1, exampleSketch)
 // Color the result of a 2D pattern that was extruded.
 exampleSketch = startSketchOn('XZ')
   |> startProfileAt([.5, 25], %)
-  |> line([0, 5], %)
+  |> line(end = [0, 5])
-  |> line([-1, 0], %)
+  |> line(end = [-1, 0])
-  |> line([0, -5], %)
+  |> line(end = [0, -5])
-  |> close(%)
+  |> close()
   |> patternCircular2d({
        center = [0, 0],
        instances = 13,
@@ -197,7 +197,7 @@ exampleSketch = startSketchOn('XZ')
        rotateDuplicates = true
      }, %)
 
-example = extrude(1, exampleSketch)
+example = extrude(exampleSketch, length = 1)
   |> appearance({
        color = '#ff0000',
        metalness = 90,
@@ -214,11 +214,11 @@ example = extrude(1, exampleSketch)
 // Create a path for the sweep.
 sweepPath = startSketchOn('XZ')
   |> startProfileAt([0.05, 0.05], %)
-  |> line([0, 7], %)
+  |> line(end = [0, 7])
   |> tangentialArc({ offset = 90, radius = 5 }, %)
-  |> line([-3, 0], %)
+  |> line(end = [-3, 0])
   |> tangentialArc({ offset = -90, radius = 5 }, %)
-  |> line([0, 7], %)
+  |> line(end = [0, 7])
 
 pipeHole = startSketchOn('XY')
   |> circle({ center = [0, 0], radius = 1.5 }, %)

docs/kcl/fillet.md

@@ -36,12 +36,12 @@ filletRadius = 2
 
 mountingPlateSketch = startSketchOn("XY")
   |> startProfileAt([-width / 2, -length / 2], %)
-  |> lineTo([width / 2, -length / 2], %, $edge1)
+  |> line(endAbsolute = [width / 2, -length / 2], tag = $edge1)
-  |> lineTo([width / 2, length / 2], %, $edge2)
+  |> line(endAbsolute = [width / 2, length / 2], tag = $edge2)
-  |> lineTo([-width / 2, length / 2], %, $edge3)
+  |> line(endAbsolute = [-width / 2, length / 2], tag = $edge3)
-  |> close(%, $edge4)
+  |> close(tag = $edge4)
 
-mountingPlate = extrude(thickness, mountingPlateSketch)
+mountingPlate = extrude(mountingPlateSketch, length = thickness)
   |> fillet({
        radius = filletRadius,
        tags = [
@@ -63,12 +63,12 @@ filletRadius = 1
 
 mountingPlateSketch = startSketchOn("XY")
   |> startProfileAt([-width / 2, -length / 2], %)
-  |> lineTo([width / 2, -length / 2], %, $edge1)
+  |> line(endAbsolute = [width / 2, -length / 2], tag = $edge1)
-  |> lineTo([width / 2, length / 2], %, $edge2)
+  |> line(endAbsolute = [width / 2, length / 2], tag = $edge2)
-  |> lineTo([-width / 2, length / 2], %, $edge3)
+  |> line(endAbsolute = [-width / 2, length / 2], tag = $edge3)
-  |> close(%, $edge4)
+  |> close(tag = $edge4)
 
-mountingPlate = extrude(thickness, mountingPlateSketch)
+mountingPlate = extrude(mountingPlateSketch, length = thickness)
   |> fillet({
        radius = filletRadius,
        tolerance = 0.000001,

docs/kcl/getNextAdjacentEdge.md

@@ -29,14 +29,14 @@ getNextAdjacentEdge(tag: TagIdentifier) -> Uuid
 ```js
 exampleSketch = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
-  |> line([10, 0], %)
+  |> line(end = [10, 0])
   |> angledLine({ angle = 60, length = 10 }, %)
   |> angledLine({ angle = 120, length = 10 }, %)
-  |> line([-10, 0], %)
+  |> line(end = [-10, 0])
   |> angledLine({ angle = 240, length = 10 }, %, $referenceEdge)
-  |> close(%)
+  |> close()
 
-example = extrude(5, exampleSketch)
+example = extrude(exampleSketch, length = 5)
   |> fillet({
        radius = 3,
        tags = [getNextAdjacentEdge(referenceEdge)]

docs/kcl/getOppositeEdge.md

@@ -29,14 +29,14 @@ getOppositeEdge(tag: TagIdentifier) -> Uuid
 ```js
 exampleSketch = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
-  |> line([10, 0], %)
+  |> line(end = [10, 0])
   |> angledLine({ angle = 60, length = 10 }, %)
   |> angledLine({ angle = 120, length = 10 }, %)
-  |> line([-10, 0], %)
+  |> line(end = [-10, 0])
   |> angledLine({ angle = 240, length = 10 }, %, $referenceEdge)
-  |> close(%)
+  |> close()
 
-example = extrude(5, exampleSketch)
+example = extrude(exampleSketch, length = 5)
   |> fillet({
        radius = 3,
        tags = [getOppositeEdge(referenceEdge)]

docs/kcl/getPreviousAdjacentEdge.md

@@ -29,14 +29,14 @@ getPreviousAdjacentEdge(tag: TagIdentifier) -> Uuid
 ```js
 exampleSketch = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
-  |> line([10, 0], %)
+  |> line(end = [10, 0])
   |> angledLine({ angle = 60, length = 10 }, %)
   |> angledLine({ angle = 120, length = 10 }, %)
-  |> line([-10, 0], %)
+  |> line(end = [-10, 0])
   |> angledLine({ angle = 240, length = 10 }, %, $referenceEdge)
-  |> close(%)
+  |> close()
 
-example = extrude(5, exampleSketch)
+example = extrude(exampleSketch, length = 5)
   |> fillet({
        radius = 3,
        tags = [getPreviousAdjacentEdge(referenceEdge)]

docs/kcl/helixRevolutions.md

@@ -30,7 +30,7 @@ helixRevolutions(data: HelixRevolutionsData, solid: Solid) -> Solid
 ```js
 part001 = startSketchOn('XY')
   |> circle({ center = [5, 5], radius = 10 }, %)
-  |> extrude(10, %)
+  |> extrude(length = 10)
   |> helixRevolutions({
        angleStart = 0,
        ccw = true,

docs/kcl/hollow.md

@@ -31,11 +31,11 @@ hollow(thickness: number, solid: Solid) -> Solid
 // Hollow a basic sketch.
 firstSketch = startSketchOn('XY')
   |> startProfileAt([-12, 12], %)
-  |> line([24, 0], %)
+  |> line(end = [24, 0])
-  |> line([0, -24], %)
+  |> line(end = [0, -24])
-  |> line([-24, 0], %)
+  |> line(end = [-24, 0])
-  |> close(%)
+  |> close()
-  |> extrude(6, %)
+  |> extrude(length = 6)
   |> hollow(0.25, %)
 ```
 
@@ -45,11 +45,11 @@ firstSketch = startSketchOn('XY')
 // Hollow a basic sketch.
 firstSketch = startSketchOn('-XZ')
   |> startProfileAt([-12, 12], %)
-  |> line([24, 0], %)
+  |> line(end = [24, 0])
-  |> line([0, -24], %)
+  |> line(end = [0, -24])
-  |> line([-24, 0], %)
+  |> line(end = [-24, 0])
-  |> close(%)
+  |> close()
-  |> extrude(6, %)
+  |> extrude(length = 6)
   |> hollow(0.5, %)
 ```
 
@@ -60,25 +60,25 @@ firstSketch = startSketchOn('-XZ')
 size = 100
 case = startSketchOn('-XZ')
   |> startProfileAt([-size, -size], %)
-  |> line([2 * size, 0], %)
+  |> line(end = [2 * size, 0])
-  |> line([0, 2 * size], %)
+  |> line(end = [0, 2 * size])
   |> tangentialArcTo([-size, size], %)
-  |> close(%)
+  |> close()
-  |> extrude(65, %)
+  |> extrude(length = 65)
 
 thing1 = startSketchOn(case, 'end')
   |> circle({
        center = [-size / 2, -size / 2],
        radius = 25
      }, %)
-  |> extrude(50, %)
+  |> extrude(length = 50)
 
 thing2 = startSketchOn(case, 'end')
   |> circle({
        center = [size / 2, -size / 2],
        radius = 25
      }, %)
-  |> extrude(50, %)
+  |> extrude(length = 50)
 
 hollow(0.5, case)
 ```

docs/kcl/import.md

@@ -4,14 +4,16 @@ excerpt: "Import a CAD file."
 layout: manual
 ---
 
+**WARNING:** This function is deprecated.
+
 Import a CAD file.
 
+**DEPRECATED** Prefer to use import statements.
+
 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 passing your desired measurement unit in the options parameter. When importing a GLTF file, the bin file will be imported as well. Import paths are relative to the current project directory.
 
 Note: The import command currently only works when using the native Modeling App.
 
-For importing KCL functions using the `import` statement, see the docs on [KCL modules](/docs/kcl/modules).
-
 ```js
 import(file_path: String, options?: ImportFormat) -> ImportedGeometry
 ```

docs/kcl/index.md

@@ -51,16 +51,13 @@ layout: manual
 * [`helixRevolutions`](kcl/helixRevolutions)
 * [`hole`](kcl/hole)
 * [`hollow`](kcl/hollow)
-* [`import`](kcl/import)
 * [`inch`](kcl/inch)
-* [`int`](kcl/int)
 * [`lastSegX`](kcl/lastSegX)
 * [`lastSegY`](kcl/lastSegY)
 * [`legAngX`](kcl/legAngX)
 * [`legAngY`](kcl/legAngY)
 * [`legLen`](kcl/legLen)
 * [`line`](kcl/line)
-* [`lineTo`](kcl/lineTo)
 * [`ln`](kcl/ln)
 * [`loft`](kcl/loft)
 * [`log`](kcl/log)

docs/kcl/int.md

@@ -4,6 +4,8 @@ excerpt: "Convert a number to an integer."
 layout: manual
 ---
 
+**WARNING:** This function is deprecated.
+
 Convert a number to an integer.
 
 DEPRECATED use floor(), ceil(), or round().
@@ -36,7 +38,7 @@ assertEqual(n, 3, 0.0001, "5/2 = 2.5, rounded up makes 3")
 // Draw n cylinders.
 startSketchOn('XZ')
   |> circle({ center = [0, 0], radius = 2 }, %)
-  |> extrude(5, %)
+  |> extrude(length = 5)
   |> patternTransform(n, fn(id) {
     return { translate = [4 * id, 0, 0] }
   }, %)

docs/kcl/patternCircular3d.md

@@ -31,7 +31,7 @@ patternCircular3d(data: CircularPattern3dData, solid_set: SolidSet) -> [Solid]
 exampleSketch = startSketchOn('XZ')
   |> circle({ center = [0, 0], radius = 1 }, %)
 
-example = extrude(-5, exampleSketch)
+example = extrude(exampleSketch, length = -5)
   |> patternCircular3d({
        axis = [1, -1, 0],
        center = [10, -20, 0],

docs/kcl/patternLinear3d.md

@@ -30,12 +30,12 @@ patternLinear3d(data: LinearPattern3dData, solid_set: SolidSet) -> [Solid]
 ```js
 exampleSketch = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
-  |> line([0, 2], %)
+  |> line(end = [0, 2])
-  |> line([3, 1], %)
+  |> line(end = [3, 1])
-  |> line([0, -4], %)
+  |> line(end = [0, -4])
-  |> close(%)
+  |> close()
 
-example = extrude(1, exampleSketch)
+example = extrude(exampleSketch, length = 1)
   |> patternLinear3d({
        axis = [1, 0, 1],
        instances = 7,

docs/kcl/patternTransform.md

@@ -63,7 +63,7 @@ fn transform(id) {
 // Sketch 4 cylinders.
 sketch001 = startSketchOn('XZ')
   |> circle({ center = [0, 0], radius = 2 }, %)
-  |> extrude(5, %)
+  |> extrude(length = 5)
   |> patternTransform(4, transform, %)
 ```
 
@@ -79,7 +79,7 @@ fn transform(id) {
 
 sketch001 = startSketchOn('XZ')
   |> circle({ center = [0, 0], radius = 2 }, %)
-  |> extrude(5, %)
+  |> extrude(length = 5)
   |> patternTransform(4, transform, %)
 ```
 
@@ -97,12 +97,12 @@ fn cube(length, center) {
 
   return startSketchOn('XY')
     |> startProfileAt(p0, %)
-    |> lineTo(p1, %)
+    |> line(endAbsolute = p1)
-    |> lineTo(p2, %)
+    |> line(endAbsolute = p2)
-    |> lineTo(p3, %)
+    |> line(endAbsolute = p3)
-    |> lineTo(p0, %)
+    |> line(endAbsolute = p0)
-    |> close(%)
+    |> close()
-    |> extrude(length, %)
+    |> extrude(length = length)
 }
 
 width = 20
@@ -135,12 +135,12 @@ fn cube(length, center) {
 
   return startSketchOn('XY')
     |> startProfileAt(p0, %)
-    |> lineTo(p1, %)
+    |> line(endAbsolute = p1)
-    |> lineTo(p2, %)
+    |> line(endAbsolute = p2)
-    |> lineTo(p3, %)
+    |> line(endAbsolute = p3)
-    |> lineTo(p0, %)
+    |> line(endAbsolute = p0)
-    |> close(%)
+    |> close()
-    |> extrude(length, %)
+    |> extrude(length = length)
 }
 
 width = 20
@@ -179,7 +179,7 @@ fn layer() {
   return startSketchOn("XY")
     // or some other plane idk
     |> circle({ center = [0, 0], radius = 1 }, %, $tag1)
-    |> extrude(h, %)
+    |> extrude(length = h)
 }
 // The vase is 100 layers tall.
 // The 100 layers are replica of each other, with a slight transformation applied to each.
@@ -205,7 +205,7 @@ startSketchOn('XY')
        center = [0, 0],
        inscribed = false
      }, %)
-  |> extrude(4, %)
+  |> extrude(length = 4)
   |> patternTransform(3, transform, %)
 ```
 

docs/kcl/segEnd.md

@@ -30,12 +30,12 @@ segEnd(tag: TagIdentifier) -> [number]
 w = 15
 cube = startSketchOn('XY')
   |> startProfileAt([0, 0], %)
-  |> line([w, 0], %, $line1)
+  |> line(end = [w, 0], tag = $line1)
-  |> line([0, w], %, $line2)
+  |> line(end = [0, w], tag = $line2)
-  |> line([-w, 0], %, $line3)
+  |> line(end = [-w, 0], tag = $line3)
-  |> line([0, -w], %, $line4)
+  |> line(end = [0, -w], tag = $line4)
-  |> close(%)
+  |> close()
-  |> extrude(5, %)
+  |> extrude(length = 5)
 
 fn cylinder(radius, tag) {
   return startSketchOn('XY')
@@ -44,7 +44,7 @@ fn cylinder(radius, tag) {
          radius = radius,
          center = segEnd(tag)
        }, %)
-    |> extrude(radius, %)
+    |> extrude(length = radius)
 }
 
 cylinder(1, line1)

docs/kcl/segStart.md

@@ -30,12 +30,12 @@ segStart(tag: TagIdentifier) -> [number]
 w = 15
 cube = startSketchOn('XY')
   |> startProfileAt([0, 0], %)
-  |> line([w, 0], %, $line1)
+  |> line(end = [w, 0], tag = $line1)
-  |> line([0, w], %, $line2)
+  |> line(end = [0, w], tag = $line2)
-  |> line([-w, 0], %, $line3)
+  |> line(end = [-w, 0], tag = $line3)
-  |> line([0, -w], %, $line4)
+  |> line(end = [0, -w], tag = $line4)
-  |> close(%)
+  |> close()
-  |> extrude(5, %)
+  |> extrude(length = 5)
 
 fn cylinder(radius, tag) {
   return startSketchOn('XY')
@@ -44,7 +44,7 @@ fn cylinder(radius, tag) {
          radius = radius,
          center = segStart(tag)
        }, %)
-    |> extrude(radius, %)
+    |> extrude(length = radius)
 }
 
 cylinder(1, line1)

docs/kcl/shell.md

@@ -31,11 +31,11 @@ shell(data: ShellData, solid_set: SolidSet) -> SolidSet
 // Remove the end face for the extrusion.
 firstSketch = startSketchOn('XY')
   |> startProfileAt([-12, 12], %)
-  |> line([24, 0], %)
+  |> line(end = [24, 0])
-  |> line([0, -24], %)
+  |> line(end = [0, -24])
-  |> line([-24, 0], %)
+  |> line(end = [-24, 0])
-  |> close(%)
+  |> close()
-  |> extrude(6, %)
+  |> extrude(length = 6)
 
 // Remove the end face for the extrusion.
 shell({ faces = ['end'], thickness = 0.25 }, firstSketch)
@@ -47,11 +47,11 @@ shell({ faces = ['end'], thickness = 0.25 }, firstSketch)
 // Remove the start face for the extrusion.
 firstSketch = startSketchOn('-XZ')
   |> startProfileAt([-12, 12], %)
-  |> line([24, 0], %)
+  |> line(end = [24, 0])
-  |> line([0, -24], %)
+  |> line(end = [0, -24])
-  |> line([-24, 0], %)
+  |> line(end = [-24, 0])
-  |> close(%)
+  |> close()
-  |> extrude(6, %)
+  |> extrude(length = 6)
 
 // Remove the start face for the extrusion.
 shell({ faces = ['start'], thickness = 0.25 }, firstSketch)
@@ -63,11 +63,11 @@ shell({ faces = ['start'], thickness = 0.25 }, firstSketch)
 // Remove a tagged face and the end face for the extrusion.
 firstSketch = startSketchOn('XY')
   |> startProfileAt([-12, 12], %)
-  |> line([24, 0], %)
+  |> line(end = [24, 0])
-  |> line([0, -24], %)
+  |> line(end = [0, -24])
-  |> line([-24, 0], %, $myTag)
+  |> line(end = [-24, 0], tag = $myTag)
-  |> close(%)
+  |> close()
-  |> extrude(6, %)
+  |> extrude(length = 6)
 
 // Remove a tagged face for the extrusion.
 shell({ faces = [myTag], thickness = 0.25 }, firstSketch)
@@ -79,11 +79,11 @@ shell({ faces = [myTag], thickness = 0.25 }, firstSketch)
 // Remove multiple faces at once.
 firstSketch = startSketchOn('XY')
   |> startProfileAt([-12, 12], %)
-  |> line([24, 0], %)
+  |> line(end = [24, 0])
-  |> line([0, -24], %)
+  |> line(end = [0, -24])
-  |> line([-24, 0], %, $myTag)
+  |> line(end = [-24, 0], tag = $myTag)
-  |> close(%)
+  |> close()
-  |> extrude(6, %)
+  |> extrude(length = 6)
 
 // Remove a tagged face and the end face for the extrusion.
 shell({
@@ -99,25 +99,25 @@ shell({
 size = 100
 case = startSketchOn('-XZ')
   |> startProfileAt([-size, -size], %)
-  |> line([2 * size, 0], %)
+  |> line(end = [2 * size, 0])
-  |> line([0, 2 * size], %)
+  |> line(end = [0, 2 * size])
   |> tangentialArcTo([-size, size], %)
-  |> close(%)
+  |> close()
-  |> extrude(65, %)
+  |> extrude(length = 65)
 
 thing1 = startSketchOn(case, 'end')
   |> circle({
        center = [-size / 2, -size / 2],
        radius = 25
      }, %)
-  |> extrude(50, %)
+  |> extrude(length = 50)
 
 thing2 = startSketchOn(case, 'end')
   |> circle({
        center = [size / 2, -size / 2],
        radius = 25
      }, %)
-  |> extrude(50, %)
+  |> extrude(length = 50)
 
 // We put "case" in the shell function to shell the entire object.
 shell({ faces = ['start'], thickness = 5 }, case)
@@ -130,25 +130,25 @@ shell({ faces = ['start'], thickness = 5 }, case)
 size = 100
 case = startSketchOn('XY')
   |> startProfileAt([-size, -size], %)
-  |> line([2 * size, 0], %)
+  |> line(end = [2 * size, 0])
-  |> line([0, 2 * size], %)
+  |> line(end = [0, 2 * size])
   |> tangentialArcTo([-size, size], %)
-  |> close(%)
+  |> close()
-  |> extrude(65, %)
+  |> extrude(length = 65)
 
 thing1 = startSketchOn(case, 'end')
   |> circle({
        center = [-size / 2, -size / 2],
        radius = 25
      }, %)
-  |> extrude(50, %)
+  |> extrude(length = 50)
 
 thing2 = startSketchOn(case, 'end')
   |> circle({
        center = [size / 2, -size / 2],
        radius = 25
      }, %)
-  |> extrude(50, %)
+  |> extrude(length = 50)
 
 // We put "thing1" in the shell function to shell the end face of the object.
 shell({ faces = ['end'], thickness = 5 }, thing1)
@@ -164,25 +164,25 @@ shell({ faces = ['end'], thickness = 5 }, thing1)
 size = 100
 case = startSketchOn('XY')
   |> startProfileAt([-size, -size], %)
-  |> line([2 * size, 0], %)
+  |> line(end = [2 * size, 0])
-  |> line([0, 2 * size], %)
+  |> line(end = [0, 2 * size])
   |> tangentialArcTo([-size, size], %)
-  |> close(%)
+  |> close()
-  |> extrude(65, %)
+  |> extrude(length = 65)
 
 thing1 = startSketchOn(case, 'end')
   |> circle({
        center = [-size / 2, -size / 2],
        radius = 25
      }, %)
-  |> extrude(50, %)
+  |> extrude(length = 50)
 
 thing2 = startSketchOn(case, 'end')
   |> circle({
        center = [size / 2, -size / 2],
        radius = 25
      }, %)
-  |> extrude(50, %)
+  |> extrude(length = 50)
 
 // We put "thing1" and "thing2" in the shell function to shell the end face of the object.
 shell({ faces = ['end'], thickness = 5 }, [thing1, thing2])

docs/kcl/types/Face.md

@@ -0,0 +1,28 @@
+---
+title: "Face"
+excerpt: "A face."
+layout: manual
+---
+
+A face.
+
+**Type:** `object`
+
+
+
+
+
+## Properties
+
+| Property | Type | Description | Required |
+|----------|------|-------------|----------|
+| `id` |`string`| The id of the face. | No |
+| `value` |`string`| The tag of the face. | No |
+| `xAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the face’s X axis be? | No |
+| `yAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the face’s Y axis be? | No |
+| `zAxis` |[`Point3d`](/docs/kcl/types/Point3d)| The z-axis (normal). | No |
+| `solid` |[`Solid`](/docs/kcl/types/Solid)| The solid the face is on. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A face. | No |
+| `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
+
+

docs/kcl/types/Helix.md

@@ -20,6 +20,7 @@ A helix.
 | `revolutions` |`number`| Number of revolutions. | No |
 | `angleStart` |`number`| Start angle (in degrees). | No |
 | `ccw` |`boolean`| Is the helix rotation counter clockwise? | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A helix. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 

docs/kcl/types/HelixValue.md

@@ -20,6 +20,7 @@ A helix.
 | `revolutions` |`number`| Number of revolutions. | No |
 | `angleStart` |`number`| Start angle (in degrees). | No |
 | `ccw` |`boolean`| Is the helix rotation counter clockwise? | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A helix. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 

docs/kcl/types/KclValue.md

@@ -168,7 +168,6 @@ Any KCL value.
 
 
 ----
-A plane.
 
 **Type:** `object`
 
@@ -181,17 +180,10 @@ A plane.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `type` |enum: [`Plane`](/docs/kcl/types/Plane)|  | No |
-| `id` |`string`| The id of the plane. | No |
+| `value` |[`Plane`](/docs/kcl/types/Plane)| Any KCL value. | No |
-| `value` |[`PlaneType`](/docs/kcl/types/PlaneType)| Any KCL value. | No |
-| `origin` |[`Point3d`](/docs/kcl/types/Point3d)| Origin of the plane. | No |
-| `xAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the plane’s X axis be? | No |
-| `yAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the plane’s Y axis be? | No |
-| `zAxis` |[`Point3d`](/docs/kcl/types/Point3d)| The z-axis (normal). | No |
-| `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 
 ----
-A face.
 
 **Type:** `object`
 
@@ -203,14 +195,8 @@ A face.
 
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
-| `type` |enum: `Face`|  | No |
+| `type` |enum: [`Face`](/docs/kcl/types/Face)|  | No |
-| `id` |`string`| The id of the face. | No |
+| `value` |[`Face`](/docs/kcl/types/Face)| Any KCL value. | No |
-| `value` |`string`| The tag of the face. | No |
-| `xAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the face’s X axis be? | No |
-| `yAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the face’s Y axis be? | No |
-| `zAxis` |[`Point3d`](/docs/kcl/types/Point3d)| The z-axis (normal). | No |
-| `solid` |[`Solid`](/docs/kcl/types/Solid)| The solid the face is on. | No |
-| `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 
 ----
@@ -246,7 +232,6 @@ A face.
 
 
 ----
-An solid is a collection of extrude surfaces.
 
 **Type:** `object`
 
@@ -259,14 +244,7 @@ An solid is a collection of extrude surfaces.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `type` |enum: [`Solid`](/docs/kcl/types/Solid)|  | No |
-| `id` |`string`| The id of the solid. | No |
+| `value` |[`Solid`](/docs/kcl/types/Solid)| Any KCL value. | No |
-| `value` |`[` [`ExtrudeSurface`](/docs/kcl/types/ExtrudeSurface) `]`| The extrude surfaces. | No |
-| `sketch` |[`Sketch`](/docs/kcl/types/Sketch)| The sketch. | No |
-| `height` |`number`| The height of the solid. | No |
-| `startCapId` |`string`| The id of the extrusion start cap | No |
-| `endCapId` |`string`| The id of the extrusion end cap | No |
-| `edgeCuts` |`[` [`EdgeCut`](/docs/kcl/types/EdgeCut) `]`| Chamfers or fillets on this solid. | No |
-| `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`| Metadata. | No |
 
 
 ----
@@ -286,7 +264,6 @@ An solid is a collection of extrude surfaces.
 
 
 ----
-A helix.
 
 **Type:** `object`
 
@@ -299,11 +276,7 @@ A helix.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `type` |enum: [`Helix`](/docs/kcl/types/Helix)|  | No |
-| `value` |`string`| The id of the helix. | No |
+| `value` |[`Helix`](/docs/kcl/types/Helix)| Any KCL value. | No |
-| `revolutions` |`number`| Number of revolutions. | No |
-| `angleStart` |`number`| Start angle (in degrees). | No |
-| `ccw` |`boolean`| Is the helix rotation counter clockwise? | No |
-| `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 
 ----

docs/kcl/types/Plane.md

@@ -22,6 +22,7 @@ A plane.
 | `xAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the plane’s X axis be? | No |
 | `yAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the plane’s Y axis be? | No |
 | `zAxis` |[`Point3d`](/docs/kcl/types/Point3d)| The z-axis (normal). | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A plane. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |