Move Helix button to a section with offset plane (3d 'construction' elements) (#5235)

* Move Helix button to a section with offset plane (3d 'construction' elements)
Fixes #5234

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

* Trigger CI

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

* Trigger CI

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.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

.env.development

@@ -2,8 +2,8 @@ NODE_ENV=development
 DEV=true
 VITE_KC_API_WS_MODELING_URL=wss://api.dev.zoo.dev/ws/modeling/commands
 VITE_KC_API_BASE_URL=https://api.dev.zoo.dev
-BASE_URL=https://api.dev.zoo.dev
 VITE_KC_SITE_BASE_URL=https://dev.zoo.dev
+VITE_KC_SITE_APP_URL=https://app.dev.zoo.dev
 VITE_KC_SKIP_AUTH=false
 VITE_KC_CONNECTION_TIMEOUT_MS=5000
 # ONLY add your token in .env.development.local if you want to skip auth, otherwise this token takes precedence!

.env.production

@@ -1,5 +1,8 @@
+NODE_ENV=production
+DEV=false
 VITE_KC_API_WS_MODELING_URL=wss://api.zoo.dev/ws/modeling/commands
 VITE_KC_API_BASE_URL=https://api.zoo.dev
 VITE_KC_SITE_BASE_URL=https://zoo.dev
+VITE_KC_SITE_APP_URL=https://app.zoo.dev
 VITE_KC_SKIP_AUTH=false
 VITE_KC_CONNECTION_TIMEOUT_MS=15000

.eslintrc

@@ -6,21 +6,36 @@
     "plugins": [
       "css-modules",
       "jest",
+      "jsx-a11y",
       "react",
+      "react-hooks",
       "suggest-no-throw",
+      "testing-library",
       "@typescript-eslint"
     ],
     "extends": [
-      "plugin:css-modules/recommended"
+      "plugin:css-modules/recommended",
+      "plugin:jsx-a11y/recommended",
+      "plugin:react-hooks/recommended"
     ],
     "rules": {
       "@typescript-eslint/no-floating-promises": "error",
       "@typescript-eslint/no-misused-promises": "error",
+      "jsx-a11y/click-events-have-key-events": "off",
+      "jsx-a11y/no-autofocus": "off",
+      "jsx-a11y/no-noninteractive-element-interactions": "off",
       "no-restricted-globals": [
         "error",
         {
           "name": "isNaN",
           "message": "Use Number.isNaN() instead."
+        },
+      ],
+      "no-restricted-syntax": [
+        "error",
+        {
+          "selector": "CallExpression[callee.object.name='Array'][callee.property.name='isArray']",
+          "message": "Use isArray() in lib/utils.ts instead of Array.isArray()."
         }
       ],
       "semi": [
@@ -33,6 +48,9 @@
     "overrides": [
       {
         "files": ["e2e/**/*.ts"], // Update the pattern based on your file structure
+        "extends": [
+          "plugin:testing-library/react"
+        ],
         "rules": {
           "suggest-no-throw/suggest-no-throw": "off",
           "testing-library/prefer-screen-queries": "off",
@@ -41,6 +59,9 @@
       },
       {
         "files": ["src/**/*.test.ts"],
+        "extends": [
+          "plugin:testing-library/react"
+        ],
         "rules": {
           "suggest-no-throw/suggest-no-throw": "off",
         }

.github/dependabot.yml

@@ -6,23 +6,29 @@
 version: 2
 updates:
   - package-ecosystem: 'npm' # See documentation for possible values
-    directory: '/' # Location of package manifests
+    directories:
+      - '/'
+      - '/packages/codemirror-lang-kcl/'
+      - '/packages/codemirror-lsp-client/'
     schedule:
-      interval: 'weekly'
+      interval: weekly
+      day: monday
     reviewers:
       - franknoirot
       - irev-dev
   - package-ecosystem: 'github-actions' # See documentation for possible values
     directory: '/' # Location of package manifests
     schedule:
-      interval: 'weekly'
+      interval: weekly
+      day: monday
     reviewers:
       - adamchalmers
       - jessfraz
   - package-ecosystem: 'cargo' # See documentation for possible values
     directory: '/src/wasm-lib/' # Location of package manifests
     schedule:
-      interval: 'weekly'
+      interval: weekly
+      day: monday
     reviewers:
       - adamchalmers
       - jessfraz
@@ -30,3 +36,6 @@ updates:
       serde-dependencies:
         patterns:
           - "serde*"
+      wasm-bindgen-deps:
+        patterns:
+          - "wasm-bindgen*"

.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,9 +126,13 @@ jobs:
           node-version-file: '.nvmrc'
           cache: 'yarn' # Set this to npm, yarn or pnpm.
 
-      - run: yarn install
-
-      - run: yarn tronb:vite
+      - 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
 
       - name: Prepare certificate and variables (Windows only)
         if: ${{ (env.IS_RELEASE == 'true' || env.IS_NIGHTLY == 'true') && matrix.os == 'windows-2022' }}
@@ -159,8 +163,8 @@ jobs:
       - name: Build the app (debug)
         if: ${{ env.IS_RELEASE == 'false' && env.IS_NIGHTLY == 'false' }}
         # electron-builder doesn't have a concept of release vs debug,
-        # this is just not doing any codesign or release yml generation
-        run: yarn electron-builder --config
+        # this is just not doing any codesign or release yml generation, and points to dev infra
+        run: yarn tronb:package:dev
 
       - name: Build the app (release)
         if: ${{ env.IS_RELEASE == 'true' || env.IS_NIGHTLY == 'true' }}
@@ -179,7 +183,7 @@ jobs:
         with:
           timeout_minutes: 10
           max_attempts: 3
-          command: yarn electron-builder --config --publish always
+          command: yarn tronb:package:prod
 
       - name: List artifacts in out/
         run: ls -R out
@@ -240,7 +244,7 @@ jobs:
         with:
           timeout_minutes: 10
           max_attempts: 3
-          command: yarn electron-builder --config --publish always
+          command: yarn tronb:package:prod
 
       - uses: actions/upload-artifact@v4
         if: ${{ env.IS_RELEASE == 'true' }}
@@ -384,19 +388,19 @@ jobs:
 
       - name: Authenticate to Google Cloud
         if: ${{ env.IS_NIGHTLY == 'true' }}
-        uses: 'google-github-actions/auth@v2.1.7'
+        uses: 'google-github-actions/auth@v2.1.8'
         with:
           credentials_json: '${{ secrets.GOOGLE_CLOUD_DL_SA }}'
 
       - name: Set up Google Cloud SDK
         if: ${{ env.IS_NIGHTLY == 'true' }}
-        uses: google-github-actions/setup-gcloud@v2.1.2
+        uses: google-github-actions/setup-gcloud@v2.1.4
         with:
           project_id: ${{ env.GOOGLE_CLOUD_PROJECT_ID }}
 
       - name: Upload nightly files to public bucket
         if: ${{ env.IS_NIGHTLY == 'true' }}
-        uses: google-github-actions/upload-cloud-storage@v2.2.1
+        uses: google-github-actions/upload-cloud-storage@v2.2.2
         with:
           path: out
           glob: '*'

.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/codemirror-lang-kcl.yml

@@ -0,0 +1,32 @@
+name: CodeMirror Lang KCL
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  yarn-unit-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
+
+      - run: yarn install
+        working-directory: packages/codemirror-lang-kcl
+
+      - run: yarn tsc
+        working-directory: packages/codemirror-lang-kcl
+
+      - name: run unit tests
+        run: yarn test
+        working-directory: packages/codemirror-lang-kcl

.github/workflows/e2e-tests.yml

@@ -46,7 +46,15 @@ jobs:
     runs-on: ${{ matrix.os }}
     needs: check-rust-changes
     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'
@@ -123,9 +131,9 @@ jobs:
       if: steps.download-wasm.outcome == 'failure'
       shell: bash
       run: yarn build:wasm
-    - name: build electron
+    - name: build web
       shell: bash
-      run: yarn tron:package
+      run: yarn tronb:vite:dev
     - name: Run ubuntu/chrome snapshots
       if: ${{ matrix.os == 'namespace-profile-ubuntu-8-cores' && matrix.shardIndex == 1 }}
       shell: bash

.github/workflows/publish-apps-release.yml

@@ -108,17 +108,17 @@ jobs:
         run: yarn files:set-notes
 
       - name: Authenticate to Google Cloud
-        uses: 'google-github-actions/auth@v2.1.7'
+        uses: 'google-github-actions/auth@v2.1.8'
         with:
           credentials_json: '${{ secrets.GOOGLE_CLOUD_DL_SA }}'
 
       - name: Set up Google Cloud SDK
-        uses: google-github-actions/setup-gcloud@v2.1.2
+        uses: google-github-actions/setup-gcloud@v2.1.4
         with:
           project_id: ${{ env.GOOGLE_CLOUD_PROJECT_ID }}
 
       - name: Upload release files to public bucket
-        uses: google-github-actions/upload-cloud-storage@v2.2.1
+        uses: google-github-actions/upload-cloud-storage@v2.2.2
         with:
           path: out
           glob: '*'

.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" ]
+

README.md

@@ -101,7 +101,7 @@ This will start the application and hot-reload on changes.
 
 Devtools can be opened with the usual Cmd-Opt-I (Mac) or Ctrl-Shift-I (Linux and Windows).
 
-To build, run `yarn tron:package`.
+To build with electron-builder, run `yarn tronb:package:dev` (or `yarn tronb:package:prod` to point to the .env.production variables)
 
 ## Checking out commits / Bisecting
 

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], %)
-  |> lineTo([0, 10], %)
-  |> lineTo([-10, 0], %)
-  |> close(%)
+  |> line(endAbsolute = [10, 0])
+  |> line(endAbsolute = [0, 10])
+  |> line(endAbsolute = [-10, 0])
+  |> 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], %)
-    |> lineTo([center[0] + 10, center[1] + 10], %)
-    |> lineTo([center[0] - 10, center[1] + 10], %)
-    |> close(%)
-    |> extrude(10, %)
+    |> line(endAbsolute = [center[0] + 10, center[1] - 10])
+    |> line(endAbsolute = [center[0] + 10, center[1] + 10])
+    |> line(endAbsolute = [center[0] - 10, center[1] + 10])
+    |> close()
+    |> 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([0, -24], %)
-  |> line([-24, 0], %)
-  |> close(%)
-  |> extrude(6, %)
+  |> line(end = [24, 0])
+  |> line(end = [0, -24])
+  |> line(end = [-24, 0])
+  |> close()
+  |> 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([0, -24], %)
-  |> line([-24, 0], %)
-  |> close(%)
-  |> extrude(6, %)
+  |> line(end = [24, 0])
+  |> line(end = [0, -24])
+  |> line(end = [-24, 0])
+  |> close()
+  |> 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([3, 1], %)
-  |> line([0, -4], %)
-  |> close(%)
+  |> line(end = [0, 2])
+  |> line(end = [3, 1])
+  |> line(end = [0, -4])
+  |> 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([3, 1], %)
-  |> line([0, -4], %)
-  |> close(%)
+  |> line(end = [0, 2])
+  |> line(end = [3, 1])
+  |> line(end = [0, -4])
+  |> 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([-1, 0], %)
-  |> line([0, -5], %)
-  |> close(%)
+  |> line(end = [0, 5])
+  |> line(end = [-1, 0])
+  |> line(end = [0, -5])
+  |> 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)
-  |> lineTo([width / 2, length / 2], %, $edge2)
-  |> lineTo([-width / 2, length / 2], %, $edge3)
-  |> close(%, $edge4)
+  |> line(endAbsolute = [width / 2, -length / 2], tag = $edge1)
+  |> line(endAbsolute = [width / 2, length / 2], tag = $edge2)
+  |> line(endAbsolute = [-width / 2, length / 2], tag = $edge3)
+  |> 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)
-  |> lineTo([width / 2, length / 2], %, $edge2)
-  |> lineTo([-width / 2, length / 2], %, $edge3)
-  |> close(%, $edge4)
+  |> line(endAbsolute = [width / 2, -length / 2], tag = $edge1)
+  |> line(endAbsolute = [width / 2, length / 2], tag = $edge2)
+  |> line(endAbsolute = [-width / 2, length / 2], tag = $edge3)
+  |> 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([0, -24], %)
-  |> line([-24, 0], %)
-  |> close(%)
-  |> extrude(6, %)
+  |> line(end = [24, 0])
+  |> line(end = [0, -24])
+  |> line(end = [-24, 0])
+  |> close()
+  |> 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([0, -24], %)
-  |> line([-24, 0], %)
-  |> close(%)
-  |> extrude(6, %)
+  |> line(end = [24, 0])
+  |> line(end = [0, -24])
+  |> line(end = [-24, 0])
+  |> close()
+  |> 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([0, 2 * size], %)
+  |> line(end = [2 * size, 0])
+  |> line(end = [0, 2 * size])
   |> tangentialArcTo([-size, size], %)
