fix: revert quick file write on refresh (#5943)

* fix: REVERT REVERT REVERT

* fix: one more unused remove

* A snapshot a day keeps the bugs away! 📷🐛

* A snapshot a day keeps the bugs away! 📷🐛

* A snapshot a day keeps the bugs away! 📷🐛

* Make sure connection is established before advancing settings theme test

* A snapshot a day keeps the bugs away! 📷🐛

* A snapshot a day keeps the bugs away! 📷🐛

* A snapshot a day keeps the bugs away! 📷🐛

* A snapshot a day keeps the bugs away! 📷🐛

* A snapshot a day keeps the bugs away! 📷🐛

* A snapshot a day keeps the bugs away! 📷🐛

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Frank Noirot <frankjohnson1993@gmail.com>

.codespellrc

@@ -1,3 +1,3 @@
 [codespell]
 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
+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,./public/kcl-samples,./rust/kcl-lib/tests/kcl_samples,tsconfig.tsbuildinfo

.eslintrc

@@ -22,6 +22,13 @@
     "rules": {
       "@typescript-eslint/no-floating-promises": "error",
       "@typescript-eslint/no-misused-promises": "error",
+      "@typescript-eslint/no-unused-vars": ["error", {
+        "varsIgnorePattern": "^_",
+        "argsIgnorePattern": "^_",
+        "ignoreRestSiblings": true,
+        "vars": "all",
+        "args": "none"
+      }],
       "jsx-a11y/click-events-have-key-events": "off",
       "jsx-a11y/no-autofocus": "off",
       "jsx-a11y/no-noninteractive-element-interactions": "off",

.github/actions/github-release/package.json

@@ -4,7 +4,7 @@
   "main": "main.js",
   "dependencies": {
     "@actions/core": "^1.6",
-    "@actions/github": "^5.0",
-    "glob": "^7.1.5"
+    "@actions/github": "^6.0",
+    "glob": "^11.0.1"
   }
 }

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

@@ -4,27 +4,27 @@
 set -euo pipefail
 
 if [[ ! -f "test-results/.last-run.json" ]]; then
-    # if no last run artifact, than run plawright normally
+    # If no last run artifact, than run Playwright normally
     echo "run playwright normally"
-        if [[ "$3" == *ubuntu* ]]; then
-            xvfb-run --auto-servernum --server-args="-screen 0 1280x960x24" -- yarn test:playwright:electron:ubuntu -- --shard=$1/$2 || true
-        elif [[ "$3" == *windows* ]]; then
-            yarn test:playwright:electron:windows -- --shard=$1/$2 || true
-        elif [[ "$3" == *macos* ]]; then
-            yarn test:playwright:electron:macos  -- --shard=$1/$2 || true
-        else
-            echo "Do not run playwright. Unable to detect os runtime."
-            exit 1
-        fi
-        # # send to axiom
-        node playwrightProcess.mjs | tee /tmp/github-actions.log > /dev/null 2>&1
+    if [[ "$3" == *ubuntu* ]]; then
+        xvfb-run --auto-servernum --server-args="-screen 0 1280x960x24" -- yarn test:playwright:electron:ubuntu -- --shard=$1/$2 || true
+    elif [[ "$3" == *windows* ]]; then
+        yarn test:playwright:electron:windows -- --shard=$1/$2 || true
+    elif [[ "$3" == *macos* ]]; then
+        yarn test:playwright:electron:macos  -- --shard=$1/$2 || true
+    else
+        echo "Do not run Playwright. Unable to detect os runtime."
+        exit 1
+    fi
+    # Log failures for Axiom to pick up
+    node playwrightProcess.mjs > /tmp/github-actions.log
 fi
 
 retry=1
-max_retrys=1
+max_retries=1
 
-# retry failed tests, doing our own retries because using inbuilt playwright retries causes connection issues
-while [[ $retry -le $max_retrys ]]; do
+# Retry failed tests, doing our own retries because using inbuilt Playwright retries causes connection issues
+while [[ $retry -le $max_retries ]]; do
     if [[ -f "test-results/.last-run.json" ]]; then
         failed_tests=$(jq '.failedTests | length' test-results/.last-run.json)
         if [[ $failed_tests -gt 0 ]]; then
@@ -40,8 +40,8 @@ while [[ $retry -le $max_retrys ]]; do
                 echo "Do not run playwright. Unable to detect os runtime."
                 exit 1
             fi
-            # send to axiom
-            node playwrightProcess.mjs | tee /tmp/github-actions.log > /dev/null 2>&1
+            # Log failures for Axiom to pick up
+            node playwrightProcess.mjs > /tmp/github-actions.log
             retry=$((retry + 1))
         else
             echo "retried=false" >>$GITHUB_OUTPUT
@@ -58,7 +58,7 @@ echo "retried=false" >>$GITHUB_OUTPUT
 if [[ -f "test-results/.last-run.json" ]]; then
     failed_tests=$(jq '.failedTests | length' test-results/.last-run.json)
     if [[ $failed_tests -gt 0 ]]; then
-        # if it still fails after 3 retrys, then fail the job
+        # If it still fails after 3 retries, then fail the job
         exit 1
     fi
 fi

.github/dependabot.yml

@@ -1,50 +1,298 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+# DO NOT EDIT THIS FILE. This dependabot file was generated 
+# by https://github.com/KittyCAD/ciso Changes to this file should be addressed in 
+# the ciso repository.
 
 version: 2
 updates:
-  - package-ecosystem: 'npm' # See documentation for possible values
-    directories:
-      - '/'
-      - '/packages/codemirror-lang-kcl/'
-      - '/packages/codemirror-lsp-client/'
-      - '/rust/kcl-language-server/'
-    schedule:
-      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
-      day: monday
-    reviewers:
-      - adamchalmers
-      - jessfraz
-  - package-ecosystem: 'cargo' # See documentation for possible values
-    directory: '/rust/' # Location of package manifests
-    schedule:
-      interval: weekly
-      day: monday
-    reviewers:
-      - adamchalmers
-      - jessfraz
-    groups:
-      serde-dependencies:
-        patterns:
-          - "serde*"
-      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
+- package-ecosystem: github-actions
+  directory: /
+  schedule:
+    interval: weekly
+    day: monday
+    time: '03:00'
+    timezone: America/Los_Angeles
+  open-pull-requests-limit: 5
+  groups:
+    security:
+      applies-to: security-updates
+      update-types:
+      - major
+      - minor
+      - patch
+    patch:
+      applies-to: version-updates
+      update-types:
+      - patch
+    major:
+      applies-to: version-updates
+      update-types:
+      - major
+    minor:
+      applies-to: version-updates
+      update-types:
+      - minor
+      - patch
+- package-ecosystem: cargo
+  directory: /rust
+  schedule:
+    interval: weekly
+    day: monday
+    time: '03:00'
+    timezone: America/Los_Angeles
+  open-pull-requests-limit: 5
+  reviewers:
+  - adamchalmers
+  - franknoirot
+  - irev-dev
+  - jessfraz
+  groups:
+    security:
+      applies-to: security-updates
+      update-types:
+      - major
+      - minor
+      - patch
+    patch:
+      applies-to: version-updates
+      update-types:
+      - patch
+    major:
+      applies-to: version-updates
+      update-types:
+      - major
+    minor:
+      applies-to: version-updates
+      update-types:
+      - minor
+      - patch
+- package-ecosystem: npm
+  directory: /
+  schedule:
+    interval: weekly
+    day: monday
+    time: '03:00'
+    timezone: America/Los_Angeles
+  open-pull-requests-limit: 5
+  reviewers:
+  - adamchalmers
+  - franknoirot
+  - irev-dev
+  - jessfraz
+  groups:
+    security:
+      applies-to: security-updates
+      update-types:
+      - major
+      - minor
+      - patch
+    patch:
+      applies-to: version-updates
+      update-types:
+      - patch
+    major:
+      applies-to: version-updates
+      update-types:
+      - major
+    minor:
+      applies-to: version-updates
+      update-types:
+      - minor
+      - patch
+- package-ecosystem: npm
+  directory: /rust/kcl-language-server
+  schedule:
+    interval: weekly
+    day: monday
+    time: '03:00'
+    timezone: America/Los_Angeles
+  open-pull-requests-limit: 5
+  reviewers:
+  - adamchalmers
+  - franknoirot
+  - irev-dev
+  - jessfraz
+  groups:
+    security:
+      applies-to: security-updates
+      update-types:
+      - major
+      - minor
+      - patch
+    patch:
+      applies-to: version-updates
+      update-types:
+      - patch
+    major:
+      applies-to: version-updates
+      update-types:
+      - major
+    minor:
+      applies-to: version-updates
+      update-types:
+      - minor
+      - patch
+- package-ecosystem: npm
+  directory: /packages/codemirror-lang-kcl
+  schedule:
+    interval: weekly
+    day: monday
+    time: '03:00'
+    timezone: America/Los_Angeles
+  open-pull-requests-limit: 5
+  reviewers:
+  - adamchalmers
+  - franknoirot
+  - irev-dev
+  - jessfraz
+  groups:
+    security:
+      applies-to: security-updates
+      update-types:
+      - major
+      - minor
+      - patch
+    patch:
+      applies-to: version-updates
+      update-types:
+      - patch
+    major:
+      applies-to: version-updates
+      update-types:
+      - major
+    minor:
+      applies-to: version-updates
+      update-types:
+      - minor
+      - patch
+- package-ecosystem: npm
+  directory: /packages/codemirror-lsp-client
+  schedule:
+    interval: weekly
+    day: monday
+    time: '03:00'
+    timezone: America/Los_Angeles
+  open-pull-requests-limit: 5
+  reviewers:
+  - adamchalmers
+  - franknoirot
+  - irev-dev
+  - jessfraz
+  groups:
+    security:
+      applies-to: security-updates
+      update-types:
+      - major
+      - minor
+      - patch
+    patch:
+      applies-to: version-updates
+      update-types:
+      - patch
+    major:
+      applies-to: version-updates
+      update-types:
+      - major
+    minor:
+      applies-to: version-updates
+      update-types:
+      - minor
+      - patch
+- package-ecosystem: npm
+  directory: /.github/actions/github-release
+  schedule:
+    interval: weekly
+    day: monday
+    time: '03:00'
+    timezone: America/Los_Angeles
+  open-pull-requests-limit: 5
+  reviewers:
+  - adamchalmers
+  - franknoirot
+  - irev-dev
+  - jessfraz
+  groups:
+    security:
+      applies-to: security-updates
+      update-types:
+      - major
+      - minor
+      - patch
+    patch:
+      applies-to: version-updates
+      update-types:
+      - patch
+    major:
+      applies-to: version-updates
+      update-types:
+      - major
+    minor:
+      applies-to: version-updates
+      update-types:
+      - minor
+      - patch
+- package-ecosystem: pip
+  directory: /rust/kcl-python-bindings
+  schedule:
+    interval: weekly
+    day: monday
+    time: '03:00'
+    timezone: America/Los_Angeles
+  open-pull-requests-limit: 5
+  reviewers:
+  - adamchalmers
+  - franknoirot
+  - irev-dev
+  - jessfraz
+  groups:
+    security:
+      applies-to: security-updates
+      update-types:
+      - major
+      - minor
+      - patch
+    patch:
+      applies-to: version-updates
+      update-types:
+      - patch
+    major:
+      applies-to: version-updates
+      update-types:
+      - major
+    minor:
+      applies-to: version-updates
+      update-types:
+      - minor
+      - patch
+- package-ecosystem: docker
+  directory: /.github/actions/github-release
+  schedule:
+    interval: weekly
+    day: monday
+    time: '03:00'
+    timezone: America/Los_Angeles
+  open-pull-requests-limit: 5
+  reviewers:
+  - adamchalmers
+  - franknoirot
+  - irev-dev
+  - jessfraz
+  groups:
+    security:
+      applies-to: security-updates
+      update-types:
+      - major
+      - minor
+      - patch
+    patch:
+      applies-to: version-updates
+      update-types:
+      - patch
+    major:
+      applies-to: version-updates
+      update-types:
+      - major
+    minor:
+      applies-to: version-updates
+      update-types:
+      - minor
+      - patch

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

@@ -16,15 +16,21 @@ jobs:
           cache: 'yarn'
       - name: Install dependencies
         run: yarn
-      - name: Setup Rust
-        uses: dtolnay/rust-toolchain@stable
-      - name: Cache wasm
-        uses: Swatinem/rust-cache@v2
+      - name: Use correct Rust toolchain
+        shell: bash
+        run: |
+          [ -e rust-toolchain.toml ] || cp rust/rust-toolchain.toml ./
+      - name: Install rust
+        uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
-          workspaces: './rust'
-      - uses: taiki-e/install-action@955a6ff1416eae278c9f833008a9beb4b7f9afe3
+          cache: false # Configured below.
+      - uses: taiki-e/install-action@37bdc826eaedac215f638a96472df572feab0f9b
         with:
           tool: wasm-pack
+      - name: Rust Cache
+        uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: rust
       - name: build wasm
         run: yarn build:wasm
 

.github/workflows/build-apps.yml

@@ -33,19 +33,63 @@ jobs:
 
       - run: yarn install
 
-      - name: Setup Rust
-        uses: dtolnay/rust-toolchain@stable
-
-      - uses: Swatinem/rust-cache@v2
+      - id: filter
+        name: Check for Rust changes
+        uses: dorny/paths-filter@v3
         with:
-          workspaces: './rust'
+          filters: |
+            rust:
+              - 'rust/**'
 
-      # TODO: see if we can fetch from main instead if no diff at rust
-      - uses: taiki-e/install-action@955a6ff1416eae278c9f833008a9beb4b7f9afe3
+      - name: Download Wasm Cache
+        id: download-wasm
+        if: ${{ github.event_name == 'pull_request' && steps.filter.outputs.rust == 'false' }}
+        uses: dawidd6/action-download-artifact@v7
+        continue-on-error: true
+        with:
+          github_token: ${{secrets.GITHUB_TOKEN}}
+          name: wasm-bundle
+          workflow: build-and-store-wasm.yml
+          branch: main
+          path: rust/kcl-wasm-lib/pkg
+
+      - name: Build WASM condition
+        id: wasm
+        run: |
+          set -euox pipefail
+          # Build wasm if this is a push to main or tag, there are Rust changes, or
+          # downloading from the wasm cache failed.
+          if [[ ${{github.event_name}} == 'push' || ${{steps.filter.outputs.rust}} == 'true' || ${{steps.download-wasm.outcome}} == 'failure' ]]; then
+            echo "should-build-wasm=true" >> $GITHUB_OUTPUT
+          else
+            echo "should-build-wasm=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Use correct Rust toolchain
+        if: ${{ steps.wasm.outputs.should-build-wasm == 'true' }}
+        shell: bash
+        run: |
+          [ -e rust-toolchain.toml ] || cp rust/rust-toolchain.toml ./
+
+      - name: Install rust
+        if: ${{ steps.wasm.outputs.should-build-wasm == 'true' }}
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          cache: false # Configured below.
+
+      - uses: taiki-e/install-action@37bdc826eaedac215f638a96472df572feab0f9b
+        if: ${{ steps.wasm.outputs.should-build-wasm == 'true' }}
         with:
           tool: wasm-pack
 
+      - name: Rust Cache
+        if: ${{ steps.wasm.outputs.should-build-wasm == 'true' }}
+        uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: rust
+
       - name: Run build:wasm
+        if: ${{ steps.wasm.outputs.should-build-wasm == 'true' }}
         run: "yarn build:wasm"
 
       - name: Set nightly version, product name, release notes, and icons

.github/workflows/cargo-bench.yml

@@ -0,0 +1,62 @@
+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:
+  contents: read
+  pull-requests: write
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+name: cargo bench
+jobs:
+  cargo-bench:
+    name: cargo bench
+    runs-on:
+      - runs-on=${{ github.run_id }}
+      - runner=32cpu-linux-x64
+      - extras=s3-cache
+    steps:
+      - uses: runs-on/action@v1
+      - uses: actions/checkout@v4
+      - name: Use correct Rust toolchain
+        shell: bash
+        run: |
+          [ -e rust-toolchain.toml ] || cp rust/rust-toolchain.toml ./
+      - name: Install rust
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          cache: rust
+      - name: Install dependencies
+        run: |
+          cargo install cargo-criterion
+          cargo install cargo-codspeed
+          cd rust/kcl-lib
+          cargo add --dev codspeed-criterion-compat --rename criterion
+      - name: Build the benchmark target(s)
+        run: |
+          cd rust
+          cargo codspeed build --measurement-mode walltime
+      - name: Run the benchmarks
+        uses: CodSpeedHQ/action@v3
+        with:
+          working-directory: rust
+          run: cargo codspeed run
+          token: ${{ secrets.CODSPEED_TOKEN }}
+          mode: walltime
+        env:
+          KITTYCAD_API_TOKEN: ${{ secrets.KITTYCAD_API_TOKEN }}

.github/workflows/cargo-check.yml

@@ -22,7 +22,7 @@ jobs:
       - name: Use correct Rust toolchain
         shell: bash
         run: |
-          cp --update=none rust/rust-toolchain.toml ./ || true
+          [ -e rust-toolchain.toml ] || cp rust/rust-toolchain.toml ./
       - name: Install rust
         uses: actions-rust-lang/setup-rust-toolchain@v1
         with:

.github/workflows/cargo-clippy.yml

@@ -29,7 +29,7 @@ jobs:
       - name: Use correct Rust toolchain
         shell: bash
         run: |
-          cp --update=none rust/rust-toolchain.toml ./ || true
+          [ -e rust-toolchain.toml ] || cp rust/rust-toolchain.toml ./
       - name: Install rust
         uses: actions-rust-lang/setup-rust-toolchain@v1
         with:

.github/workflows/cargo-fmt.yml

@@ -31,7 +31,7 @@ jobs:
       - name: Use correct Rust toolchain
         shell: bash
         run: |
-          cp --update=none rust/rust-toolchain.toml ./ || true
+          [ -e rust-toolchain.toml ] || cp rust/rust-toolchain.toml ./
       - name: Install rust
         uses: actions-rust-lang/setup-rust-toolchain@v1
         with:

.github/workflows/cargo-test.yml

@@ -5,7 +5,9 @@ on:
 
   pull_request:
   workflow_dispatch:
-permissions: read-all
+permissions:
+  contents: read
+  pull-requests: write
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
@@ -15,11 +17,19 @@ jobs:
     name: cargo test
     runs-on: ubuntu-latest-8-cores
     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 }}
       - name: Use correct Rust toolchain
         shell: bash
         run: |
