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

* ci for kcl-python-bindings

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

* updates

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

* updates

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

* updates

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

* bettter concurrency

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

* cleanup files

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

* updates

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

* updaets

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

* updaets

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

* updaets

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

* updaets

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

* format

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

* format

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

---------

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

.eslintignore

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

.gitattributes

@@ -0,0 +1,13 @@
+# Set default behavior to automatically normalize line endings.
+* text=auto
+
+# Force batch scripts to always use CRLF line endings so that if a repo is accessed
+# in Windows via a file share from Linux, the scripts will work.
+*.{cmd,[cC][mM][dD]} text working-tree-encoding=UTF-16LE eol=CRLF
+*.{bat,[bB][aA][tT]} text working-tree-encoding=UTF-16LE eol=CRLF
+*.{ics,[iI][cC][sS]} text working-tree-encoding=UTF-16LE eol=CRLF
+*.{ps1,[iP][sS][1]} text working-tree-encoding=UTF-16LE eol=CRLF
+
+# Force bash scripts to always use LF line endings so that if a repo is accessed
+# in Unix via a file share from Windows, the scripts will work.
+*.sh text eol=lfol=lf

.github/ci-cd-scripts/playwright-electron.sh

@@ -21,7 +21,7 @@ if [[ ! -f "test-results/.last-run.json" ]]; then
 fi
 
 retry=1
-max_retrys=5
+max_retrys=1
 
 # retry failed tests, doing our own retries because using inbuilt playwright retries causes connection issues
 while [[ $retry -le $max_retrys ]]; do

.github/dependabot.yml

@@ -25,7 +25,7 @@ updates:
       - adamchalmers
       - jessfraz
   - package-ecosystem: 'cargo' # See documentation for possible values
-    directory: '/src/wasm-lib/' # Location of package manifests
+    directory: '/rust/' # Location of package manifests
     schedule:
       interval: weekly
       day: monday
@@ -39,3 +39,11 @@ updates:
       wasm-bindgen-deps:
         patterns:
           - "wasm-bindgen*"
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/rust/kcl-python-bindings/" # Location of package manifests
+    schedule:
+      interval: weekly
+      day: monday
+    reviewers:
+      - adamchalmers
+      - jessfraz

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

@@ -21,7 +21,10 @@ jobs:
       - name: Cache wasm
         uses: Swatinem/rust-cache@v2
         with:
-          workspaces: './src/wasm-lib'
+          workspaces: './rust'
+      - uses: taiki-e/install-action@2dbeb927f58939d3aa13bf06ba0c0a34b76b9bfb
+        with:
+          tool: wasm-pack
       - name: build wasm
         run: yarn build:wasm
 
@@ -30,4 +33,4 @@ jobs:
       - uses: actions/upload-artifact@v4
         with:
           name: wasm-bundle
-          path: src/wasm-lib/pkg
+          path: rust/kcl-wasm-lib/pkg

.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 }}
@@ -41,15 +38,22 @@ jobs:
 
       - uses: Swatinem/rust-cache@v2
         with:
-          workspaces: './src/wasm-lib'
+          workspaces: './rust'
+
+      # TODO: see if we can fetch from main instead if no diff at rust
+      - uses: taiki-e/install-action@2dbeb927f58939d3aa13bf06ba0c0a34b76b9bfb
+        with:
+          tool: wasm-pack
 
-      # TODO: see if we can fetch from main instead if no diff at src/wasm-lib
       - name: Run build:wasm
         run: "yarn build:wasm"
 
       - 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' }}
@@ -63,7 +67,7 @@ jobs:
           path: |
             package.json
             electron-builder.yml
-            src/wasm-lib/pkg/wasm_lib*
+            rust/kcl-wasm-lib/pkg/kcl_wasm_lib*
             release-notes.md
             assets/icon.ico
             assets/icon.png
@@ -113,9 +117,9 @@ jobs:
           ls -R prepared-files
           cp prepared-files/package.json package.json
           cp prepared-files/electron-builder.yml electron-builder.yml
-          cp prepared-files/src/wasm-lib/pkg/wasm_lib_bg.wasm public
-          mkdir src/wasm-lib/pkg
-          cp prepared-files/src/wasm-lib/pkg/wasm_lib* src/wasm-lib/pkg
+          cp prepared-files/rust/kcl-wasm-lib/pkg/kcl_wasm_lib_bg.wasm public
+          mkdir rust/kcl-wasm-lib/pkg
+          cp prepared-files/rust/kcl-wasm-lib/pkg/kcl_wasm_lib* rust/kcl-wasm-lib/pkg
           cp prepared-files/release-notes.md release-notes.md
           cp prepared-files/assets/icon.ico assets/icon.ico
           cp prepared-files/assets/icon.png assets/icon.png
@@ -128,7 +132,7 @@ jobs:
 
       - name: yarn install
         # Windows is picky sometimes and fails on fetch. Step takes about ~30s
-        uses: nick-fields/retry@v3.0.0
+        uses: nick-fields/retry@v3.0.1
         with:
           timeout_minutes: 2
           max_attempts: 3
@@ -179,7 +183,7 @@ jobs:
           WINDOWS_CERTIFICATE_THUMBPRINT: ${{ secrets.WINDOWS_CERTIFICATE_THUMBPRINT }}
           DEBUG: "electron-notarize*"
         # TODO: Fix electron-notarize flakes. The logs above should help gather more data on failures
-        uses: nick-fields/retry@v3.0.0
+        uses: nick-fields/retry@v3.0.1
         with:
           timeout_minutes: 10
           max_attempts: 3
@@ -240,7 +244,7 @@ jobs:
           WINDOWS_CERTIFICATE_THUMBPRINT: ${{ secrets.WINDOWS_CERTIFICATE_THUMBPRINT }}
           DEBUG: "electron-notarize*"
         # TODO: Fix electron-notarize flakes. The logs above should help gather more data on failures
-        uses: nick-fields/retry@v3.0.0
+        uses: nick-fields/retry@v3.0.1
         with:
           timeout_minutes: 10
           max_attempts: 3
@@ -269,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) }}
@@ -326,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 \
@@ -382,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
 
@@ -410,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/cargo-check.yml

@@ -17,23 +17,17 @@ jobs:
   cargocheck:
     name: cargo check
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        dir: ['src/wasm-lib']
     steps:
       - uses: actions/checkout@v4
       - name: Install latest rust
         uses: actions-rs/toolchain@v1
-        with:
-            toolchain: stable
-            override: true
 
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2.6.1
 
       - name: Run check
         run: |
-          cd "${{ matrix.dir }}"
+          cd rust
           # We specifically want to test the disable-println feature
           # Since it is not enabled by default, we need to specify it
           # This is used in kcl-lsp

.github/workflows/cargo-clippy.yml

@@ -23,9 +23,6 @@ jobs:
   cargoclippy:
     name: cargo clippy
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        dir: ['src/wasm-lib']
     steps:
       - uses: actions/checkout@v4
       - uses: taiki-e/install-action@just