-  |> close(%)
-  |> extrude(65, %)
+  |> close()
+  |> 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([3, 1], %)
-  |> line([0, -4], %)
-  |> close(%)
+  |> line(end = [0, 2])
+  |> line(end = [3, 1])
+  |> line(end = [0, -4])
+  |> 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, %)
-    |> lineTo(p2, %)
-    |> lineTo(p3, %)
-    |> lineTo(p0, %)
-    |> close(%)
-    |> extrude(length, %)
+    |> line(endAbsolute = p1)
+    |> line(endAbsolute = p2)
+    |> line(endAbsolute = p3)
+    |> line(endAbsolute = p0)
+    |> close()
+    |> extrude(length = length)
 }
 
 width = 20
@@ -135,12 +135,12 @@ fn cube(length, center) {
 
   return startSketchOn('XY')
     |> startProfileAt(p0, %)
-    |> lineTo(p1, %)
-    |> lineTo(p2, %)
-    |> lineTo(p3, %)
-    |> lineTo(p0, %)
-    |> close(%)
-    |> extrude(length, %)
+    |> line(endAbsolute = p1)
+    |> line(endAbsolute = p2)
+    |> line(endAbsolute = p3)
+    |> line(endAbsolute = p0)
+    |> close()
+    |> 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([0, w], %, $line2)
-  |> line([-w, 0], %, $line3)
-  |> line([0, -w], %, $line4)
-  |> close(%)
-  |> extrude(5, %)
+  |> line(end = [w, 0], tag = $line1)
+  |> line(end = [0, w], tag = $line2)
+  |> line(end = [-w, 0], tag = $line3)
+  |> line(end = [0, -w], tag = $line4)
+  |> close()
+  |> 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([0, w], %, $line2)
-  |> line([-w, 0], %, $line3)
-  |> line([0, -w], %, $line4)
-  |> close(%)
-  |> extrude(5, %)
+  |> line(end = [w, 0], tag = $line1)
+  |> line(end = [0, w], tag = $line2)
+  |> line(end = [-w, 0], tag = $line3)
+  |> line(end = [0, -w], tag = $line4)
+  |> close()
+  |> 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([0, -24], %)
-  |> line([-24, 0], %)
-  |> close(%)
-  |> extrude(6, %)
+  |> line(end = [24, 0])
+  |> line(end = [0, -24])
+  |> line(end = [-24, 0])
+  |> close()
+  |> 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([0, -24], %)
-  |> line([-24, 0], %)
-  |> close(%)
-  |> extrude(6, %)
+  |> line(end = [24, 0])
+  |> line(end = [0, -24])
+  |> line(end = [-24, 0])
+  |> close()
+  |> 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([0, -24], %)
-  |> line([-24, 0], %, $myTag)
-  |> close(%)
-  |> extrude(6, %)
+  |> line(end = [24, 0])
+  |> line(end = [0, -24])
+  |> line(end = [-24, 0], tag = $myTag)
+  |> close()
+  |> 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([0, -24], %)
-  |> line([-24, 0], %, $myTag)
-  |> close(%)
-  |> extrude(6, %)
+  |> line(end = [24, 0])
+  |> line(end = [0, -24])
+  |> line(end = [-24, 0], tag = $myTag)
+  |> close()
+  |> 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([0, 2 * size], %)
+  |> line(end = [2 * size, 0])
+  |> line(end = [0, 2 * size])
   |> tangentialArcTo([-size, size], %)
-  |> close(%)
-  |> extrude(65, %)
+  |> close()
+  |> 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([0, 2 * size], %)
+  |> line(end = [2 * size, 0])
+  |> line(end = [0, 2 * size])
   |> tangentialArcTo([-size, size], %)
-  |> close(%)
-  |> extrude(65, %)
+  |> close()
+  |> 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([0, 2 * size], %)
+  |> line(end = [2 * size, 0])
+  |> line(end = [0, 2 * size])
   |> tangentialArcTo([-size, size], %)
-  |> close(%)
-  |> extrude(65, %)
+  |> close()
+  |> 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])