-          cp --update=none rust/rust-toolchain.toml ./ || true
+          [ -e rust-toolchain.toml ] || cp rust/rust-toolchain.toml ./
       - name: Install rust
         uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
@@ -40,11 +50,86 @@ jobs:
           ${HOME}/.vector/bin/vector --config /tmp/vector.toml &
       - uses: taiki-e/install-action@cargo-llvm-cov
       - uses: taiki-e/install-action@nextest
+      - name: Install just
+        uses: taiki-e/install-action@just
+      - name: Install cargo-insta
+        shell: bash
+        run: |
+          cargo install cargo-insta
       - name: Rust Cache
-        uses: Swatinem/rust-cache@v2.6.1
+        uses: Swatinem/rust-cache@v2
         with:
           workspaces: rust
+      - name: Fetch the base branch
+        if: ${{ github.event_name == 'pull_request' }}
+        run: git fetch origin ${{ github.base_ref }} --depth=1
+      - name: Check for path changes
+        id: path-changes
+        shell: bash
+        run: |
+          set -euo pipefail
+
+          # Manual runs or push should run all tests.
+          if [[ ${{ github.event_name }} != 'pull_request' ]]; then
+            echo "outside-kcl-samples=true" >> $GITHUB_OUTPUT
+            exit 0
+          fi
+
+          changed_files=$(git diff --name-only origin/${{ github.base_ref }})
+          echo "$changed_files"
+          if grep -Evq '^public/kcl-samples/|^rust/kcl-lib/tests/kcl_samples/' <<< "$changed_files" ; then
+            echo "outside-kcl-samples=true" >> $GITHUB_OUTPUT
+          else
+            echo "outside-kcl-samples=false" >> $GITHUB_OUTPUT
+          fi
+      - name: cargo test only kcl-samples
+        id: cargo-test-kcl-samples
+        if: steps.path-changes.outputs.outside-kcl-samples == 'false'
+        continue-on-error: true
+        shell: bash
+        run: |
+          set -euo pipefail
+          cd rust
+          cargo nextest run --workspace --retries=2 --no-fail-fast --profile ci simulation_tests::kcl_samples 2>&1 | tee /tmp/github-actions.log
+        env:
+          KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
+          RUST_BACKTRACE: full
+          RUST_MIN_STACK: 10485760000
+      - name: Commit differences
+        if: steps.path-changes.outputs.outside-kcl-samples == 'false' && steps.cargo-test-kcl-samples.outcome == 'failure'
+        shell: bash
+        run: |
+          set -euo pipefail
+          pushd rust
+          just overwrite-sim-test kcl_samples
+          popd
+          git add \
+            rust/kcl-lib/tests \
+            public/kcl-samples/manifest.json \
+            public/kcl-samples/README.md \
+            public/kcl-samples/screenshots
+          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
+          git fetch origin
+          echo ${{ github.head_ref }}
+          git checkout ${{ github.head_ref }}
+          if ! git commit -m "Update kcl-samples simulation test output" ; then
+            echo "No changes to commit"
+            # This only runs if tests failed, so we should fail the step.
+            exit 1
+          fi
+          git push origin ${{ github.head_ref }}
+        env:
+          # The default is auto, and insta behaves differently in CI vs. not.
+          INSTA_UPDATE: always
+          KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
+          # Configure nextest when it's run by insta (via just).
+          NEXTEST_PROFILE: ci
+          RUST_BACKTRACE: full
+          RUST_MIN_STACK: 10485760000
       - name: cargo test