@@ -41,7 +38,7 @@ jobs:
 
       - name: Run clippy
         run: |
-          cd "${{ matrix.dir }}"
+          cd rust
           just lint
       # If this fails, run "cargo check" to update Cargo.lock,
       # then add Cargo.lock to the PR.

.github/workflows/cargo-fmt.yml

@@ -26,9 +26,6 @@ jobs:
   cargofmt:
     name: cargo fmt
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        dir: ['src/wasm-lib']
     steps:
       - uses: actions/checkout@v4
       - name: Install latest rust
@@ -43,6 +40,6 @@ jobs:
 
       - name: Run cargo fmt
         run: |
-          cd "${{ matrix.dir }}"
+          cd rust
           cargo fmt -- --check
         shell: bash

.github/workflows/cargo-test.yml

@@ -9,14 +9,11 @@ permissions: read-all
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
-name: cargo test of wasm-lib
+name: cargo test
 jobs:
   cargotest:
     name: cargo test
     runs-on: ubuntu-latest-8-cores
-    strategy:
-      matrix:
-        dir: ['src/wasm-lib']
     steps:
       - uses: actions/checkout@v4
       - name: Install latest rust
@@ -45,8 +42,8 @@ jobs:
       - name: cargo test
         shell: bash
         run: |-
-          cd "${{ matrix.dir }}"
-          cargo llvm-cov nextest --workspace --lcov --output-path lcov.info --test-threads=1 --no-fail-fast -P ci 2>&1 | tee /tmp/github-actions.log
+          cd rust
+          cargo llvm-cov nextest --workspace --lcov --output-path lcov.info --retries=2 --no-fail-fast -P ci 2>&1 | tee /tmp/github-actions.log
         env:
           KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
           RUST_MIN_STACK: 10485760000
@@ -55,7 +52,7 @@ jobs:
         with:
           token: ${{secrets.CODECOV_TOKEN}}
           fail_ci_if_error: true
-          flags: wasm-lib
+          flags: rust
           verbose: true
           files: lcov.info
 

.github/workflows/check-exampleKcl.yml

@@ -26,11 +26,21 @@ jobs:
             const issue_number = context.payload.pull_request.number;
             const owner = context.repo.owner;
             const repo = context.repo.repo;
-
-            // Post a comment on the PR
-            await github.rest.issues.createComment({
+            
+            const { data: comments } = await github.rest.issues.listComments({
               owner,
               repo,
-              issue_number,
-              body: message,
-            });
+              issue_number
+            });
+
+            const commentExists = comments.some(comment => comment.body === message);
+
+            if (!commentExists) {
+              // Post a comment on the PR
+              await github.rest.issues.createComment({
+                owner,
+                repo,
+                issue_number,
+                body: message,
+              });
+            }

.github/workflows/e2e-tests.yml

@@ -3,6 +3,8 @@ on:
   push:
     branches: [ main ]
   pull_request:
+  schedule:
+    - cron: 0 * * * *  # hourly
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
@@ -15,23 +17,6 @@ permissions:
 
 
 jobs:
-
-  check-rust-changes:
-    runs-on: ubuntu-latest
-    outputs:
-      rust-changed: ${{ steps.filter.outputs.rust }}
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - id: filter
-        name: Check for Rust changes
-        uses: dorny/paths-filter@v3
-        with:
-          filters: |
-            rust:
-              - 'src/wasm-lib/**'
-
   electron:
     timeout-minutes: 60
     name: playwright:electron:${{ matrix.os }} ${{ matrix.shardIndex }} ${{ matrix.shardTotal }}
@@ -42,8 +27,8 @@ jobs:
         os: [namespace-profile-ubuntu-8-cores, namespace-profile-macos-8-cores, windows-16-cores]
         shardIndex: [1, 2, 3, 4]
         shardTotal: [4]
+        # TODO: add ref here for main and latest release tag
     runs-on: ${{ matrix.os }}
-    needs: check-rust-changes
     steps:
     - uses: actions/create-github-app-token@v1
       id: app-token
@@ -54,11 +39,17 @@ jobs:
     - uses: actions/checkout@v4
       with:
         token: ${{ steps.app-token.outputs.token }}
+    - id: filter
+      name: Check for Rust changes
+      uses: dorny/paths-filter@v3
+      with:
+        filters: |
+          rust:
+            - 'rust/**'
     - uses: actions/setup-node@v4
       with:
         node-version-file: '.nvmrc'
         cache: 'yarn'
-    - uses: KittyCAD/action-install-cli@main
     - name: Install dependencies
       shell: bash
       run: yarn
@@ -73,7 +64,7 @@ jobs:
       run: yarn playwright install --with-deps
     - name: Download Wasm Cache
       id: download-wasm
-      if: needs.check-rust-changes.outputs.rust-changed == 'false'
+      if: github.event_name != 'schedule' && steps.filter.outputs.rust == 'false'
       uses: dawidd6/action-download-artifact@v7
       continue-on-error: true
       with:
@@ -81,24 +72,27 @@ jobs:
         name: wasm-bundle
         workflow: build-and-store-wasm.yml
         branch: main
-        path: src/wasm-lib/pkg
+        path: rust/kcl-wasm-lib/pkg
     - name: copy wasm blob
-      if: needs.check-rust-changes.outputs.rust-changed == 'false'
+      if: github.event_name != 'schedule' && steps.filter.outputs.rust == 'false'
       shell: bash
-      run: cp src/wasm-lib/pkg/wasm_lib_bg.wasm public
+      run: cp rust/kcl-wasm-lib/pkg/kcl_wasm_lib_bg.wasm public
       continue-on-error: true
     - name: Setup Rust
       uses: dtolnay/rust-toolchain@stable
+    - uses: taiki-e/install-action@2dbeb927f58939d3aa13bf06ba0c0a34b76b9bfb
+      with:
+        tool: wasm-pack
     - name: Cache Wasm (because rust diff)
-      if: needs.check-rust-changes.outputs.rust-changed == 'true'
+      if: github.event_name == 'schedule' || steps.filter.outputs.rust == 'true'
       uses: Swatinem/rust-cache@v2
       with:
-        workspaces: './src/wasm-lib'
+        workspaces: './rust'
     - name: OR Cache Wasm (because wasm cache failed)
       if: steps.download-wasm.outcome == 'failure'
       uses: Swatinem/rust-cache@v2
       with:
-        workspaces: './src/wasm-lib'
+        workspaces: './rust'
     - name: install good sed
       if:  ${{ startsWith(matrix.os, 'macos') }}
       shell: bash
@@ -123,7 +117,7 @@ jobs:
         cat /tmp/vector.toml
         ${HOME}/.vector/bin/vector --config /tmp/vector.toml &
     - name: Build Wasm (because rust diff)