+        if: steps.path-changes.outputs.outside-kcl-samples == 'true'
         shell: bash
         run: |-
           cd rust
@@ -53,6 +138,7 @@ jobs:
           KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
           RUST_MIN_STACK: 10485760000
       - name: Upload to codecov.io
+        if: steps.path-changes.outputs.outside-kcl-samples == 'true'
         uses: codecov/codecov-action@v5
         with:
           token: ${{secrets.CODECOV_TOKEN}}

.github/workflows/check-kcl-header.yml

@@ -0,0 +1,48 @@
+name: Check kcl-samples files for proper header structure
+
+on:
+  pull_request:
+    paths:
+      - 'public/kcl-samples/**/*.kcl'
+      - .github/workflows/check-kcl-header.yml
+    branches:
+      - main
+  push:
+    paths:
+      - 'public/kcl-samples/**/*.kcl'
+      - .github/workflows/check-kcl-header.yml
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  check-kcl-header:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Check KCL files for header comment block and blank line
+        run: |
+          files=$(find public/kcl-samples -type f -name '*.kcl')
+          failed_files=()
+
+          for file in $files; do
+            if ! awk '
+              NR == 1 && $0 !~ /^\/\// { exit 1 }
+              BEGIN { in_comment = 1 }
+              NF == 0 && in_comment == 1 { in_comment = 0; next }
+              $1 !~ /^\/\// && in_comment == 1 { exit 1 }
+              in_comment == 0 && NF > 0 { exit 0 }
+              END { if (in_comment == 1) exit 1 }
+              ' "$file"; then
+              failed_files+=("$file")
+            fi
+          done
+
+          if [ ${#failed_files[@]} -ne 0 ]; then
+            echo "One or more KCL files do not begin with a header comment block followed by a blank line:"
+            printf '%s\n' "${failed_files[@]}"
+            exit 1
+          fi

.github/workflows/e2e-tests.yml

@@ -17,211 +17,384 @@ permissions:
 
 
 jobs:
+
+  conditions:
+    runs-on: ubuntu-latest
+    outputs:
+      significant: ${{ steps.path-changes.outputs.significant }}
+      should-run: ${{ steps.should-run.outputs.should-run }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Fetch the base branch
+        if: ${{ github.event_name == 'pull_request' }}
+        run: git fetch origin ${{ github.base_ref }} --depth=1
+
+      - name: Check for path changes
+        id: path-changes
+        shell: bash
+        run: |
+          set -euo pipefail
+
+          # Manual runs or push should run all tests.
+          if [[ ${{ github.event_name }} != 'pull_request' ]]; then
+            echo "significant=true" >> $GITHUB_OUTPUT
+            exit 0
+          fi
+
+          changed_files=$(git diff --name-only origin/${{ github.base_ref }})
+          echo "$changed_files"
+          if grep -Evq '^README.md|^public/kcl-samples/|^rust/kcl-lib/tests/kcl_samples/' <<< "$changed_files" ; then
+            echo "significant=true" >> $GITHUB_OUTPUT
+          else
+            echo "significant=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Should run
+        id: should-run
+        shell: bash
+        run: |
+          set -euo pipefail
+          # We should run when this is a scheduled run or if there are
+          # significant changes in the diff.
+          if [[ ${{ github.event_name }} == 'schedule' || ${{ steps.path-changes.outputs.significant }} == 'true' ]]; then
+            echo "should-run=true" >> $GITHUB_OUTPUT
+          else
+            echo "should-run=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Display conditions
+        shell: bash
+        run: |
+          # For debugging purposes.
+          set -euo pipefail
+          echo "significant: ${{ steps.path-changes.outputs.significant }}"
+          echo "should-run: ${{ steps.should-run.outputs.should-run }}"
+
+
+  prepare-wasm:
+    # seperate job on Ubuntu to build or fetch the wasm blob once on the fastest runner
+    runs-on: runs-on=${{ github.run_id }}/family=i7ie.2xlarge/image=ubuntu22-full-x64
+    needs: conditions
+    steps:
+      - uses: actions/checkout@v4
+        if: needs.conditions.outputs.should-run == 'true'
+
+      - id: filter
+        if: needs.conditions.outputs.should-run == 'true'
+        name: Check for Rust changes
+        uses: dorny/paths-filter@v3
+        with:
+          filters: |
+            rust:
+              - 'rust/**'
+
+      - uses: actions/setup-node@v4
+        if: needs.conditions.outputs.should-run == 'true'
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
+
+      - name: Install dependencies
+        if: needs.conditions.outputs.should-run == 'true'
+        run: yarn
+
+      - name: Download Wasm Cache
+        id: download-wasm
+        if: ${{ needs.conditions.outputs.should-run == 'true' && github.event_name != 'schedule' && steps.filter.outputs.rust == 'false' }}
+        uses: dawidd6/action-download-artifact@v7
+        continue-on-error: true
+        with:
+          github_token: ${{secrets.GITHUB_TOKEN}}
+          name: wasm-bundle
+          workflow: build-and-store-wasm.yml
+          branch: main
+          path: rust/kcl-wasm-lib/pkg
+
+      - name: Build WASM condition
+        id: wasm
+        if: needs.conditions.outputs.should-run == 'true'
+        run: |
+          set -euox pipefail
+          # Build wasm if this is a scheduled run, there are Rust changes, or
+          # downloading from the wasm cache failed.
+          if [[ ${{github.event_name}} == 'schedule' || ${{steps.filter.outputs.rust}} == 'true' || ${{steps.download-wasm.outcome}} == 'failure' ]]; then
+            echo "should-build-wasm=true" >> $GITHUB_OUTPUT
+          else
+            echo "should-build-wasm=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Use correct Rust toolchain
+        if: ${{ needs.conditions.outputs.should-run == 'true' && steps.wasm.outputs.should-build-wasm == 'true' }}
+        shell: bash
+        run: |
+          [ -e rust-toolchain.toml ] || cp rust/rust-toolchain.toml ./
+
+      - name: Install rust
+        if: ${{ needs.conditions.outputs.should-run == 'true' && steps.wasm.outputs.should-build-wasm == 'true' }}
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          cache: false # Configured below.
+
+      - uses: taiki-e/install-action@37bdc826eaedac215f638a96472df572feab0f9b
+        if: ${{ needs.conditions.outputs.should-run == 'true' && steps.wasm.outputs.should-build-wasm == 'true' }}
+        with:
+          tool: wasm-pack
+
+      - name: Rust Cache
+        if: ${{ needs.conditions.outputs.should-run == 'true' && steps.wasm.outputs.should-build-wasm == 'true' }}
+        uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: './rust'
+
+      - name: Build Wasm
+        if: ${{ needs.conditions.outputs.should-run == 'true' && steps.wasm.outputs.should-build-wasm == 'true' }}
+        shell: bash
+        run: yarn build:wasm
+
+      - uses: actions/upload-artifact@v4
+        if: needs.conditions.outputs.should-run == 'true'
+        with:
+          name: prepared-wasm
+          path: |
+            rust/kcl-wasm-lib/pkg/kcl_wasm_lib*
+  
+
+  snapshots:
+    name: playwright:snapshots:ubuntu
+    runs-on: runs-on=${{ github.run_id }}/family=i7ie.2xlarge/image=ubuntu22-full-x64
+    needs: [conditions, prepare-wasm]
+    steps:
+      - uses: actions/create-github-app-token@v1
+        if: needs.conditions.outputs.should-run == 'true'
+        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
+        if: needs.conditions.outputs.should-run == 'true'
+        with:
+          token: ${{ steps.app-token.outputs.token }}
+
+      - uses: actions/download-artifact@v4
+        if: needs.conditions.outputs.should-run == 'true'
+        name: prepared-wasm
+
+      - name: Copy prepared wasm
+        if: needs.conditions.outputs.should-run == 'true'
+        run: |
+          ls -R prepared-wasm
+          cp prepared-wasm/kcl_wasm_lib_bg.wasm public
+          mkdir rust/kcl-wasm-lib/pkg
+          cp prepared-wasm/kcl_wasm_lib* rust/kcl-wasm-lib/pkg
+
+      - uses: actions/setup-node@v4
+        if: needs.conditions.outputs.should-run == 'true'
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
+
+      - name: Install dependencies
+        id: deps-install
+        if: needs.conditions.outputs.should-run == 'true'
+        run: yarn
+
+      - name: Cache Playwright Browsers
+        if: needs.conditions.outputs.should-run == 'true'
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/ms-playwright/
+          key: ${{ runner.os }}-playwright-${{ hashFiles('yarn.lock') }}
+
+      - name: Install Playwright Browsers
+        if: needs.conditions.outputs.should-run == 'true'
+        run: yarn playwright install --with-deps
+
+      - name: build web
+        if: needs.conditions.outputs.should-run == 'true'
+        run: yarn tronb:vite:dev
+
+      - name: Run ubuntu/chrome snapshots
+        if: needs.conditions.outputs.should-run == 'true'
+        uses: nick-fields/retry@v3.0.2
+        with:
+          shell: bash
+          command: yarn test:snapshots
+          timeout_minutes: 30
+          max_attempts: 3
+        env:
+          CI: true
+          NODE_ENV: development
+          VITE_KC_DEV_TOKEN: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
+          VITE_KC_SKIP_AUTH: true
+          token: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
+          snapshottoken: ${{ secrets.KITTYCAD_API_TOKEN }}
+
+      - uses: actions/upload-artifact@v4
+        if: ${{ needs.conditions.outputs.should-run == 'true' && !cancelled() && (success() || failure()) }}
+        with:
+          name: playwright-report-ubuntu-snapshot-${{ github.sha }}
+          path: playwright-report/
+          include-hidden-files: true
+          retention-days: 30
+          overwrite: true
+
+      - name: check for changes
+        if: ${{ needs.conditions.outputs.should-run == 'true' && github.ref != 'refs/heads/main' }}
+        shell: bash
+        id: git-check
+        run: |
+            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
+            fi
+
+      - name: Commit changes, if any
+        if: ${{ needs.conditions.outputs.should-run == 'true' && steps.git-check.outputs.modified == 'true' }}
+        shell: bash
+        run: |
+          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
+          git fetch origin
+          echo ${{ github.head_ref }}
+          git checkout ${{ github.head_ref }}
+          git commit -m "A snapshot a day keeps the bugs away! 📷🐛" || true
+          git push
+          git push origin ${{ github.head_ref }}
+
   electron:
+    needs: [conditions, prepare-wasm]
     timeout-minutes: 60
-    name: playwright:electron:${{ matrix.os }} ${{ matrix.shardIndex }} ${{ matrix.shardTotal }}
+    env:
+      OS_NAME: ${{ contains(matrix.os, 'ubuntu') && 'ubuntu' || (contains(matrix.os, 'windows') && 'windows' || 'macos') }}
+    name: playwright:electron:${{ contains(matrix.os, 'ubuntu') && 'ubuntu' || (contains(matrix.os, 'windows') && 'windows' || 'macos') }}:${{ matrix.shardIndex }}:${{ matrix.shardTotal }}
     strategy:
       fail-fast: false
       matrix:
-        # TODO: enable self-hosted-windows-8-cores once available
-        os: [namespace-profile-ubuntu-8-cores, namespace-profile-macos-8-cores, windows-16-cores]
+        # TODO: enable namespace-profile-windows-latest once available
+        os:
+          - "runs-on=${{ github.run_id }}/family=i7ie.2xlarge/image=ubuntu22-full-x64"
+          - namespace-profile-macos-8-cores
+          - windows-latest
         shardIndex: [1, 2, 3, 4]
         shardTotal: [4]
+        # Disable macos and windows tests on hourly e2e tests since we only care
+        # about server side changes.
+        # Technique from https://github.com/joaomcteixeira/python-project-skeleton/pull/31/files
+        isScheduled:
+          - ${{ github.event_name == 'schedule' }}
+        exclude:
+          - os: namespace-profile-macos-8-cores
+            isScheduled: true
+          - os: windows-latest
+            isScheduled: true
         # TODO: add ref here for main and latest release tag
     runs-on: ${{ matrix.os }}
     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 }}
-    - 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'
-    - name: Install dependencies
-      id: deps-install
-      shell: bash
-      run: yarn
-    - name: Cache Playwright Browsers
-      uses: actions/cache@v4
-      with:
-        path: |
-          ~/.cache/ms-playwright/
-        key: ${{ runner.os }}-playwright-${{ hashFiles('yarn.lock') }}
-    - name: Install Playwright Browsers
-      shell: bash
-      run: yarn playwright install --with-deps
-    - name: Download Wasm Cache
-      id: download-wasm
-      if: github.event_name != 'schedule' && steps.filter.outputs.rust == 'false'
-      uses: dawidd6/action-download-artifact@v7
-      continue-on-error: true
-      with:
-        github_token: ${{secrets.GITHUB_TOKEN}}
-        name: wasm-bundle
-        workflow: build-and-store-wasm.yml
-        branch: main
-        path: rust/kcl-wasm-lib/pkg
-    - name: copy wasm blob
-      if: github.event_name != 'schedule' && steps.filter.outputs.rust == 'false'
-      shell: bash
-      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@955a6ff1416eae278c9f833008a9beb4b7f9afe3
-      with:
-        tool: wasm-pack
-    - name: Cache Wasm (because rust diff)
-      if: github.event_name == 'schedule' || steps.filter.outputs.rust == 'true'
-      uses: Swatinem/rust-cache@v2
-      with:
-        workspaces: './rust'
-    - name: OR Cache Wasm (because wasm cache failed)
-      if: steps.download-wasm.outcome == 'failure'
-      uses: Swatinem/rust-cache@v2
-      with:
-        workspaces: './rust'
-    - name: install good sed
-      if:  ${{ startsWith(matrix.os, 'macos') }}
-      shell: bash
-      run: |
-        brew install gnu-sed
-        echo "/opt/homebrew/opt/gnu-sed/libexec/gnubin" >> $GITHUB_PATH
-    - name: Install vector
-      shell: bash
-      # TODO: figure out what to do with this, it's failing
-      if: false
-      run: |
-        curl --proto '=https' --tlsv1.2 -sSfL https://sh.vector.dev > /tmp/vector.sh
-        chmod +x /tmp/vector.sh
-        /tmp/vector.sh -y -no-modify-path
-        mkdir -p /tmp/vector
-        cp .github/workflows/vector.toml /tmp/vector.toml
-        sed -i "s#GITHUB_WORKFLOW#${GITHUB_WORKFLOW}#g" /tmp/vector.toml
-        sed -i "s#GITHUB_REPOSITORY#${GITHUB_REPOSITORY}#g" /tmp/vector.toml
-        sed -i "s#GITHUB_SHA#${GITHUB_SHA}#g" /tmp/vector.toml
-        sed -i "s#GITHUB_REF_NAME#${GITHUB_REF_NAME}#g" /tmp/vector.toml
-        sed -i "s#GH_ACTIONS_AXIOM_TOKEN#${{secrets.GH_ACTIONS_AXIOM_TOKEN}}#g" /tmp/vector.toml
-        cat /tmp/vector.toml
-        ${HOME}/.vector/bin/vector --config /tmp/vector.toml &
-    - name: Build Wasm (because rust diff)
-      if: github.event_name == 'schedule' || steps.filter.outputs.rust == 'true'
-      shell: bash
-      run: yarn build:wasm
-    - name: OR Build Wasm (because wasm cache failed)
-      if: steps.download-wasm.outcome == 'failure'
-      shell: bash
-      run: yarn build:wasm
-    - name: build web
-      shell: bash
-      run: yarn tronb:vite:dev
-    - name: Run ubuntu/chrome snapshots
-      if: ${{ matrix.os == 'namespace-profile-ubuntu-8-cores' && matrix.shardIndex == 1 }}
-      shell: bash
-      # 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: |
-        yarn test:snapshots
-      env:
-        CI: true
-        NODE_ENV: development
-        VITE_KC_DEV_TOKEN: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
-        VITE_KC_SKIP_AUTH: true
-        token: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
-        snapshottoken: ${{ secrets.KITTYCAD_API_TOKEN }}
-    - uses: actions/upload-artifact@v4
-      if: ${{ !cancelled() && (success() || failure()) }}
-      with:
-        name: playwright-report-snapshots-${{ matrix.os }}-snapshot-${{ matrix.shardIndex }}-${{ github.sha }}
-        path: playwright-report/
-        include-hidden-files: true
-        retention-days: 30
-        overwrite: true
-    - name: Clean up test-results
-      if: ${{ !cancelled() && (success() || failure()) }}
-      continue-on-error: true
-      run: rm -r test-results
-    - name: check for changes
-      if: ${{ matrix.os == 'namespace-profile-ubuntu-8-cores' && matrix.shardIndex == 1 && github.ref != 'refs/heads/main' }}
-      shell: bash
-      id: git-check
-      run: |
-          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
-          fi
-    - name: Commit changes, if any
-      if: steps.git-check.outputs.modified == 'true'
-      shell: bash
-      run: |
-        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
-        git fetch origin
-        echo ${{ github.head_ref }}
-        git checkout ${{ github.head_ref }}
-        git commit -m "A snapshot a day keeps the bugs away! 📷🐛 (OS: ${{matrix.os}})" || true
-        git push
-        git push origin ${{ github.head_ref }}
-    # only upload artifacts if there's actually changes
-    - uses: actions/upload-artifact@v4
-      if: steps.git-check.outputs.modified == 'true'
-      with:
-        name: playwright-report-${{ matrix.os }}-${{ matrix.shardIndex }}-${{ github.sha }}
-        path: playwright-report/
-        include-hidden-files: true
-        retention-days: 30
-    - uses: actions/download-artifact@v4
-      if: ${{ !cancelled() && (success() || failure()) }}
-      continue-on-error: true
-      with:
-        name: test-results-${{ matrix.os }}-${{ matrix.shardIndex }}-${{ github.sha }}
-        path: test-results/
-    - name: Run playwright/electron flow (with retries)
-      id: retry
-      if: ${{ !cancelled() && steps.deps-install.outcome == 'success' }}
-      uses: nick-fields/retry@v3.0.2
-      with:
-        shell: bash
-        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
-        NODE_ENV: development
-        VITE_KC_DEV_TOKEN: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
-        VITE_KC_SKIP_AUTH: true
-        token: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
-    - uses: actions/upload-artifact@v4
-      if: always()
-      with:
-        name: test-results-${{ matrix.os }}-${{ matrix.shardIndex }}-${{ github.sha }}
-        path: test-results/
-        include-hidden-files: true
-        retention-days: 30
-        overwrite: true
-    - uses: actions/upload-artifact@v4
-      if: always()
-      with:
-        name: playwright-report-${{ matrix.os }}-${{ matrix.shardIndex }}-${{ github.sha }}
-        path: playwright-report/
-        include-hidden-files: true
-        retention-days: 30
-        overwrite: true
+      - uses: actions/checkout@v4
+        if: needs.conditions.outputs.should-run == 'true'
 
+      - uses: actions/download-artifact@v4
+        if: needs.conditions.outputs.should-run == 'true'
+        name: prepared-wasm
+
+      - name: Copy prepared wasm
+        if: needs.conditions.outputs.should-run == 'true'
+        run: |
+          ls -R prepared-wasm
+          cp prepared-wasm/kcl_wasm_lib_bg.wasm public
+          mkdir rust/kcl-wasm-lib/pkg
+          cp prepared-wasm/kcl_wasm_lib* rust/kcl-wasm-lib/pkg
+
+      - uses: actions/setup-node@v4
+        if: needs.conditions.outputs.should-run == 'true'
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
+
+      - name: Install dependencies
+        id: deps-install
+        if: needs.conditions.outputs.should-run == 'true'
+        run: yarn
+
+      - name: Cache Playwright Browsers
+        if: needs.conditions.outputs.should-run == 'true'
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/ms-playwright/
+          key: ${{ runner.os }}-playwright-${{ hashFiles('yarn.lock') }}
+
+      - name: Install Playwright Browsers
+        if: needs.conditions.outputs.should-run == 'true'
+        run: yarn playwright install --with-deps
+
+      - name: Build web
+        if: needs.conditions.outputs.should-run == 'true'
+        run: yarn tronb:vite:dev
+
+      - name: Install vector
+        if: contains(matrix.os, 'ubuntu')
+        shell: bash
+        run: |
+          curl --proto '=https' --tlsv1.2 -sSfL https://sh.vector.dev > /tmp/vector.sh
+          chmod +x /tmp/vector.sh
+          /tmp/vector.sh -y -no-modify-path
+          mkdir -p /tmp/vector
+          cp .github/workflows/vector.toml /tmp/vector.toml
+          sed -i "s#GITHUB_WORKFLOW#${GITHUB_WORKFLOW}#g" /tmp/vector.toml
+          sed -i "s#GITHUB_REPOSITORY#${GITHUB_REPOSITORY}#g" /tmp/vector.toml
+          sed -i "s#GITHUB_SHA#${GITHUB_SHA}#g" /tmp/vector.toml
+          sed -i "s#GITHUB_REF_NAME#${GITHUB_REF_NAME}#g" /tmp/vector.toml
+          sed -i "s#GH_ACTIONS_AXIOM_TOKEN#${{secrets.GH_ACTIONS_AXIOM_TOKEN}}#g" /tmp/vector.toml
+          cat /tmp/vector.toml
+          ${HOME}/.vector/bin/vector --config /tmp/vector.toml &
+
+      - uses: actions/download-artifact@v4
+        if: ${{ needs.conditions.outputs.should-run == 'true' && !cancelled() && (success() || failure()) }}
+        continue-on-error: true
+        with:
+          name: test-results-${{ env.OS_NAME }}-${{ matrix.shardIndex }}-${{ github.sha }}
+          path: test-results/
+
+      - name: Run playwright/electron flow (with retries)
+        id: retry
+        if: ${{ needs.conditions.outputs.should-run == 'true' && !cancelled() && steps.deps-install.outcome == 'success' }}
+        uses: nick-fields/retry@v3.0.2
+        with:
+          shell: bash
+          command: .github/ci-cd-scripts/playwright-electron.sh ${{matrix.shardIndex}} ${{matrix.shardTotal}} ${{ env.OS_NAME }}
+          timeout_minutes: 45
+          max_attempts: 15
+        env:
+          CI: true
+          FAIL_ON_CONSOLE_ERRORS: true
+          NODE_ENV: development
+          VITE_KC_DEV_TOKEN: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
+          VITE_KC_SKIP_AUTH: true
+          token: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
+
+      - uses: actions/upload-artifact@v4
+        if: ${{ needs.conditions.outputs.should-run == 'true' && always() }}
+        with:
+          name: test-results-${{ env.OS_NAME }}-${{ matrix.shardIndex }}-${{ github.sha }}
+          path: test-results/
+          include-hidden-files: true
+          retention-days: 30
+          overwrite: true
+
+      - uses: actions/upload-artifact@v4
+        if: ${{ needs.conditions.outputs.should-run == 'true' && always() }}
+        with:
+          name: playwright-report-${{ env.OS_NAME }}-${{ matrix.shardIndex }}-${{ github.sha }}
+          path: playwright-report/
+          include-hidden-files: true
+          retention-days: 30
+          overwrite: true

.github/workflows/generate-website-docs.yml

@@ -5,6 +5,7 @@ on:
     paths:
       - .github/workflows/generate-website-docs.yml
       - 'docs/**'
+      - 'public/kcl-samples/**'
   pull_request:
     paths:
       - .github/workflows/generate-website-docs.yml
@@ -39,9 +40,21 @@ jobs:
           # cleanup old
           rm -rf documentation/content/pages/docs/kcl/*.md
           rm -rf documentation/content/pages/docs/kcl/types
+          rm -rf documentation/content/pages/docs/kcl/settings
+          rm -rf documentation/content/pages/docs/kcl/consts
           # move new
           mv -f docs/kcl/*.md documentation/content/pages/docs/kcl/
           mv -f docs/kcl/types documentation/content/pages/docs/kcl/
+          mv -f docs/kcl/settings documentation/content/pages/docs/kcl/
+          mv -f docs/kcl/consts documentation/content/pages/docs/kcl/
+      - name: move kcl-samples
+        shell: bash
+        run: |
+          mkdir -p documentation/content/pages/docs/kcl-samples
+          # cleanup old
+          rm -rf documentation/content/pages/docs/kcl-samples/*
+          # move new
+          mv -f public/kcl-samples/* documentation/content/pages/docs/kcl-samples/
       - name: commit the changes in the docs repo
         shell: bash
         run: |

.github/workflows/kcl-language-server.yml

@@ -376,7 +376,7 @@ jobs:
         with:
           credentials_json: "${{ secrets.GOOGLE_CLOUD_DL_SA }}"
       - name: Set up Cloud SDK
-        uses: google-github-actions/setup-gcloud@v2.1.2
+        uses: google-github-actions/setup-gcloud@v2.1.4
         with:
           project_id: kittycadapi
       - name: "upload files to gcp"

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

@@ -159,10 +159,13 @@ jobs:
     if: startsWith(github.ref, 'refs/tags/')
     needs: [linux-x86_64, windows, macos, sdist]
     steps:
+      - uses: actions/checkout@v4
       - uses: actions/download-artifact@v4
+        with:
+          path: rust/kcl-python-bindings
       - name: Install the latest version of uv
         uses: astral-sh/setup-uv@v5
-      - name: Install codespell
+      - name: do uv things
         run: |
             cd rust/kcl-python-bindings
             uv venv .venv

.github/workflows/static-analysis.yml

@@ -37,7 +37,7 @@ jobs:
           node-version-file: '.nvmrc'
           cache: 'yarn'
       - run: yarn install
-      - uses: taiki-e/install-action@955a6ff1416eae278c9f833008a9beb4b7f9afe3
+      - uses: taiki-e/install-action@37bdc826eaedac215f638a96472df572feab0f9b
         with:
           tool: wasm-pack
       - run: yarn build:wasm
@@ -57,7 +57,7 @@ jobs:
         with:
           workspaces: './rust'
 
-      - uses: taiki-e/install-action@955a6ff1416eae278c9f833008a9beb4b7f9afe3
+      - uses: taiki-e/install-action@37bdc826eaedac215f638a96472df572feab0f9b
         with:
           tool: wasm-pack
       - run: yarn build:wasm
@@ -100,7 +100,7 @@ jobs:
           cache: 'yarn'
 
       - run: yarn install
-      - uses: taiki-e/install-action@955a6ff1416eae278c9f833008a9beb4b7f9afe3
+      - uses: taiki-e/install-action@37bdc826eaedac215f638a96472df572feab0f9b
         with:
           tool: wasm-pack
       - run: yarn build:wasm
@@ -129,7 +129,7 @@ jobs:
           cache: 'yarn'
 
       - run: yarn install
-      - uses: taiki-e/install-action@955a6ff1416eae278c9f833008a9beb4b7f9afe3
+      - uses: taiki-e/install-action@37bdc826eaedac215f638a96472df572feab0f9b
         with:
           tool: wasm-pack
       - run: yarn build:wasm

.github/workflows/update-dev-branch.yml

@@ -1,5 +1,8 @@
 name: update-dev-branch
 
+# This is used to sync the `dev` branch with the `main` branch to continuously
+# deploy a second instance of the app to Vercel: https://app.dev.zoo.dev
+
 on:
   push:
     branches:
@@ -26,4 +29,4 @@ jobs:
           # reset to main
           git reset --hard origin/main
           # force push it
-          git push -f origin dev
+          git push --force origin dev

.github/workflows/update-e2e-branch.yml

@@ -0,0 +1,29 @@
+name: update-e2e-branch
+
+# This is used to sync the `all-e2e` branch with the `main` branch for the
+# logic in the test utility `orRunWhenFullSuiteEnabled()` that allows all e2e
+# tests to run on a particular branch to analyze failures metrics in Axiom.
+
+on:
+  schedule:
+    - cron: '0 * * * *' # runs every hour
+
+permissions:
+  contents: write
+
+jobs:
+  update-branch:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - shell: bash
+        run: |
+          # checkout our branch
+          git checkout all-e2e || git checkout -b all-e2e
+          # fetch origin
+          git fetch origin
+          # reset to main
+          git reset --hard origin/main
+          # force push it
+          git push --force origin all-e2e

.gitignore

@@ -50,15 +50,18 @@ e2e/playwright/**/*.png
 e2e/playwright/export-snapshots/*
 !e2e/playwright/export-snapshots/*.png
 !e2e/playwright/snapshot-tests.spec.ts-snapshots/*.png
+trace.zip
 
-/kcl-samples
+/public/kcl-samples.zip
+/public/kcl-samples/.github
+/public/kcl-samples/screenshots/main.kcl
+/public/kcl-samples/step/main.kcl
 /test-results/
 /playwright-report/
 /blob-report/
 /playwright/.cache/
 /src/lang/std/artifactMapCache
 
-
 ## generated files
 src/**/*.typegen.ts
 

Makefile

@@ -1,12 +1,111 @@
-.PHONY: dev
+.PHONY: all
+all: install build check
 
-KCL_WASM_LIB_FILES := $(wildcard rust/**/*.rs)
-TS_SRC := $(wildcard src/**/*.tsx) $(wildcard src/**/*.ts)
-XSTATE_TYPEGENS := $(wildcard src/machines/*.typegen.ts)
+###############################################################################
+# INSTALL
 
-dev: node_modules public/wasm_lib_bg.wasm $(XSTATE_TYPEGENS)
+WASM_PACK ?= ~/.cargo/bin/wasm-pack
+
+.PHONY: install
+install: node_modules/.yarn-integrity $(WASM_PACK) ## Install dependencies
+
+node_modules/.yarn-integrity: package.json yarn.lock
+	yarn install
+	@ touch $@
+
+$(WASM_PACK):
+	yarn install:rust
+	yarn install:wasm-pack:sh
+
+###############################################################################
+# BUILD
+
+RUST_SOURCES := $(wildcard rust/*) $(wildcard rust/**/*)
+TYPESCRIPT_SOURCES := $(wildcard src/**/*.tsx) $(wildcard src/**/*.ts)
+
+.PHONY: build
+build: build-web build-desktop
+
+.PHONY: build-web
+build-web: public/kcl_wasm_lib_bg.wasm build/index.html
+
+.PHONY: build-desktop
+build-desktop: public/kcl_wasm_lib_bg.wasm .vite/build/main.js
+
+public/kcl_wasm_lib_bg.wasm: $(RUST_SOURCES)
+	yarn build:wasm
+
+build/index.html: $(TYPESCRIPT_SOURCES)
+	yarn build:local
+
+.vite/build/main.js: $(TYPESCRIPT_SOURCES)
+	yarn tronb:vite:dev
+
+###############################################################################
+# CHECK
+
+.PHONY: check
+check: format lint
+
+.PHONY: format
+format: install ## Format the code
+	yarn fmt
+
+.PHONY: lint
+lint: install ## Lint the code
+	yarn tsc
+	yarn lint
+
+###############################################################################
+# RUN
+
+.PHONY: run
+run: run-web
+
+.PHONY: run-web
+run-web: install build-web ## Start the web app
 	yarn start
 
+.PHONY: run-desktop
+run-desktop: install build-desktop ## Start the desktop app
+	yarn tron:start
+
+###############################################################################
+# TEST
+
+GREP ?= ""
+
+.PHONY: test
+test: test-unit test-e2e
+
+.PHONY: test-unit
+test-unit: install ## Run the unit tests
+	@ nc -z localhost 3000 || ( echo "Error: localhost:3000 not available, 'make run-web' first" && exit 1 )
+	yarn test:unit
+
+.PHONY: test-e2e
+test-e2e: install build-desktop ## Run the e2e tests
+	yarn test:playwright:electron --workers=1 --grep=$(GREP)
+
+###############################################################################
+# CLEAN
+
+.PHONY: clean
+clean: ## Delete all artifacts
+	rm -rf .vite/ build/
+	rm -rf trace.zip playwright-report/ test-results/
+	rm -rf public/kcl_wasm_lib_bg.wasm
+	rm -rf rust/*/bindings/ rust/*/pkg/ rust/target/
+	rm -rf node_modules/ rust/*/node_modules/
+
+.PHONY: help
+help: install
+	@ grep -E '^[^[:space:]]+:.*## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+.DEFAULT_GOAL := help
+
+###############################################################################
+
 # I'm sorry this is so specific to my setup you may as well ignore this.
 # This is so you don't have to deal with electron windows popping up constantly.
 # It should work for you other Linux users.
@@ -14,12 +113,3 @@ lee-electron-test:
 	Xephyr -br -ac -noreset -screen 1200x500 :2 &
 	DISPLAY=:2 NODE_ENV=development PW_TEST_CONNECT_WS_ENDPOINT=ws://127.0.0.1:4444/ yarn tron:test -g "when using the file tree"
 	killall Xephyr
-
-$(XSTATE_TYPEGENS): $(TS_SRC)
-	yarn xstate typegen 'src/**/*.ts?(x)'
-
-public/kcl_wasm_lib_bg.wasm: $(KCL_WASM_LIB_FILES)
-	yarn build:wasm
-
-node_modules: package.json yarn.lock
-	yarn install

README.md

@@ -105,7 +105,7 @@ Finally, to run the web app only, run:
 yarn start
 ```
 
-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.
+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.local` 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
 
@@ -122,7 +122,7 @@ Third-Party Cookies".
 
 ## Desktop
 
-To spin up the desktop app, `yarn install` and `yarn build:wasm` need to have been done before hand then
+To spin up the desktop app, `yarn install` and `yarn build:wasm` need to have been done before hand then:
 
 ```
 yarn tron:start
@@ -130,13 +130,13 @@ yarn tron:start
 
 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).
+Devtools can be opened with the usual Command-Option-I (macOS) or Ctrl-Shift-I (Linux and Windows).
 
-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)
+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?
+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:
 

docs/kcl/abs.md

@@ -21,11 +21,11 @@ abs(num: number): number
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `num` | `number` |  | Yes |
+| `num` | [`number`](/docs/kcl/types/number) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
@@ -33,7 +33,7 @@ abs(num: number): number
 ```js
 myAngle = -120
 
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [8, 0])
   |> angledLine({ angle = abs(myAngle), length = 5 }, %)

docs/kcl/acos.md

@@ -21,17 +21,17 @@ acos(num: number): number
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `num` | `number` |  | Yes |
+| `num` | [`number`](/docs/kcl/types/number) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
        angle = toDegrees(acos(0.5)),

docs/kcl/angleToMatchLengthX.md

@@ -21,19 +21,19 @@ angleToMatchLengthX(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) |  | Yes |
-| `to` | `number` |  | Yes |
-| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
+| [`tag`](/docs/kcl/types/tag) | [`TagIdentifier`](/docs/kcl/types#tag-identifier) |  | Yes |
+| `to` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [2, 5], tag = $seg01)
   |> angledLineToX([-angleToMatchLengthX(seg01, 7, %), 10], %)

docs/kcl/angleToMatchLengthY.md

@@ -21,26 +21,26 @@ angleToMatchLengthY(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) |  | Yes |
-| `to` | `number` |  | Yes |
-| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
+| [`tag`](/docs/kcl/types/tag) | [`TagIdentifier`](/docs/kcl/types#tag-identifier) |  | Yes |
+| `to` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [1, 2], tag = $seg01)
   |> angledLine({
        angle = angleToMatchLengthY(seg01, 15, %),
        length = 5
      }, %)
-  |> yLineTo(0, %)
+  |> yLine(endAbsolute = 0)
   |> close()
 
 extrusion = extrude(sketch001, length = 5)