-      if: needs.check-rust-changes.outputs.rust-changed == 'true'
+      if: github.event_name == 'schedule' || steps.filter.outputs.rust == 'true'
       shell: bash
       run: yarn build:wasm
     - name: OR Build Wasm (because wasm cache failed)
@@ -139,7 +133,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
@@ -150,7 +144,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
@@ -164,7 +158,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
@@ -173,7 +167,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
@@ -200,9 +194,11 @@ jobs:
     - name: Run playwright/electron flow (with retries)
       id: retry
       if: ${{ !cancelled() && (success() || failure()) }}
-      shell: bash
-      run: |
-        .github/ci-cd-scripts/playwright-electron.sh ${{matrix.shardIndex}} ${{matrix.shardTotal}} ${{matrix.os}}
+      uses: nick-fields/retry@v3.0.1
+      with:
+        command: .github/ci-cd-scripts/playwright-electron.sh ${{matrix.shardIndex}} ${{matrix.shardTotal}} ${{matrix.os}}
+        timeout_minutes: 30
+        max_attempts: 25
       env:
         CI: true
         FAIL_ON_CONSOLE_ERRORS: true

.github/workflows/kcl-python-bindings.yml

@@ -0,0 +1,179 @@
+# This file is autogenerated by maturin v1.6.0 and then modified
+# To update, run
+#
+#    maturin generate-ci github
+#
+name: kcl-python-bindings
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - '**/Cargo.toml'
+      - '**/Cargo.lock'
+      - '**/rust-toolchain.toml'
+      - 'rust/kcl-python-bindings/**'
+      - '**.rs'
+      - .github/workflows/kcl-python-bindings.yml
+    tags:
+      - 'kcl-*'
+  pull_request:
+    paths:
+      - '**/Cargo.toml'
+      - '**/Cargo.lock'
+      - '**/rust-toolchain.toml'
+      - 'rust/kcl-python-bindings/**'
+      - '**.rs'
+      - .github/workflows/kcl-python-bindings.yml
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  linux-x86_64:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          working-directory: rust/kcl-python-bindings
+          target: x86_64
+          args: --release --out dist --find-interpreter
+          sccache: 'true'
+          manylinux: auto
+          before-script-linux: |
+            yum install openssl-devel -y
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-linux-x86_64
+          path: rust/kcl-python-bindings/dist
+
+  windows:
+    runs-on: windows-16-cores
+    strategy:
+      matrix:
+        target:
+          - x64
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+          architecture: ${{ matrix.target }}
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          working-directory: rust/kcl-python-bindings
+          target: ${{ matrix.target }}
+          args: --release --out dist --find-interpreter
+          sccache: 'true'
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-windows-${{ matrix.target }}
+          path: rust/kcl-python-bindings/dist
+
+  macos:
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        target:
+          - x86_64
+          - aarch64
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          working-directory: rust/kcl-python-bindings
+          target: ${{ matrix.target }}
+          args: --release --out dist --find-interpreter
+          sccache: 'true'
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-macos-${{ matrix.target }}
+          path: rust/kcl-python-bindings/dist
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      - uses: taiki-e/install-action@just
+      - name: Run tests
+        run: |
+          cd rust/kcl-python-bindings
+          just setup-uv
+          just test
+        env:
+          KITTYCAD_API_TOKEN: ${{ secrets.KITTYCAD_API_TOKEN }}
+
+  sdist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v5
+      - name: Install codespell
+        run: |
+            uv venv .venv
+            echo "VIRTUAL_ENV=.venv" >> $GITHUB_ENV
+            echo "$PWD/.venv/bin" >> $GITHUB_PATH
+            uv pip install pip --upgrade
+      - name: Build sdist
+        uses: PyO3/maturin-action@v1
+        with:
+          working-directory: rust/kcl-python-bindings
+          command: sdist
+          args: --out dist
+      - name: Upload sdist
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-sdist
+          path: rust/kcl-python-bindings/dist
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    if: startsWith(github.ref, 'refs/tags/')
+    needs: [linux-x86_64, windows, macos, sdist]
+    steps:
+      - uses: actions/download-artifact@v4
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v5
+      - name: Install codespell
+        run: |
+            cd rust/kcl-python-bindings
+            uv venv .venv
+            echo "VIRTUAL_ENV=.venv" >> $GITHUB_ENV
+            echo "$PWD/.venv/bin" >> $GITHUB_PATH
+            uv pip install pip --upgrade
+      - name: Publish to PyPI
+        uses: PyO3/maturin-action@v1
+        env:
+          MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+        with:
+          working-directory: rust/kcl-python-bindings
+          command: upload
+          args: --non-interactive --skip-existing wheels-*/*

.github/workflows/ruff.yml

@@ -0,0 +1,24 @@
+name: ruff
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+on:
+  push:
+    branches: main
+    paths:
+      - '**.py'
+      - .github/workflows/ruff.yml
+  pull_request:
+    paths:
+      - '**.py'
+      - .github/workflows/ruff.yml
+permissions:
+  contents: read
+  pull-requests: write
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3
+

.github/workflows/static-analysis.yml

@@ -37,6 +37,9 @@ jobs:
           node-version-file: '.nvmrc'
           cache: 'yarn'
       - run: yarn install
+      - uses: taiki-e/install-action@2dbeb927f58939d3aa13bf06ba0c0a34b76b9bfb
+        with:
+          tool: wasm-pack
       - run: yarn build:wasm
 
   yarn-tsc:
@@ -51,8 +54,11 @@ jobs:
       - run: yarn install
       - uses: Swatinem/rust-cache@v2
         with:
-          workspaces: './src/wasm-lib'
+          workspaces: './rust'
 
+      - uses: taiki-e/install-action@2dbeb927f58939d3aa13bf06ba0c0a34b76b9bfb
+        with:
+          tool: wasm-pack
       - run: yarn build:wasm
       - run: yarn tsc
 
@@ -92,6 +98,9 @@ jobs:
           cache: 'yarn'
 
       - run: yarn install
+      - uses: taiki-e/install-action@2dbeb927f58939d3aa13bf06ba0c0a34b76b9bfb
+        with:
+          tool: wasm-pack
       - run: yarn build:wasm
 
       - run: yarn simpleserver:bg
@@ -118,6 +127,9 @@ jobs:
           cache: 'yarn'
 
       - run: yarn install
+      - uses: taiki-e/install-action@2dbeb927f58939d3aa13bf06ba0c0a34b76b9bfb
+        with:
+          tool: wasm-pack
       - run: yarn build:wasm
 
       - run: yarn simpleserver:bg

.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

@@ -26,24 +26,26 @@ yarn-error.log*
 .idea
 .vscode
 .helix
-src/wasm-lib/.idea
-src/wasm-lib/.vscode
 
 # rust
-src/wasm-lib/target
-src/wasm-lib/bindings
-src/wasm-lib/kcl/bindings
-public/wasm_lib_bg.wasm
-src/wasm-lib/lcov.info
-src/wasm-lib/grackle/test_json_output
+rust/target
+rust/kcl-lib/bindings
+public/kcl_wasm_lib_bg.wasm
+rust/lcov.info
+rust/kcl-wasm-lib/pkg
+*.snap.new
+rust/kcl-lib/fuzz/Cargo.lock
 
 e2e/playwright/playwright-secrets.env
 e2e/playwright/temp1.png
 e2e/playwright/temp2.png
 e2e/playwright/temp3.png
+# this will be overridden for specific directories
+e2e/playwright/**/*.png
 # exports from snapshot-tests.spec.ts "exports of each format should work"
 e2e/playwright/export-snapshots/*
 !e2e/playwright/export-snapshots/*.png
+!e2e/playwright/snapshot-tests.spec.ts-snapshots/*.png
 
 /kcl-samples
 /test-results/
@@ -56,15 +58,18 @@ e2e/playwright/export-snapshots/*
 ## generated files
 src/**/*.typegen.ts
 