docs/kcl/angledLine.md

@@ -22,12 +22,12 @@ angledLine(
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `data` | [`AngledLineData`](/docs/kcl/types/AngledLineData) | Data to draw an angled line. | Yes |
-| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
-| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
+| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) |  | Yes |
+| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
 
 ### Returns
 
-[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
+[`Sketch`](/docs/kcl/types/Sketch)
 
 
 ### Examples
@@ -35,10 +35,10 @@ angledLine(
 ```js
 exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
-  |> yLineTo(15, %)
+  |> yLine(endAbsolute = 15)
   |> angledLine({ angle = 30, length = 15 }, %)
   |> line(end = [8, -10])
-  |> yLineTo(0, %)
+  |> yLine(endAbsolute = 0)
   |> close()
 
 example = extrude(exampleSketch, length = 10)

docs/kcl/angledLineOfXLength.md

@@ -22,12 +22,12 @@ angledLineOfXLength(
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `data` | [`AngledLineData`](/docs/kcl/types/AngledLineData) | Data to draw an angled line. | Yes |
-| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
-| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
+| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) |  | Yes |
+| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
 
 ### Returns
 
-[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
+[`Sketch`](/docs/kcl/types/Sketch)
 
 
 ### Examples

docs/kcl/angledLineOfYLength.md

@@ -22,12 +22,12 @@ angledLineOfYLength(
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `data` | [`AngledLineData`](/docs/kcl/types/AngledLineData) | Data to draw an angled line. | Yes |
-| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
-| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
+| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) |  | Yes |
+| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
 
 ### Returns
 
-[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
+[`Sketch`](/docs/kcl/types/Sketch)
 
 
 ### Examples

docs/kcl/angledLineThatIntersects.md

@@ -22,12 +22,12 @@ angledLineThatIntersects(
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `data` | [`AngledLineThatIntersectsData`](/docs/kcl/types/AngledLineThatIntersectsData) | Data for drawing an angled line that intersects with a given line. | Yes |
-| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
-| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
+| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) |  | Yes |
+| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
 
 ### Returns
 
-[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
+[`Sketch`](/docs/kcl/types/Sketch)
 
 
 ### Examples

docs/kcl/angledLineToX.md

@@ -22,12 +22,12 @@ angledLineToX(
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `data` | [`AngledLineToData`](/docs/kcl/types/AngledLineToData) | Data to draw an angled line to a point. | Yes |
-| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
-| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
+| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) |  | Yes |
+| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
 
 ### Returns
 
-[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
+[`Sketch`](/docs/kcl/types/Sketch)
 
 
 ### Examples

docs/kcl/angledLineToY.md

@@ -22,12 +22,12 @@ angledLineToY(
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `data` | [`AngledLineToData`](/docs/kcl/types/AngledLineToData) | Data to draw an angled line to a point. | Yes |
-| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
-| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
+| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) |  | Yes |
+| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
 
 ### Returns
 
-[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
+[`Sketch`](/docs/kcl/types/Sketch)
 
 
 ### Examples

docs/kcl/arc.md

@@ -24,12 +24,12 @@ arc(
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `data` | [`ArcData`](/docs/kcl/types/ArcData) | Data to draw an arc. | Yes |
-| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
-| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
+| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) |  | Yes |
+| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
 
 ### Returns
 
-[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
+[`Sketch`](/docs/kcl/types/Sketch)
 
 
 ### Examples

docs/kcl/arcTo.md

@@ -22,12 +22,12 @@ arcTo(
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `data` | [`ArcToData`](/docs/kcl/types/ArcToData) | Data to draw a three point arc (arcTo). | Yes |
-| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
-| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
+| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) |  | Yes |
+| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
 
 ### Returns
 
-[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
+[`Sketch`](/docs/kcl/types/Sketch)
 
 
 ### Examples

docs/kcl/asin.md

@@ -21,23 +21,23 @@ asin(num: number): number
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `num` | `number` |  | Yes |
+| `num` | [`number`](/docs/kcl/types/number) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
        angle = toDegrees(asin(0.5)),
        length = 20
      }, %)
-  |> yLineTo(0, %)
+  |> yLine(endAbsolute = 0)
   |> close()
 
 extrude001 = extrude(sketch001, length = 5)

docs/kcl/assert.md

@@ -20,8 +20,8 @@ assert(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `data` | `bool` |  | Yes |
-| `message` | `string` |  | Yes |
+| `data` | [`bool`](/docs/kcl/types/bool) |  | Yes |
+| `message` | [`string`](/docs/kcl/types/string) |  | Yes |
 
 ### Returns
 

docs/kcl/assertEqual.md

@@ -22,10 +22,10 @@ assertEqual(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `left` | `number` |  | Yes |
-| `right` | `number` |  | Yes |
-| `epsilon` | `number` |  | Yes |
-| `message` | `string` |  | Yes |
+| `left` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `right` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `epsilon` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `message` | [`string`](/docs/kcl/types/string) |  | Yes |
 
 ### Returns
 

docs/kcl/assertGreaterThan.md

@@ -21,9 +21,9 @@ assertGreaterThan(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `left` | `number` |  | Yes |
-| `right` | `number` |  | Yes |
-| `message` | `string` |  | Yes |
+| `left` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `right` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `message` | [`string`](/docs/kcl/types/string) |  | Yes |
 
 ### Returns
 

docs/kcl/assertGreaterThanOrEq.md

@@ -21,9 +21,9 @@ assertGreaterThanOrEq(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `left` | `number` |  | Yes |
-| `right` | `number` |  | Yes |
-| `message` | `string` |  | Yes |
+| `left` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `right` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `message` | [`string`](/docs/kcl/types/string) |  | Yes |
 
 ### Returns
 

docs/kcl/assertLessThan.md

@@ -21,9 +21,9 @@ assertLessThan(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `left` | `number` |  | Yes |
-| `right` | `number` |  | Yes |
-| `message` | `string` |  | Yes |
+| `left` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `right` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `message` | [`string`](/docs/kcl/types/string) |  | Yes |
 
 ### Returns
 

docs/kcl/assertLessThanOrEq.md

@@ -21,9 +21,9 @@ assertLessThanOrEq(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `left` | `number` |  | Yes |
-| `right` | `number` |  | Yes |
-| `message` | `string` |  | Yes |
+| `left` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `right` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `message` | [`string`](/docs/kcl/types/string) |  | Yes |
 
 ### Returns
 

docs/kcl/atan.md

@@ -21,23 +21,23 @@ atan(num: number): number
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `num` | `number` |  | Yes |
+| `num` | [`number`](/docs/kcl/types/number) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
        angle = toDegrees(atan(1.25)),
        length = 20
      }, %)
-  |> yLineTo(0, %)
+  |> yLine(endAbsolute = 0)
   |> close()
 
 extrude001 = extrude(sketch001, length = 5)

docs/kcl/atan2.md

@@ -24,24 +24,24 @@ atan2(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `y` | `number` |  | Yes |
-| `x` | `number` |  | Yes |
+| `y` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `x` | [`number`](/docs/kcl/types/number) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
        angle = toDegrees(atan2(1.25, 2)),
        length = 20
      }, %)
-  |> yLineTo(0, %)
+  |> yLine(endAbsolute = 0)
   |> close()
 
 extrude001 = extrude(sketch001, length = 5)

docs/kcl/bezierCurve.md

@@ -22,12 +22,12 @@ bezierCurve(
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `data` | [`BezierData`](/docs/kcl/types/BezierData) | Data to draw a bezier curve. | Yes |
-| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
-| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
+| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) |  | Yes |
+| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
 
 ### Returns
 
-[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
+[`Sketch`](/docs/kcl/types/Sketch)
 
 
 ### Examples

docs/kcl/ceil.md

@@ -21,21 +21,21 @@ ceil(num: number): number
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `num` | `number` |  | Yes |
+| `num` | [`number`](/docs/kcl/types/number) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(endAbsolute = [12, 10])
   |> line(end = [ceil(7.02986), 0])
-  |> yLineTo(0, %)
+  |> yLine(endAbsolute = 0)
   |> close()
 
 extrude001 = extrude(sketch001, length = 5)

docs/kcl/circleThreePoint.md

@@ -23,21 +23,21 @@ circleThreePoint(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `p1` | `[number]` | 1st point to derive the circle. | Yes |
-| `p2` | `[number]` | 2nd point to derive the circle. | Yes |
-| `p3` | `[number]` | 3rd point to derive the circle. | Yes |
+| `p1` | [`[number]`](/docs/kcl/types/number) | 1st point to derive the circle. | Yes |
+| `p2` | [`[number]`](/docs/kcl/types/number) | 2nd point to derive the circle. | Yes |
+| `p3` | [`[number]`](/docs/kcl/types/number) | 3rd point to derive the circle. | Yes |
 | `sketchSurfaceOrGroup` | [`SketchOrSurface`](/docs/kcl/types/SketchOrSurface) | Plane or surface to sketch on. | Yes |
-| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Identifier for the circle to reference elsewhere. | No |
+| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Identifier for the circle to reference elsewhere. | No |
 
 ### Returns
 
-[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
+[`Sketch`](/docs/kcl/types/Sketch)
 
 
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XY")
+exampleSketch = startSketchOn(XY)
   |> circleThreePoint(p1 = [10, 10], p2 = [20, 8], p3 = [15, 5])
   |> extrude(length = 5)
 ```

docs/kcl/close.md

@@ -21,11 +21,11 @@ close(
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | The sketch you want to close | Yes |
-| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this line | No |
+| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this line | No |
 
 ### Returns
 
-[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
+[`Sketch`](/docs/kcl/types/Sketch)
 
 
 ### Examples

docs/kcl/cm.md

@@ -26,7 +26,7 @@ cm(): number
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples

docs/kcl/consts.md

@@ -0,0 +1,25 @@
+---
+title: "KCL Constants"
+excerpt: "Documentation for the KCL constants."
+layout: manual
+---
+
+## Table of Contents
+
+
+### `std`
+
+- [`HALF_TURN`](/docs/kcl/consts/std-HALF_TURN)
+- [`QUARTER_TURN`](/docs/kcl/consts/std-QUARTER_TURN)
+- [`THREE_QUARTER_TURN`](/docs/kcl/consts/std-THREE_QUARTER_TURN)
+- [`XY`](/docs/kcl/consts/std-XY)
+- [`XZ`](/docs/kcl/consts/std-XZ)
+- [`YZ`](/docs/kcl/consts/std-YZ)
+- [`ZERO`](/docs/kcl/consts/std-ZERO)
+
+### `std::math`
+
+- [`E`](/docs/kcl/consts/std-math-E)
+- [`PI`](/docs/kcl/consts/std-math-PI)
+- [`TAU`](/docs/kcl/consts/std-math-TAU)
+

docs/kcl/consts/std-math-E.md

@@ -21,7 +21,7 @@ exampleSketch = startSketchOn("XZ")
     angle = 30,
     length = 2 * E ^ 2,
   }, %)
-  |> yLineTo(0, %)
+  |> yLine(endAbsolute = 0)
   |> close()
 
 example = extrude(exampleSketch, length = 10)

docs/kcl/consts/std-math-TAU.md

@@ -21,7 +21,7 @@ exampleSketch = startSketchOn("XZ")
     angle = 50,
     length = 10 * TAU,
   }, %)
-  |> yLineTo(0, %)
+  |> yLine(endAbsolute = 0)
   |> close()
 
 example = extrude(exampleSketch, length = 5)

docs/kcl/e.md

@@ -22,16 +22,16 @@ e(): number
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({ angle = 30, length = 2 * e() ^ 2 }, %)
-  |> yLineTo(0, %)
+  |> yLine(endAbsolute = 0)
   |> close()
 
 example = extrude(exampleSketch, length = 10)

docs/kcl/fillet.md

@@ -24,14 +24,14 @@ fillet(
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `solid` | [`Solid`](/docs/kcl/types/Solid) | The solid whose edges should be filletted | Yes |
-| `radius` | `number` | The radius of the fillet | Yes |
+| `radius` | [`number`](/docs/kcl/types/number) | The radius of the fillet | Yes |
 | `tags` | [`[EdgeReference]`](/docs/kcl/types/EdgeReference) | The paths you want to fillet | Yes |
-| `tolerance` | `number` | The tolerance for this fillet | No |
-| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this fillet | No |
+| `tolerance` | [`number`](/docs/kcl/types/number) | The tolerance for this fillet | No |
+| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this fillet | No |
 
 ### Returns
 
-[`Solid`](/docs/kcl/types/Solid) - A solid is a collection of extrude surfaces.
+[`Solid`](/docs/kcl/types/Solid)
 
 
 ### Examples
@@ -42,7 +42,7 @@ length = 10
 thickness = 1
 filletRadius = 2
 
-mountingPlateSketch = startSketchOn("XY")
+mountingPlateSketch = startSketchOn(XY)
   |> startProfileAt([-width / 2, -length / 2], %)
   |> line(endAbsolute = [width / 2, -length / 2], tag = $edge1)
   |> line(endAbsolute = [width / 2, length / 2], tag = $edge2)
@@ -69,7 +69,7 @@ length = 10
 thickness = 1
 filletRadius = 1
 
-mountingPlateSketch = startSketchOn("XY")
+mountingPlateSketch = startSketchOn(XY)
   |> startProfileAt([-width / 2, -length / 2], %)
   |> line(endAbsolute = [width / 2, -length / 2], tag = $edge1)
   |> line(endAbsolute = [width / 2, length / 2], tag = $edge2)

docs/kcl/floor.md

@@ -21,21 +21,21 @@ floor(num: number): number
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `num` | `number` |  | Yes |
+| `num` | [`number`](/docs/kcl/types/number) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(endAbsolute = [12, 10])
   |> line(end = [floor(7.02986), 0])
-  |> yLineTo(0, %)
+  |> yLine(endAbsolute = 0)
   |> close()
 
 extrude001 = extrude(sketch001, length = 5)

docs/kcl/ft.md

@@ -26,7 +26,7 @@ ft(): number
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples

docs/kcl/getNextAdjacentEdge.md

@@ -17,7 +17,7 @@ getNextAdjacentEdge(tag: TagIdentifier): Uuid
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) |  | Yes |
+| [`tag`](/docs/kcl/types/tag) | [`TagIdentifier`](/docs/kcl/types#tag-identifier) |  | Yes |
 
 ### Returns
 
@@ -27,7 +27,7 @@ getNextAdjacentEdge(tag: TagIdentifier): Uuid
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [10, 0])
   |> angledLine({ angle = 60, length = 10 }, %)