-src/wasm-lib/grackle/stdlib_cube_partial.json
 Mac_App_Distribution.provisionprofile
 
 *.tsbuildinfo
-src/wasm-lib/pkg
 
 .eslintcache
-venv
 .vite/
 
 # electron
 out/
+
+# python
+__pycache__/
+uv.lock
+rust/kcl-python-bindings/dist
+venv

.prettierignore

@@ -7,9 +7,9 @@ coverage
 *.rs
 *.hbs
 target
-src/wasm-lib/pkg
-src/wasm-lib/kcl/bindings
+rust/
 e2e/playwright/export-snapshots
+e2e/playwright/snapshots/prompt-to-edit
 
 
 # XState generated files

Makefile

@@ -1,6 +1,6 @@
 .PHONY: dev
 
-WASM_LIB_FILES := $(wildcard src/wasm-lib/**/*.rs)
+KCL_WASM_LIB_FILES := $(wildcard rust/**/*.rs)
 TS_SRC := $(wildcard src/**/*.tsx) $(wildcard src/**/*.ts)
 XSTATE_TYPEGENS := $(wildcard src/machines/*.typegen.ts)
 
@@ -18,7 +18,7 @@ lee-electron-test:
 $(XSTATE_TYPEGENS): $(TS_SRC)
 	yarn xstate typegen 'src/**/*.ts?(x)'
 
-public/wasm_lib_bg.wasm: $(WASM_LIB_FILES)
+public/kcl_wasm_lib_bg.wasm: $(KCL_WASM_LIB_FILES)
 	yarn build:wasm
 
 node_modules: package.json yarn.lock

README.md

@@ -40,7 +40,7 @@ The 3D view in Modeling App is just a video stream from our hosted geometry engi
 
 [Original demo video](https://drive.google.com/file/d/183_wjqGdzZ8EEZXSqZ3eDcJocYPCyOdC/view?pli=1)
 
-[Original demo slides](https://github.com/KittyCAD/Eng/files/10398178/demo.pdf)
+[Original demo slides](https://github.com/user-attachments/files/19010536/demo.pdf)
 
 ## Get started
 
@@ -48,22 +48,53 @@ We recommend downloading the latest application binary from [our Releases page](
 
 ## Running a development build
 
-First, [install Rust via `rustup`](https://www.rust-lang.org/tools/install). This project uses a lot of Rust compiled to [WASM](https://webassembly.org/) within it. We always use the latest stable version of Rust, so you may need to run `rustup update stable`. Then, run:
+Install a node version manager such as [fnm](https://github.com/Schniz/fnm?tab=readme-ov-#installation).
+
+On Windows, it's also recommended to [upgrade your PowerShell version](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.5#winget), we're using 7.
+
+Then in the repo run the following to install and use the node version specified in `.nvmrc`. You might need to specify your processor architecture with `--arch arm64` or `--arch x64` if it's not autodetected.
+
+```
+fnm install --corepack-enabled
+fnm use
+```
+
+Install the NPM dependencies with:
 
 ```
 yarn install
 ```
 
-followed by:
+This project uses a lot of Rust compiled to [WASM](https://webassembly.org/) within it. We have package scripts to run rustup, see `package.json` for reference:
 
 ```
+# macOS/Linux
+yarn install:rust
+yarn install:wasm-pack:sh
+
+# Windows
+yarn install:rust:windows
+yarn install:wasm-pack:cargo
+```
+
+Then to build the WASM layer, run:
+
+```
+# macOS/Linux
 yarn build:wasm
+
+# Windows
+yarn build:wasm:windows
 ```
 
-or if you have the gh cli installed
+Or if you have the `gh` cli installed and want to download the latest main wasm bundle. Note that on Windows, you need to associate .ps1 files with PowerShell, which can be done via the right click menu, selecting `C:\Program Files\PowerShell\7\pwsh.exe`, and you can install tools like `gh` via `yarn install:tools:windows`.
 
 ```
-./get-latest-wasm-bundle.sh # this will download the latest main wasm bundle
+# macOS/Linux
+yarn fetch:wasm
+
+# Windows
+yarn fetch:wasm:windows
 ```
 
 That will build the WASM binary and put in the `public` dir (though gitignored).
@@ -74,7 +105,7 @@ Finally, to run the web app only, run:
 yarn start
 ```
 
-If you're not an KittyCAD employee you won't be able to access the dev environment, you should copy everything from `.env.production` to `.env.development` to make it point to production instead, then when you navigate to `localhost:3000` the easiest way to sign in is to paste `localStorage.setItem('TOKEN_PERSIST_KEY', "your-token-from-https://zoo.dev/account/api-tokens")` replacing the with a real token from https://zoo.dev/account/api-tokens of course, then navigate to localhost:3000 again. Note that navigating to `localhost:3000/signin` removes your token so you will need to set the token again.
+If you're not a Zoo employee you won't be able to access the dev environment, you should copy everything from `.env.production` to `.env.development` to make it point to production instead, then when you navigate to `localhost:3000` the easiest way to sign in is to paste `localStorage.setItem('TOKEN_PERSIST_KEY', "your-token-from-https://zoo.dev/account/api-tokens")` replacing the with a real token from https://zoo.dev/account/api-tokens of course, then navigate to localhost:3000 again. Note that navigating to `localhost:3000/signin` removes your token so you will need to set the token again.
 
 ### Development environment variables
 
@@ -101,13 +132,14 @@ 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 with electron-builder, run `yarn tronb:package:dev` (or `yarn tronb:package:prod` to point to the .env.production variables)
+To package the app for your platform with electron-builder, run `yarn tronb:package:dev` (or `yarn tronb:package:prod` to point to the .env.production variables)
 
 ## Checking out commits / Bisecting
 
 Which commands from setup are one off vs need to be run every time?
 
 The following will need to be run when checking out a new commit and guarantees the build is not stale:
+
 ```bash
 yarn install
 yarn build:wasm
@@ -158,11 +190,12 @@ Manually test against this [list](https://github.com/KittyCAD/modeling-app/issue
 
 ##### Updater-test builds
 
-The other `build-apps` output in the release `build-apps` workflow (triggered by 2.) is `updater-test-{arch}-{platform}`. It's a semi-automated process: for macOS, Windows, and Linux, download the corresponding updater-test artifact file, install the app, run it, expect an updater prompt to a dummy v0.255.255, install it and check that the app comes back at that version. 
+The other `build-apps` output in the release `build-apps` workflow (triggered by 2.) is `updater-test-{arch}-{platform}`. It's a semi-automated process: for macOS, Windows, and Linux, download the corresponding updater-test artifact file, install the app, run it, expect an updater prompt to a dummy v0.255.255, install it and check that the app comes back at that version.
 
 The only difference with these builds is that they point to a different update location on the release bucket, with this dummy v0.255.255 always available. This helps ensuring that the version we release will be able to update to the next one available.
 
 If the prompt doesn't show up, start the app in command line to grab the electron-updater logs. This is likely an issue with the current build that needs addressing (or the updater-test location in the storage bucket).
+
 ```
 # Windows (PowerShell)
 & 'C:\Program Files\Zoo Modeling App\Zoo Modeling App.exe'
@@ -178,15 +211,14 @@ If the prompt doesn't show up, start the app in command line to grab the electro
 
 Head over to https://github.com/KittyCAD/modeling-app/releases/new, pick the newly created tag and type it in the _Release title_ field as well.
 
-Hit _Generate release notes_ as a starting point to discuss the changelog in the issue. Once done, make sure _Set as the latest release_ is checked, and hit _Publish release_. 
+Hit _Generate release notes_ as a starting point to discuss the changelog in the issue. Once done, make sure _Set as the latest release_ is checked, and hit _Publish release_.
 
-A new `publish-apps-release` will kick in and you should be able to find it [here](https://github.com/KittyCAD/modeling-app/actions?query=event%3Arelease). On success, the files will be uploaded to the public bucket as well as to the GitHub release, and the announcement on Discord will be sent. 
+A new `publish-apps-release` will kick in and you should be able to find it [here](https://github.com/KittyCAD/modeling-app/actions?query=event%3Arelease). On success, the files will be uploaded to the public bucket as well as to the GitHub release, and the announcement on Discord will be sent.
 
 #### 5. Close the issue
 
 If everything is well and the release is out to the public, the issue tracking the release shall be closed.
 
-
 ## Fuzzing the parser
 
 Make sure you install cargo fuzz:
@@ -196,7 +228,7 @@ $ cargo install cargo-fuzz
 ```
 
 ```bash
-$ cd src/wasm-lib/kcl
+$ cd rust/kcl-lib
 
 # list the fuzz targets
 $ cargo fuzz list
@@ -224,6 +256,7 @@ snapshottoken=<your-snapshot-token>
 For a portable way to run Playwright you'll need Docker.
 
 #### Generic example
+
 After that, open a terminal and run:
 
 ```bash
@@ -236,7 +269,6 @@ and in another terminal, run:
 PW_TEST_CONNECT_WS_ENDPOINT=ws://127.0.0.1:4444/ yarn playwright test --project="Google Chrome" <test suite>
 ```
 
-
 #### Specific example
 
 open a terminal and run:
@@ -254,7 +286,6 @@ PW_TEST_CONNECT_WS_ENDPOINT=ws://127.0.0.1:4444/ yarn playwright test --project=
 run a specific test change the test from `test('...` to `test.only('...`
 (note if you commit this, the tests will instantly fail without running any of the tests)
 
-
 **Gotcha**: running the docker container with a mismatched image against your `./node_modules/playwright` will cause a failure. Make sure the versions are matched and up to date.
 
 run headed
@@ -348,17 +379,19 @@ Which will run our suite of [Vitest unit](https://vitest.dev/) and [React Testin
 - `just`
 
 #### Setting KITTYCAD_API_TOKEN
+
 Use the production zoo.dev token, set this environment variable before running the tests
 
 #### Installing cargonextest
 
 ```
-cd src/wasm-lib
+cd rust 
 cargo search cargo-nextest
 cargo install cargo-nextest
 ```
 
 #### just
+
 install [`just`](https://github.com/casey/just?tab=readme-ov-file#pre-built-binaries)
 
 #### Running the tests
@@ -368,7 +401,7 @@ install [`just`](https://github.com/casey/just?tab=readme-ov-file#pre-built-bina
 # Make sure KITTYCAD_API_TOKEN=<prod zoo.dev token> is set
 # Make sure you installed cargo-nextest
 # Make sure you installed just
-cd src/wasm-lib
+cd rust 
 just test
 ```
 
@@ -376,7 +409,7 @@ just test
 # Without just
 # Make sure KITTYCAD_API_TOKEN=<prod zoo.dev token> is set
 # Make sure you installed cargo-nextest
-cd src/wasm-lib
+cd rust 
 export RUST_BRACKTRACE="full" && cargo nextest run --workspace --test-threads=1
 ```
 
@@ -385,13 +418,14 @@ Where `XXX` is an API token from the production engine (NOT the dev environment)
 We recommend using [nextest](https://nexte.st/) to run the Rust tests (its faster and is used in CI). Once installed, run the tests using
 
 ```
-cd src/wasm-lib
+cd rust 
 KITTYCAD_API_TOKEN=XXX cargo run nextest
 ```
 
 ### Mapping CI CD jobs to local commands
 
 When you see the CI CD fail on jobs you may wonder three things
+
 - Do I have a bug in my code?
 - Is the test flaky?
 - Is there a bug in `main`?
@@ -410,7 +444,6 @@ yarn test-setup
 
 > Gotcha, are packages up to date and is the wasm built?
 
-
 ```
 yarn tsc
 yarn fmt-check
@@ -466,7 +499,7 @@ PS: for the debug panel, the following JSON is useful for snapping the camera
 
 ## KCL
 
-For how to contribute to KCL, [see our KCL README](https://github.com/KittyCAD/modeling-app/tree/main/src/wasm-lib/kcl).
+For how to contribute to KCL, [see our KCL README](https://github.com/KittyCAD/modeling-app/tree/main/rust/kcl-lib).
 
 ### Logging
 

docs/kcl/abs.md

@@ -25,7 +25,7 @@ abs(num: number) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

docs/kcl/acos.md

@@ -25,7 +25,7 @@ acos(num: number) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

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/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/asin.md

@@ -25,7 +25,7 @@ asin(num: number) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

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,
+) -> ()
 ```
 
 
@@ -22,7 +25,7 @@ assert(data: bool, message: string) -> ()
 
 ### Returns
 
-`()` 
+`()`
 
 
 ### Examples

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,
+) -> ()
 ```
 
 
@@ -24,7 +29,7 @@ assertEqual(left: number, right: number, epsilon: number, message: string) -> ()
 
 ### Returns
 
-`()` 
+`()`
 
 
 ### Examples

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,
+) -> ()
 ```
 
 
@@ -23,7 +27,7 @@ assertGreaterThan(left: number, right: number, message: string) -> ()
 
 ### Returns
 
-`()` 
+`()`
 
 
 ### Examples

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,
+) -> ()
 ```
 
 
@@ -23,7 +27,7 @@ assertGreaterThanOrEq(left: number, right: number, message: string) -> ()
 
 ### Returns
 
-`()` 
+`()`
 
 
 ### Examples

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,
+) -> ()
 ```
 
 
@@ -23,7 +27,7 @@ assertLessThan(left: number, right: number, message: string) -> ()
 
 ### Returns
 
-`()` 
+`()`
 
 
 ### Examples

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,
+) -> ()
 ```
 
 
@@ -23,7 +27,7 @@ assertLessThanOrEq(left: number, right: number, message: string) -> ()
 
 ### Returns
 
-`()` 
+`()`
 
 
 ### Examples

docs/kcl/atan.md

@@ -25,7 +25,7 @@ atan(num: number) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

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
@@ -26,7 +29,7 @@ atan2(y: number, x: number) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

docs/kcl/ceil.md

@@ -25,7 +25,7 @@ ceil(num: number) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

docs/kcl/cm.md

@@ -26,7 +26,7 @@ cm() -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

docs/kcl/const_std-HALF_TURN.md

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

docs/kcl/const_std-QUARTER_TURN.md

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

docs/kcl/const_std-THREE_QUARTER_TURN.md

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

docs/kcl/const_std-XY.md

@@ -0,0 +1,15 @@
+---
+title: "std::XY"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+```js
+std::XY
+```
+
+

docs/kcl/const_std-XZ.md

@@ -0,0 +1,15 @@
+---
+title: "std::XZ"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+```js
+std::XZ
+```
+
+

docs/kcl/const_std-YZ.md

@@ -0,0 +1,15 @@
+---
+title: "std::YZ"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+```js
+std::YZ
+```
+
+

docs/kcl/const_std-ZERO.md

@@ -0,0 +1,15 @@
+---
+title: "std::ZERO"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+```js
+std::ZERO: number = 0
+```
+
+

docs/kcl/e.md

@@ -4,9 +4,11 @@ excerpt: "Return the value of Euler’s number `e`."
 layout: manual
 ---
 
+**WARNING:** This function is deprecated.
+
 Return the value of Euler’s number `e`.
 
-
+**DEPRECATED** use the constant E
 
 ```js
 e() -> number
@@ -20,7 +22,7 @@ e() -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

docs/kcl/floor.md

@@ -25,7 +25,7 @@ floor(num: number) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

docs/kcl/ft.md

@@ -26,7 +26,7 @@ ft() -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

docs/kcl/inch.md

@@ -26,7 +26,7 @@ inch() -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

docs/kcl/index.md

@@ -6,113 +6,131 @@ layout: manual
 
 ## Table of Contents
 
-* [Types](kcl/types)
-* [Modules](kcl/modules)
-* [Known Issues](kcl/KNOWN-ISSUES)
-* [`abs`](kcl/abs)
-* [`acos`](kcl/acos)
-* [`angleToMatchLengthX`](kcl/angleToMatchLengthX)
-* [`angleToMatchLengthY`](kcl/angleToMatchLengthY)
-* [`angledLine`](kcl/angledLine)
-* [`angledLineOfXLength`](kcl/angledLineOfXLength)
-* [`angledLineOfYLength`](kcl/angledLineOfYLength)
-* [`angledLineThatIntersects`](kcl/angledLineThatIntersects)
-* [`angledLineToX`](kcl/angledLineToX)
-* [`angledLineToY`](kcl/angledLineToY)
-* [`appearance`](kcl/appearance)
-* [`arc`](kcl/arc)
-* [`arcTo`](kcl/arcTo)
-* [`asin`](kcl/asin)
-* [`assert`](kcl/assert)
-* [`assertEqual`](kcl/assertEqual)
-* [`assertGreaterThan`](kcl/assertGreaterThan)
-* [`assertGreaterThanOrEq`](kcl/assertGreaterThanOrEq)
-* [`assertLessThan`](kcl/assertLessThan)
-* [`assertLessThanOrEq`](kcl/assertLessThanOrEq)
-* [`atan`](kcl/atan)
-* [`atan2`](kcl/atan2)
-* [`bezierCurve`](kcl/bezierCurve)
-* [`ceil`](kcl/ceil)
-* [`chamfer`](kcl/chamfer)
-* [`circle`](kcl/circle)
-* [`circleThreePoint`](kcl/circleThreePoint)
-* [`close`](kcl/close)
-* [`cm`](kcl/cm)
-* [`cos`](kcl/cos)
-* [`e`](kcl/e)
-* [`extrude`](kcl/extrude)
-* [`fillet`](kcl/fillet)
-* [`floor`](kcl/floor)
-* [`ft`](kcl/ft)
-* [`getNextAdjacentEdge`](kcl/getNextAdjacentEdge)
-* [`getOppositeEdge`](kcl/getOppositeEdge)
-* [`getPreviousAdjacentEdge`](kcl/getPreviousAdjacentEdge)
-* [`helix`](kcl/helix)
-* [`helixRevolutions`](kcl/helixRevolutions)
-* [`hole`](kcl/hole)
-* [`hollow`](kcl/hollow)
-* [`inch`](kcl/inch)
-* [`lastSegX`](kcl/lastSegX)
-* [`lastSegY`](kcl/lastSegY)
-* [`legAngX`](kcl/legAngX)
-* [`legAngY`](kcl/legAngY)
-* [`legLen`](kcl/legLen)
-* [`line`](kcl/line)
-* [`ln`](kcl/ln)
-* [`loft`](kcl/loft)
-* [`log`](kcl/log)
-* [`log10`](kcl/log10)
-* [`log2`](kcl/log2)
-* [`m`](kcl/m)
-* [`map`](kcl/map)
-* [`max`](kcl/max)
-* [`min`](kcl/min)
-* [`mirror2d`](kcl/mirror2d)
-* [`mm`](kcl/mm)
-* [`offsetPlane`](kcl/offsetPlane)
-* [`patternCircular2d`](kcl/patternCircular2d)
-* [`patternCircular3d`](kcl/patternCircular3d)
-* [`patternLinear2d`](kcl/patternLinear2d)
-* [`patternLinear3d`](kcl/patternLinear3d)
-* [`patternTransform`](kcl/patternTransform)
-* [`patternTransform2d`](kcl/patternTransform2d)
-* [`pi`](kcl/pi)
-* [`polar`](kcl/polar)
-* [`polygon`](kcl/polygon)
-* [`pop`](kcl/pop)
-* [`pow`](kcl/pow)
-* [`profileStart`](kcl/profileStart)
-* [`profileStartX`](kcl/profileStartX)
-* [`profileStartY`](kcl/profileStartY)
-* [`push`](kcl/push)
-* [`reduce`](kcl/reduce)
-* [`rem`](kcl/rem)
-* [`revolve`](kcl/revolve)
-* [`round`](kcl/round)
-* [`segAng`](kcl/segAng)
-* [`segEnd`](kcl/segEnd)
-* [`segEndX`](kcl/segEndX)
-* [`segEndY`](kcl/segEndY)
-* [`segLen`](kcl/segLen)
-* [`segStart`](kcl/segStart)
-* [`segStartX`](kcl/segStartX)
-* [`segStartY`](kcl/segStartY)
-* [`shell`](kcl/shell)
-* [`sin`](kcl/sin)
-* [`sqrt`](kcl/sqrt)
-* [`startProfileAt`](kcl/startProfileAt)
-* [`startSketchOn`](kcl/startSketchOn)
-* [`sweep`](kcl/sweep)
-* [`tan`](kcl/tan)
-* [`tangentToEnd`](kcl/tangentToEnd)
-* [`tangentialArc`](kcl/tangentialArc)
-* [`tangentialArcTo`](kcl/tangentialArcTo)
-* [`tangentialArcToRelative`](kcl/tangentialArcToRelative)
-* [`tau`](kcl/tau)
-* [`toDegrees`](kcl/toDegrees)
-* [`toRadians`](kcl/toRadians)
-* [`xLine`](kcl/xLine)
-* [`xLineTo`](kcl/xLineTo)
-* [`yLine`](kcl/yLine)
-* [`yLineTo`](kcl/yLineTo)
-* [`yd`](kcl/yd)
+### 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)
+  * [`angleToMatchLengthX`](kcl/angleToMatchLengthX)
+  * [`angleToMatchLengthY`](kcl/angleToMatchLengthY)
+  * [`angledLine`](kcl/angledLine)
+  * [`angledLineOfXLength`](kcl/angledLineOfXLength)
+  * [`angledLineOfYLength`](kcl/angledLineOfYLength)
+  * [`angledLineThatIntersects`](kcl/angledLineThatIntersects)
+  * [`angledLineToX`](kcl/angledLineToX)
+  * [`angledLineToY`](kcl/angledLineToY)
+  * [`appearance`](kcl/appearance)
+  * [`arc`](kcl/arc)
+  * [`arcTo`](kcl/arcTo)
+  * [`asin`](kcl/asin)
+  * [`assert`](kcl/assert)
+  * [`assertEqual`](kcl/assertEqual)
+  * [`assertGreaterThan`](kcl/assertGreaterThan)
+  * [`assertGreaterThanOrEq`](kcl/assertGreaterThanOrEq)
+  * [`assertLessThan`](kcl/assertLessThan)
+  * [`assertLessThanOrEq`](kcl/assertLessThanOrEq)
+  * [`atan`](kcl/atan)
+  * [`atan2`](kcl/atan2)
+  * [`bezierCurve`](kcl/bezierCurve)
+  * [`ceil`](kcl/ceil)
+  * [`chamfer`](kcl/chamfer)
+  * [`circle`](kcl/circle)
+  * [`circleThreePoint`](kcl/circleThreePoint)
+  * [`close`](kcl/close)
+  * [`cm`](kcl/cm)
+  * [`extrude`](kcl/extrude)
+  * [`fillet`](kcl/fillet)
+  * [`floor`](kcl/floor)
+  * [`ft`](kcl/ft)
+  * [`getNextAdjacentEdge`](kcl/getNextAdjacentEdge)
+  * [`getOppositeEdge`](kcl/getOppositeEdge)
+  * [`getPreviousAdjacentEdge`](kcl/getPreviousAdjacentEdge)
+  * [`helix`](kcl/helix)
+  * [`helixRevolutions`](kcl/helixRevolutions)
+  * [`hole`](kcl/hole)
+  * [`hollow`](kcl/hollow)
+  * [`inch`](kcl/inch)
+  * [`lastSegX`](kcl/lastSegX)
+  * [`lastSegY`](kcl/lastSegY)
+  * [`legAngX`](kcl/legAngX)
+  * [`legAngY`](kcl/legAngY)
+  * [`legLen`](kcl/legLen)
+  * [`line`](kcl/line)
+  * [`ln`](kcl/ln)
+  * [`loft`](kcl/loft)
+  * [`log`](kcl/log)
+  * [`log10`](kcl/log10)
+  * [`log2`](kcl/log2)
+  * [`m`](kcl/m)
+  * [`map`](kcl/map)
+  * [`max`](kcl/max)
+  * [`min`](kcl/min)
+  * [`mirror2d`](kcl/mirror2d)
+  * [`mm`](kcl/mm)
+  * [`offsetPlane`](kcl/offsetPlane)
+  * [`patternCircular2d`](kcl/patternCircular2d)
+  * [`patternCircular3d`](kcl/patternCircular3d)
+  * [`patternLinear2d`](kcl/patternLinear2d)
+  * [`patternLinear3d`](kcl/patternLinear3d)
+  * [`patternTransform`](kcl/patternTransform)
+  * [`patternTransform2d`](kcl/patternTransform2d)
+  * [`polar`](kcl/polar)
+  * [`polygon`](kcl/polygon)
+  * [`pop`](kcl/pop)
+  * [`pow`](kcl/pow)
+  * [`profileStart`](kcl/profileStart)
+  * [`profileStartX`](kcl/profileStartX)
+  * [`profileStartY`](kcl/profileStartY)
+  * [`push`](kcl/push)
+  * [`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)
+  * [`segEndY`](kcl/segEndY)
+  * [`segLen`](kcl/segLen)
+  * [`segStart`](kcl/segStart)
+  * [`segStartX`](kcl/segStartX)
+  * [`segStartY`](kcl/segStartY)
+  * [`shell`](kcl/shell)
+  * [`sqrt`](kcl/sqrt)
+  * [`startProfileAt`](kcl/startProfileAt)
+  * [`startSketchOn`](kcl/startSketchOn)
+  * [`sweep`](kcl/sweep)
+  * [`tangentToEnd`](kcl/tangentToEnd)
+  * [`tangentialArc`](kcl/tangentialArc)
+  * [`tangentialArcTo`](kcl/tangentialArcTo)
+  * [`tangentialArcToRelative`](kcl/tangentialArcToRelative)
+  * [`toDegrees`](kcl/toDegrees)
+  * [`toRadians`](kcl/toRadians)
+  * [`translate`](kcl/translate)
+  * [`xLine`](kcl/xLine)
+  * [`xLineTo`](kcl/xLineTo)
+  * [`yLine`](kcl/yLine)
+  * [`yLineTo`](kcl/yLineTo)
+  * [`yd`](kcl/yd)
+* **`std::math`**
+  * [`E`](kcl/const_std-math-E)
+  * [`PI`](kcl/const_std-math-PI)
+  * [`TAU`](kcl/const_std-math-TAU)
+  * [`cos`](kcl/std-math-cos)
+  * [`sin`](kcl/std-math-sin)
+  * [`tan`](kcl/std-math-tan)

docs/kcl/lastSegX.md

@@ -17,11 +17,11 @@ lastSegX(sketch: Sketch) -> number
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
+| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | The sketch whose line segment is being queried | Yes |
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

docs/kcl/lastSegY.md

@@ -17,11 +17,11 @@ lastSegY(sketch: Sketch) -> number
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
+| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | The sketch whose line segment is being queried | Yes |
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

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
@@ -26,7 +29,7 @@ legAngX(hypotenuse: number, leg: number) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

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
@@ -26,7 +29,7 @@ legAngY(hypotenuse: number, leg: number) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

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
@@ -26,7 +29,7 @@ legLen(hypotenuse: number, leg: number) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

docs/kcl/line.md

@@ -9,7 +9,12 @@ Extend the current sketch with a new straight line.
 
 
 ```js
-line(sketch: Sketch, end_absolute?: [number], end?: [number], tag?: TagDeclarator) -> Sketch
+line(
+  sketch: Sketch,
+  endAbsolute?: [number],
+  end?: [number],
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -18,7 +23,7 @@ line(sketch: Sketch, end_absolute?: [number], end?: [number], tag?: TagDeclarato
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | Which sketch should this path be added to? | Yes |
-| `end_absolute` | `[number]` | Which absolute point should this line go to? Incompatible with `end`. | No |
+| `endAbsolute` | `[number]` | Which absolute point should this line go to? Incompatible with `end`. | No |
 | `end` | `[number]` | How far away (along the X and Y axes) should this line go? Incompatible with `endAbsolute`. | No |
 | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this line | No |
 
@@ -30,7 +35,7 @@ line(sketch: Sketch, end_absolute?: [number], end?: [number], tag?: TagDeclarato
 ### 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/m.md

@@ -26,7 +26,7 @@ m() -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

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], map_fn: FunctionParam) -> [KclValue]
+map(
+  array: [KclValue],
+  mapFn: FunctionSource,
+) -> [KclValue]
 ```
 
 
@@ -18,11 +21,11 @@ map(array: [KclValue], map_fn: FunctionParam) -> [KclValue]
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `array` | [`[KclValue]`](/docs/kcl/types/KclValue) |  | Yes |
-| `map_fn` | `FunctionParam` |  | Yes |
+| `mapFn` | `FunctionSource` |  | Yes |
 
 ### Returns
 
-[`[KclValue]`](/docs/kcl/types/KclValue) 
+[`[KclValue]`](/docs/kcl/types/KclValue)
 
 
 ### Examples
@@ -31,7 +34,7 @@ map(array: [KclValue], map_fn: FunctionParam) -> [KclValue]
 r = 10 // radius
 fn drawCircle(id) {
   return startSketchOn("XY")
-    |> circle({ center = [id * 2 * r, 0], radius = r }, %)
+    |> circle(center = [id * 2 * r, 0], radius = r)
 }
 
 // Call `drawCircle`, passing in each element of the array.
@@ -47,7 +50,7 @@ r = 10 // radius
 // Call `map`, using an anonymous function instead of a named one.
 circles = map([1..3], fn(id) {
   return startSketchOn("XY")
-    |> circle({ center = [id * 2 * r, 0], radius = r }, %)
+    |> circle(center = [id * 2 * r, 0], radius = r)
 })
 ```
 

docs/kcl/max.md

@@ -25,7 +25,7 @@ max(args: [number]) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

docs/kcl/min.md

@@ -25,7 +25,7 @@ min(args: [number]) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

docs/kcl/mm.md

@@ -26,7 +26,7 @@ mm() -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

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,12 +48,64 @@ 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"
 ```
+
+## Importing files from other CAD systems
+
+`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.
+```
+
+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"
+```
+
+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"
+```
+
+When importing a GLTF file, the bin file will be imported as well.
+
+Import paths are relative to the current project directory. Imports currently only work when
+using the native Modeling App, not in the browser.
+
+### Supported values
+
+File formats: `fbx`, `gltf`/`glb`, `obj`+, `ply`+, `sldprt`, `step`/`stp`, `stl`+. (Those marked with a
+'+' support customising the length unit and coordinate system).
+
+Length units: `mm` (the default), `cm`, `m`, `inch`, `ft`, `yd`.
+
+Coordinate systems:
+
+- `zoo` (the default), forward: -Y, up: +Z, handedness: right
+- `opengl`, forward: +Z, up: +Y, handedness: right
+- `vulkan`, forward: +Z, up: -Y, handedness: left

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(data: CircularPattern2dData, sketch_set: SketchSet) -> [Sketch]
+patternCircular2d(
+  sketchSet: SketchSet,
+  instances: integer,
+  center: [number],
+  arcDegrees: number,
+  rotateDuplicates: bool,
+  useOriginal?: bool,
+) -> [Sketch]
 ```
 
 
@@ -17,12 +24,16 @@ patternCircular2d(data: CircularPattern2dData, sketch_set: SketchSet) -> [Sketch
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `data` | [`CircularPattern2dData`](/docs/kcl/types/CircularPattern2dData) | Data for a circular pattern on a 2D sketch. | Yes |
-| `sketch_set` | [`SketchSet`](/docs/kcl/types/SketchSet) | A sketch or a group of sketches. | Yes |
+| `sketchSet` | [`SketchSet`](/docs/kcl/types/SketchSet) | Which sketch(es) to pattern | Yes |
+| `instances` | `integer` | The number of total instances. Must be greater than or equal to 1. This includes the original entity. For example, if instances is 2, there will be two copies -- the original, and one new copy. If instances is 1, this has no effect. | Yes |
+| `center` | `[number]` | The center about which to make the pattern. This is a 2D vector. | Yes |
+| `arcDegrees` | `number` | The arc angle (in degrees) to place the repetitions. Must be greater than 0. | Yes |
+| `rotateDuplicates` | `bool` | Whether or not to rotate the duplicates as they are copied. | Yes |
+| `useOriginal` | `bool` | If the target was sketched on an extrusion, setting this will use the original sketch as the target, not the entire joined solid. Defaults to false. | No |
 
 ### Returns
 
-[`[Sketch]`](/docs/kcl/types/Sketch) 
+[`[Sketch]`](/docs/kcl/types/Sketch)
 
 
 ### Examples
@@ -34,12 +45,12 @@ exampleSketch = startSketchOn('XZ')
   |> line(end = [-1, 0])
   |> line(end = [0, -5])
   |> close()
-  |> patternCircular2d({
+  |> patternCircular2d(
        center = [0, 0],
        instances = 13,
        arcDegrees = 360,
-       rotateDuplicates = true
-     }, %)
+       rotateDuplicates = true,
+     )
 
 example = extrude(exampleSketch, length = 1)
 ```