docs/kcl/getOppositeEdge.md

@@ -17,7 +17,7 @@ getOppositeEdge(tag: TagIdentifier): Uuid
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) |  | Yes |
+| [`tag`](/docs/kcl/types/tag) | [`TagIdentifier`](/docs/kcl/types#tag-identifier) |  | Yes |
 
 ### Returns
 
@@ -27,7 +27,7 @@ getOppositeEdge(tag: TagIdentifier): Uuid
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [10, 0])
   |> angledLine({ angle = 60, length = 10 }, %)

docs/kcl/getPreviousAdjacentEdge.md

@@ -17,7 +17,7 @@ getPreviousAdjacentEdge(tag: TagIdentifier): Uuid
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) |  | Yes |
+| [`tag`](/docs/kcl/types/tag) | [`TagIdentifier`](/docs/kcl/types#tag-identifier) |  | Yes |
 
 ### Returns
 
@@ -27,7 +27,7 @@ getPreviousAdjacentEdge(tag: TagIdentifier): Uuid
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [10, 0])
   |> angledLine({ angle = 60, length = 10 }, %)

docs/kcl/hole.md

@@ -10,7 +10,7 @@ Use a 2-dimensional sketch to cut a hole in another 2-dimensional sketch.
 
 ```js
 hole(
-  holeSketch: SketchSet,
+  holeSketch: [Sketch],
   sketch: Sketch,
 ): Sketch
 ```
@@ -20,12 +20,12 @@ hole(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `holeSketch` | [`SketchSet`](/docs/kcl/types/SketchSet) | A sketch or a group of sketches. | Yes |
-| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
+| `holeSketch` | [`[Sketch]`](/docs/kcl/types/Sketch) |  | Yes |
+| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) |  | Yes |
 
 ### Returns
 
-[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
+[`Sketch`](/docs/kcl/types/Sketch)
 
 
 ### Examples

docs/kcl/hollow.md

@@ -20,19 +20,19 @@ hollow(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `thickness` | `number` |  | Yes |
-| `solid` | [`Solid`](/docs/kcl/types/Solid) | A solid is a collection of extrude surfaces. | Yes |
+| `thickness` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `solid` | [`Solid`](/docs/kcl/types/Solid) |  | Yes |
 
 ### Returns
 
-[`Solid`](/docs/kcl/types/Solid) - A solid is a collection of extrude surfaces.
+[`Solid`](/docs/kcl/types/Solid)
 
 
 ### Examples
 
 ```js
 // Hollow a basic sketch.
-firstSketch = startSketchOn('XY')
+firstSketch = startSketchOn(XY)
   |> startProfileAt([-12, 12], %)
   |> line(end = [24, 0])
   |> line(end = [0, -24])
@@ -46,7 +46,7 @@ firstSketch = startSketchOn('XY')
 
 ```js
 // Hollow a basic sketch.
-firstSketch = startSketchOn('-XZ')
+firstSketch = startSketchOn(-XZ)
   |> startProfileAt([-12, 12], %)
   |> line(end = [24, 0])
   |> line(end = [0, -24])
@@ -61,7 +61,7 @@ firstSketch = startSketchOn('-XZ')
 ```js
 // Hollow a sketch on face object.
 size = 100
-case = startSketchOn('-XZ')
+case = startSketchOn(-XZ)
   |> startProfileAt([-size, -size], %)
   |> line(end = [2 * size, 0])
   |> line(end = [0, 2 * size])

docs/kcl/import.md

@@ -69,7 +69,7 @@ model = import("tests/inputs/cube.step")
 ```js
 import height, buildSketch from "common.kcl"
 
-plane = 'XZ'
+plane = XZ
 margin = 2
 s1 = buildSketch(plane, [0, 0])
 s2 = buildSketch(plane, [0, height() + margin])

docs/kcl/inch.md

@@ -26,7 +26,7 @@ inch(): number
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples

docs/kcl/index.md

@@ -12,17 +12,30 @@ layout: manual
 * [`Modules`](kcl/modules)
 * [`Settings`](kcl/settings)
 * [`Known Issues`](kcl/known-issues)
+* [`Constants`](kcl/consts)
 
 ### 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)
+* **Primitive types**
+  * [`bool`](kcl/types/bool)
+  * [`number`](kcl/types/number)
+  * [`string`](kcl/types/string)
+  * [`tag`](kcl/types/tag)
+* **std**
+  * [`Face`](kcl/types/Face)
+  * [`HALF_TURN`](kcl/consts/std-HALF_TURN)
+  * [`Helix`](kcl/types/Helix)
+  * [`Plane`](kcl/types/Plane)
+  * [`Point2d`](kcl/types/Point2d)
+  * [`Point3d`](kcl/types/Point3d)
+  * [`QUARTER_TURN`](kcl/consts/std-QUARTER_TURN)
+  * [`Sketch`](kcl/types/Sketch)
+  * [`Solid`](kcl/types/Solid)
+  * [`THREE_QUARTER_TURN`](kcl/consts/std-THREE_QUARTER_TURN)
+  * [`XY`](kcl/consts/std-XY)
+  * [`XZ`](kcl/consts/std-XZ)
+  * [`YZ`](kcl/consts/std-YZ)
+  * [`ZERO`](kcl/consts/std-ZERO)
   * [`abs`](kcl/abs)
   * [`acos`](kcl/acos)
   * [`angleToMatchLengthX`](kcl/angleToMatchLengthX)
@@ -56,11 +69,11 @@ layout: manual
   * [`fillet`](kcl/fillet)
   * [`floor`](kcl/floor)
   * [`ft`](kcl/ft)
+  * [`getCommonEdge`](kcl/getCommonEdge)
   * [`getNextAdjacentEdge`](kcl/getNextAdjacentEdge)
   * [`getOppositeEdge`](kcl/getOppositeEdge)
   * [`getPreviousAdjacentEdge`](kcl/getPreviousAdjacentEdge)
   * [`helix`](kcl/helix)
-  * [`helixRevolutions`](kcl/helixRevolutions)
   * [`hole`](kcl/hole)
   * [`hollow`](kcl/hollow)
   * [`inch`](kcl/inch)
@@ -123,14 +136,12 @@ layout: manual
   * [`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)
+* **std::math**
+  * [`E`](kcl/consts/std-math-E)
+  * [`PI`](kcl/consts/std-math-PI)
+  * [`TAU`](kcl/consts/std-math-TAU)
   * [`cos`](kcl/std-math-cos)
   * [`sin`](kcl/std-math-sin)
   * [`tan`](kcl/std-math-tan)

docs/kcl/int.md

@@ -23,11 +23,11 @@ int(num: number): number
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `num` | `number` |  | Yes |
+| `num` | [`number`](/docs/kcl/types/number) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
@@ -36,7 +36,7 @@ int(num: number): number
 n = int(ceil(5 / 2))
 assertEqual(n, 3, 0.0001, "5/2 = 2.5, rounded up makes 3")
 // Draw n cylinders.
-startSketchOn('XZ')
+startSketchOn(XZ)
   |> circle(center = [0, 0], radius = 2)
   |> extrude(length = 5)
   |> patternTransform(

docs/kcl/known-issues.md

@@ -13,9 +13,7 @@ once fixed in engine will just start working here with no language changes.
     If you see a red line around your model, it means this is happening.
 
 - **Import**: Right now you can import a file, even if that file has brep data
-    you cannot edit it, after v1, the engine will account for this. You also cannot
-    currently move or transform the imported objects at all, once we have assemblies
-    this will work.
+    you cannot edit it, after v1, the engine will account for this. 
 
 - **Fillets**: Fillets cannot intersect, you will get an error. Only simple fillet
     cases work currently.

docs/kcl/lastSegX.md

@@ -21,13 +21,13 @@ lastSegX(sketch: Sketch): number
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [5, 0])
   |> line(end = [20, 5])

docs/kcl/lastSegY.md

@@ -21,13 +21,13 @@ lastSegY(sketch: Sketch): number
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [5, 0])
   |> line(end = [20, 5])

docs/kcl/legAngX.md

@@ -24,12 +24,12 @@ legAngX(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `hypotenuse` | `number` |  | Yes |
-| `leg` | `number` |  | Yes |
+| `hypotenuse` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `leg` | [`number`](/docs/kcl/types/number) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples

docs/kcl/legAngY.md

@@ -24,12 +24,12 @@ legAngY(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `hypotenuse` | `number` |  | Yes |
-| `leg` | `number` |  | Yes |
+| `hypotenuse` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `leg` | [`number`](/docs/kcl/types/number) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples

docs/kcl/legLen.md

@@ -24,12 +24,12 @@ legLen(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `hypotenuse` | `number` |  | Yes |
-| `leg` | `number` |  | Yes |
+| `hypotenuse` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `leg` | [`number`](/docs/kcl/types/number) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples

docs/kcl/line.md

@@ -23,13 +23,13 @@ line(
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | Which sketch should this path be added to? | Yes |
-| `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 |
+| `endAbsolute` | [`[number]`](/docs/kcl/types/number) | Which absolute point should this line go to? Incompatible with `end`. | No |
+| `end` | [`[number]`](/docs/kcl/types/number) | How far away (along the X and Y axes) should this line go? Incompatible with `endAbsolute`. | No |
+| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this line | No |
 
 ### Returns
 
-[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
+[`Sketch`](/docs/kcl/types/Sketch)
 
 
 ### Examples

docs/kcl/ln.md

@@ -21,17 +21,17 @@ ln(num: number): number
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `num` | `number` |  | Yes |
+| `num` | [`number`](/docs/kcl/types/number) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [ln(100), 15])
   |> line(end = [5, -6])

docs/kcl/log.md

@@ -24,18 +24,18 @@ log(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `num` | `number` |  | Yes |
-| `base` | `number` |  | Yes |
+| `num` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `base` | [`number`](/docs/kcl/types/number) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [log(100, 5), 0])
   |> line(end = [5, 8])

docs/kcl/log10.md

@@ -21,17 +21,17 @@ log10(num: number): number
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `num` | `number` |  | Yes |
+| `num` | [`number`](/docs/kcl/types/number) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [log10(100), 0])
   |> line(end = [5, 8])

docs/kcl/log2.md

@@ -21,17 +21,17 @@ log2(num: number): number
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `num` | `number` |  | Yes |
+| `num` | [`number`](/docs/kcl/types/number) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [log2(100), 0])
   |> line(end = [5, 8])

docs/kcl/m.md

@@ -26,7 +26,7 @@ m(): number
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples

docs/kcl/max.md

@@ -21,17 +21,17 @@ max(args: [number]): number
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `args` | `[number]` |  | Yes |
+| `args` | [`[number]`](/docs/kcl/types/number) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
        angle = 70,

docs/kcl/min.md

@@ -21,17 +21,17 @@ min(args: [number]): number
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `args` | `[number]` |  | Yes |
+| `args` | [`[number]`](/docs/kcl/types/number) |  | Yes |
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
        angle = 70,

docs/kcl/mm.md

@@ -26,7 +26,7 @@ mm(): number
 
 ### Returns
 
-`number`
+[`number`](/docs/kcl/types/number)
 
 
 ### Examples