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>

.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",
+    "@actions/github": "^6.0",
-    "glob": "^7.1.5"
+    "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
+    if [[ "$3" == *ubuntu* ]]; then
-            xvfb-run --auto-servernum --server-args="-screen 0 1280x960x24" -- yarn test:playwright:electron:ubuntu -- --shard=$1/$2 || true
+        xvfb-run --auto-servernum --server-args="-screen 0 1280x960x24" -- yarn test:playwright:electron:ubuntu -- --shard=$1/$2 || true
-        elif [[ "$3" == *windows* ]]; then
+    elif [[ "$3" == *windows* ]]; then
-            yarn test:playwright:electron:windows -- --shard=$1/$2 || true
+        yarn test:playwright:electron:windows -- --shard=$1/$2 || true
-        elif [[ "$3" == *macos* ]]; then
+    elif [[ "$3" == *macos* ]]; then
-            yarn test:playwright:electron:macos  -- --shard=$1/$2 || true
+        yarn test:playwright:electron:macos  -- --shard=$1/$2 || true
-        else
+    else
-            echo "Do not run playwright. Unable to detect os runtime."
+        echo "Do not run Playwright. Unable to detect os runtime."
-            exit 1
+        exit 1
-        fi
+    fi
-        # # send to axiom
+    # Log failures for Axiom to pick up
-        node playwrightProcess.mjs | tee /tmp/github-actions.log > /dev/null 2>&1
+    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
+# Retry failed tests, doing our own retries because using inbuilt Playwright retries causes connection issues
-while [[ $retry -le $max_retrys ]]; do
+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
+            # Log failures for Axiom to pick up
-            node playwrightProcess.mjs | tee /tmp/github-actions.log > /dev/null 2>&1
+            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

@@ -230,39 +230,6 @@ updates:
       update-types:
       - minor
       - patch
-- package-ecosystem: pip
-  directory: /public/kcl-samples
-  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:

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

@@ -24,7 +24,7 @@ jobs:
         uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
           cache: false # Configured below.
-      - uses: taiki-e/install-action@955a6ff1416eae278c9f833008a9beb4b7f9afe3
+      - uses: taiki-e/install-action@37bdc826eaedac215f638a96472df572feab0f9b
         with:
           tool: wasm-pack
       - name: Rust Cache

.github/workflows/build-apps.yml

@@ -77,7 +77,7 @@ jobs:
         with:
           cache: false # Configured below.
 
-      - uses: taiki-e/install-action@955a6ff1416eae278c9f833008a9beb4b7f9afe3
+      - uses: taiki-e/install-action@37bdc826eaedac215f638a96472df572feab0f9b
         if: ${{ steps.wasm.outputs.should-build-wasm == 'true' }}
         with:
           tool: wasm-pack

.github/workflows/cargo-bench.yml

@@ -26,8 +26,12 @@ name: cargo bench
 jobs:
   cargo-bench:
     name: cargo bench
-    runs-on: codspeed-macro
+    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

.github/workflows/cargo-test.yml

@@ -100,9 +100,14 @@ jobs:
         shell: bash
         run: |
           set -euo pipefail
-          cd rust
+          pushd rust
           just overwrite-sim-test kcl_samples
-          git add kcl-lib/tests
+          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

.github/workflows/e2e-tests.yml

@@ -75,7 +75,7 @@ jobs:
 
   prepare-wasm:
     # seperate job on Ubuntu to build or fetch the wasm blob once on the fastest runner
-    runs-on: namespace-profile-ubuntu-8-cores
+    runs-on: runs-on=${{ github.run_id }}/family=i7ie.2xlarge/image=ubuntu22-full-x64
     needs: conditions
     steps:
       - uses: actions/checkout@v4
@@ -137,7 +137,7 @@ jobs:
         with:
           cache: false # Configured below.
 
-      - uses: taiki-e/install-action@955a6ff1416eae278c9f833008a9beb4b7f9afe3
+      - uses: taiki-e/install-action@37bdc826eaedac215f638a96472df572feab0f9b
         if: ${{ needs.conditions.outputs.should-run == 'true' && steps.wasm.outputs.should-build-wasm == 'true' }}
         with:
           tool: wasm-pack
@@ -163,7 +163,7 @@ jobs:
 
   snapshots:
     name: playwright:snapshots:ubuntu
-    runs-on: namespace-profile-ubuntu-8-cores
+    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
@@ -220,8 +220,12 @@ jobs:
 
       - name: Run ubuntu/chrome snapshots
         if: needs.conditions.outputs.should-run == 'true'
-        run: |
+        uses: nick-fields/retry@v3.0.2
-          yarn test:snapshots
+        with:
+          shell: bash
+          command: yarn test:snapshots
+          timeout_minutes: 30
+          max_attempts: 3
         env:
           CI: true
           NODE_ENV: development
@@ -233,19 +237,14 @@ jobs:
       - uses: actions/upload-artifact@v4
         if: ${{ needs.conditions.outputs.should-run == 'true' && !cancelled() && (success() || failure()) }}
         with:
-          name: playwright-report-snapshots-${{ matrix.os }}-snapshot-${{ matrix.shardIndex }}-${{ github.sha }}
+          name: playwright-report-ubuntu-snapshot-${{ github.sha }}
           path: playwright-report/
           include-hidden-files: true
           retention-days: 30
           overwrite: true
 
-      - name: Clean up test-results
-        if: ${{ needs.conditions.outputs.should-run == 'true' && !cancelled() && (success() || failure()) }}
-        continue-on-error: true
-        run: rm -r test-results
-
       - name: check for changes
-        if: ${{ needs.conditions.outputs.should-run == 'true' && matrix.os == 'namespace-profile-ubuntu-8-cores' && matrix.shardIndex == 1 && github.ref != 'refs/heads/main' }}
+        if: ${{ needs.conditions.outputs.should-run == 'true' && github.ref != 'refs/heads/main' }}
         shell: bash
         id: git-check
         run: |
@@ -266,31 +265,36 @@ jobs:
           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 commit -m "A snapshot a day keeps the bugs away! 📷🐛" || true
           git push
           git push origin ${{ github.head_ref }}
 
-      # only upload artifacts if there's actually changes
-      - uses: actions/upload-artifact@v4
-        if: ${{ needs.conditions.outputs.should-run == 'true' && steps.git-check.outputs.modified == 'true' }}
-        with:
-          name: playwright-report-ubuntu-${{ github.sha }}
-          path: playwright-report/
-          include-hidden-files: true
-          retention-days: 30
-
-
   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
+        # TODO: enable namespace-profile-windows-latest once available
-        os: [namespace-profile-ubuntu-8-cores, namespace-profile-macos-8-cores, windows-16-cores]
+        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:
@@ -321,6 +325,7 @@ jobs:
         run: yarn
 
       - name: Cache Playwright Browsers
+        if: needs.conditions.outputs.should-run == 'true'
         uses: actions/cache@v4
         with:
           path: |
@@ -328,26 +333,35 @@ jobs:
           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 good sed
+      - name: Install vector
-        if: startsWith(matrix.os, 'macos')
+        if: contains(matrix.os, 'ubuntu')
         shell: bash
         run: |
-          brew install gnu-sed
+          curl --proto '=https' --tlsv1.2 -sSfL https://sh.vector.dev > /tmp/vector.sh
-          echo "/opt/homebrew/opt/gnu-sed/libexec/gnubin" >> $GITHUB_PATH
+          chmod +x /tmp/vector.sh
-
+          /tmp/vector.sh -y -no-modify-path
-        # TODO: Add back axiom logs
+          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-${{ matrix.os }}-${{ matrix.shardIndex }}-${{ github.sha }}
+          name: test-results-${{ env.OS_NAME }}-${{ matrix.shardIndex }}-${{ github.sha }}
           path: test-results/
 
       - name: Run playwright/electron flow (with retries)
@@ -356,9 +370,9 @@ jobs:
         uses: nick-fields/retry@v3.0.2
         with:
           shell: bash
-          command: .github/ci-cd-scripts/playwright-electron.sh ${{matrix.shardIndex}} ${{matrix.shardTotal}} ${{matrix.os}}
+          command: .github/ci-cd-scripts/playwright-electron.sh ${{matrix.shardIndex}} ${{matrix.shardTotal}} ${{ env.OS_NAME }}
-          timeout_minutes: 30
+          timeout_minutes: 45
-          max_attempts: 25
+          max_attempts: 15
         env:
           CI: true
           FAIL_ON_CONSOLE_ERRORS: true
@@ -370,7 +384,7 @@ jobs:
       - uses: actions/upload-artifact@v4
         if: ${{ needs.conditions.outputs.should-run == 'true' && always() }}
         with:
-          name: test-results-${{ matrix.os }}-${{ matrix.shardIndex }}-${{ github.sha }}
+          name: test-results-${{ env.OS_NAME }}-${{ matrix.shardIndex }}-${{ github.sha }}
           path: test-results/
           include-hidden-files: true
           retention-days: 30
@@ -379,7 +393,7 @@ jobs:
       - uses: actions/upload-artifact@v4
         if: ${{ needs.conditions.outputs.should-run == 'true' && always() }}
         with:
-          name: playwright-report-${{ matrix.os }}-${{ matrix.shardIndex }}-${{ github.sha }}
+          name: playwright-report-${{ env.OS_NAME }}-${{ matrix.shardIndex }}-${{ github.sha }}
           path: playwright-report/
           include-hidden-files: true
           retention-days: 30

.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/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,16 +50,18 @@ e2e/playwright/**/*.png
 e2e/playwright/export-snapshots/*
 !e2e/playwright/export-snapshots/*.png
 !e2e/playwright/snapshot-tests.spec.ts-snapshots/*.png
+trace.zip
 
 /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)
+# INSTALL
-XSTATE_TYPEGENS := $(wildcard src/machines/*.typegen.ts)
 
-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

@@ -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

@@ -31,7 +31,7 @@ acos(num: number): number
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
        angle = toDegrees(acos(0.5)),

docs/kcl/angleToMatchLengthX.md

@@ -33,7 +33,7 @@ angleToMatchLengthX(
 ### 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

@@ -33,7 +33,7 @@ angleToMatchLengthY(
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [1, 2], tag = $seg01)
   |> angledLine({

docs/kcl/asin.md

@@ -31,7 +31,7 @@ asin(num: number): number
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
        angle = toDegrees(asin(0.5)),

docs/kcl/atan.md

@@ -31,7 +31,7 @@ atan(num: number): number
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
        angle = toDegrees(atan(1.25)),

docs/kcl/atan2.md

@@ -35,7 +35,7 @@ atan2(
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
        angle = toDegrees(atan2(1.25, 2)),

docs/kcl/ceil.md

@@ -31,7 +31,7 @@ ceil(num: number): number
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(endAbsolute = [12, 10])
   |> line(end = [ceil(7.02986), 0])

docs/kcl/chamfer.md

@@ -41,7 +41,7 @@ length = 10
 thickness = 1
 chamferLength = 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)
@@ -65,7 +65,7 @@ mountingPlate = extrude(mountingPlateSketch, length = thickness)
 ```js
 // Sketch on the face of a chamfer.
 fn cube(pos, scale) {
-  sg = startSketchOn('XY')
+  sg = startSketchOn(XY)
     |> startProfileAt(pos, %)
     |> line(end = [0, scale])
     |> line(end = [scale, 0])

docs/kcl/circleThreePoint.md

@@ -37,7 +37,7 @@ circleThreePoint(
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XY")
+exampleSketch = startSketchOn(XY)
   |> circleThreePoint(p1 = [10, 10], p2 = [20, 8], p3 = [15, 5])
   |> extrude(length = 5)
 ```

docs/kcl/e.md

@@ -28,7 +28,7 @@ e(): number
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({ angle = 30, length = 2 * e() ^ 2 }, %)
   |> yLine(endAbsolute = 0)

docs/kcl/fillet.md

@@ -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

@@ -31,7 +31,7 @@ floor(num: number): number
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(endAbsolute = [12, 10])
   |> line(end = [floor(7.02986), 0])

docs/kcl/getNextAdjacentEdge.md

@@ -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

@@ -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

@@ -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,7 +20,7 @@ hole(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `holeSketch` | [`SketchSet`](/docs/kcl/types/SketchSet) | A sketch or a group of sketches. | Yes |
+| `holeSketch` | [`[Sketch]`](/docs/kcl/types/Sketch) |  | Yes |
 | `sketch` | [`Sketch`](/docs/kcl/types/Sketch) |  | Yes |
 
 ### Returns

docs/kcl/hollow.md

@@ -32,7 +32,7 @@ hollow(
 
 ```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/index.md

@@ -22,8 +22,12 @@ layout: manual
   * [`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)
@@ -65,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)

docs/kcl/int.md

@@ -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/lastSegX.md

@@ -27,7 +27,7 @@ lastSegX(sketch: Sketch): number
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [5, 0])
   |> line(end = [20, 5])

docs/kcl/lastSegY.md

@@ -27,7 +27,7 @@ lastSegY(sketch: Sketch): number
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [5, 0])
   |> line(end = [20, 5])

docs/kcl/ln.md

@@ -31,7 +31,7 @@ ln(num: number): 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

@@ -35,7 +35,7 @@ log(
 ### 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

@@ -31,7 +31,7 @@ log10(num: number): 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

@@ -31,7 +31,7 @@ log2(num: number): number
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [log2(100), 0])
   |> line(end = [5, 8])

docs/kcl/max.md

@@ -31,7 +31,7 @@ max(args: [number]): number
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
        angle = 70,

docs/kcl/min.md

@@ -31,7 +31,7 @@ min(args: [number]): number
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
        angle = 70,

docs/kcl/patternCircular2d.md

@@ -10,7 +10,7 @@ Repeat a 2-dimensional sketch some number of times along a partial or complete c
 
 ```js
 patternCircular2d(
-  sketchSet: SketchSet,
+  sketchSet: [Sketch],
   instances: integer,
   center: [number],
   arcDegrees: number,
@@ -24,7 +24,7 @@ patternCircular2d(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `sketchSet` | [`SketchSet`](/docs/kcl/types/SketchSet) | Which sketch(es) to pattern | Yes |
+| `sketchSet` | [`[Sketch]`](/docs/kcl/types/Sketch) | Which sketch(es) to pattern | Yes |
 | `instances` | `integer` | The number of total instances. Must be greater than or equal to 1. This includes the original entity. For example, if instances is 2, there will be two copies -- the original, and one new copy. If instances is 1, this has no effect. | Yes |
 | `center` | [`[number]`](/docs/kcl/types/number) | The center about which to make the pattern. This is a 2D vector. | Yes |
 | `arcDegrees` | [`number`](/docs/kcl/types/number) | The arc angle (in degrees) to place the repetitions. Must be greater than 0. | Yes |
@@ -39,7 +39,7 @@ patternCircular2d(
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([.5, 25], %)
   |> line(end = [0, 5])
   |> line(end = [-1, 0])

docs/kcl/patternCircular3d.md

@@ -10,7 +10,7 @@ Repeat a 3-dimensional solid some number of times along a partial or complete ci
 
 ```js
 patternCircular3d(
-  solidSet: SolidSet,
+  solids: [Solid],
   instances: integer,
   axis: [number],
   center: [number],
@@ -25,7 +25,7 @@ patternCircular3d(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `solidSet` | [`SolidSet`](/docs/kcl/types/SolidSet) | Which solid(s) to pattern | Yes |
+| `solids` | [`[Solid]`](/docs/kcl/types/Solid) | Which solid(s) to pattern | Yes |
 | `instances` | `integer` | The number of total instances. Must be greater than or equal to 1. This includes the original entity. For example, if instances is 2, there will be two copies -- the original, and one new copy. If instances is 1, this has no effect. | Yes |
 | `axis` | [`[number]`](/docs/kcl/types/number) | The axis around which to make the pattern. This is a 3D vector | Yes |
 | `center` | [`[number]`](/docs/kcl/types/number) | The center about which to make the pattern. This is a 3D vector. | Yes |
@@ -41,7 +41,7 @@ patternCircular3d(
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> circle(center = [0, 0], radius = 1)
 
 example = extrude(exampleSketch, length = -5)

docs/kcl/patternLinear2d.md

@@ -10,7 +10,7 @@ Repeat a 2-dimensional sketch along some dimension, with a dynamic amount of dis
 
 ```js
 patternLinear2d(
-  sketchSet: SketchSet,
+  sketches: [Sketch],
   instances: integer,
   distance: number,
   axis: [number],
@@ -23,7 +23,7 @@ patternLinear2d(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `sketchSet` | [`SketchSet`](/docs/kcl/types/SketchSet) | The sketch(es) to duplicate | Yes |
+| `sketches` | [`[Sketch]`](/docs/kcl/types/Sketch) | The sketch(es) to duplicate | Yes |
 | `instances` | `integer` | The number of total instances. Must be greater than or equal to 1. This includes the original entity. For example, if instances is 2, there will be two copies -- the original, and one new copy. If instances is 1, this has no effect. | Yes |
 | `distance` | [`number`](/docs/kcl/types/number) | Distance between each repetition. Also known as 'spacing'. | Yes |
 | `axis` | [`[number]`](/docs/kcl/types/number) | The axis of the pattern. A 2D vector. | Yes |
@@ -37,7 +37,7 @@ patternLinear2d(
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> circle(center = [0, 0], radius = 1)
   |> patternLinear2d(axis = [1, 0], instances = 7, distance = 4)
 

docs/kcl/patternLinear3d.md

@@ -10,7 +10,7 @@ Repeat a 3-dimensional solid along a linear path, with a dynamic amount of dista
 
 ```js
 patternLinear3d(
-  solidSet: SolidSet,
+  solids: [Solid],
   instances: integer,
   distance: number,
   axis: [number],
@@ -23,7 +23,7 @@ patternLinear3d(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `solidSet` | [`SolidSet`](/docs/kcl/types/SolidSet) | The solid(s) to duplicate | Yes |
+| `solids` | [`[Solid]`](/docs/kcl/types/Solid) | The solid(s) to duplicate | Yes |
 | `instances` | `integer` | The number of total instances. Must be greater than or equal to 1. This includes the original entity. For example, if instances is 2, there will be two copies -- the original, and one new copy. If instances is 1, this has no effect. | Yes |
 | `distance` | [`number`](/docs/kcl/types/number) | Distance between each repetition. Also known as 'spacing'. | Yes |
 | `axis` | [`[number]`](/docs/kcl/types/number) | The axis of the pattern. A 2D vector. | Yes |
@@ -37,7 +37,7 @@ patternLinear3d(
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [0, 2])
   |> line(end = [3, 1])
@@ -53,7 +53,7 @@ example = extrude(exampleSketch, length = 1)
 ```js
 // Pattern a whole sketch on face.
 size = 100
-case = startSketchOn('XY')
+case = startSketchOn(XY)
   |> startProfileAt([-size, -size], %)
   |> line(end = [2 * size, 0])
   |> line(end = [0, 2 * size])
@@ -84,7 +84,7 @@ patternLinear3d(
 ```js
 // Pattern an object on a face.
 size = 100
-case = startSketchOn('XY')
+case = startSketchOn(XY)
   |> startProfileAt([-size, -size], %)
   |> line(end = [2 * size, 0])
   |> line(end = [0, 2 * size])

docs/kcl/patternTransform.md

@@ -36,7 +36,7 @@ The transform function returns a transform object. All properties of the object
 
 ```js
 patternTransform(
-  solidSet: SolidSet,
+  solids: [Solid],
   instances: integer,
   transform: FunctionSource,
   useOriginal?: bool,
@@ -48,7 +48,7 @@ patternTransform(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `solidSet` | [`SolidSet`](/docs/kcl/types/SolidSet) | The solid(s) to duplicate | Yes |
+| `solids` | [`[Solid]`](/docs/kcl/types/Solid) | The solid(s) to duplicate | Yes |
 | `instances` | `integer` | The number of total instances. Must be greater than or equal to 1. This includes the original entity. For example, if instances is 2, there will be two copies -- the original, and one new copy. If instances is 1, this has no effect. | Yes |
 | `transform` | `FunctionSource` | How each replica should be transformed. The transform function takes a single parameter: an integer representing which number replication the transform is for. E.g. the first replica to be transformed will be passed the argument `1`. This simplifies your math: the transform function can rely on id `0` being the original instance passed into the `patternTransform`. See the examples. | Yes |
 | `useOriginal` | [`bool`](/docs/kcl/types/bool) | If the target was sketched on an extrusion, setting this will use the original sketch as the target, not the entire joined solid. Defaults to false. | No |
@@ -67,7 +67,7 @@ fn transform(id) {
 }
 
 // Sketch 4 cylinders.
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> circle(center = [0, 0], radius = 2)
   |> extrude(length = 5)
   |> patternTransform(instances = 4, transform = transform)
@@ -83,7 +83,7 @@ fn transform(id) {
   return { translate = [4 * (1 + id), 0, 0] }
 }
 
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> circle(center = [0, 0], radius = 2)
   |> extrude(length = 5)
   |> patternTransform(instances = 4, transform = transform)
@@ -101,7 +101,7 @@ fn cube(length, center) {
   p2 = [l + x, l + y]
   p3 = [l + x, -l + y]
 
-  return startSketchOn('XY')
+  return startSketchOn(XY)
     |> startProfileAt(p0, %)
     |> line(endAbsolute = p1)
     |> line(endAbsolute = p2)
@@ -139,7 +139,7 @@ fn cube(length, center) {
   p2 = [l + x, l + y]
   p3 = [l + x, -l + y]
 
-  return startSketchOn('XY')
+  return startSketchOn(XY)
     |> startProfileAt(p0, %)
     |> line(endAbsolute = p1)
     |> line(endAbsolute = p2)
@@ -182,7 +182,7 @@ fn transform(replicaId) {
 }
 // Each layer is just a pretty thin cylinder.
 fn layer() {
-  return startSketchOn("XY")
+  return startSketchOn(XY)
     // or some other plane idk
     |> circle(center = [0, 0], radius = 1, tag = $tag1)
     |> extrude(length = h)
@@ -203,7 +203,7 @@ fn transform(i) {
     { rotation = { angle = 45 * i } }
   ]
 }
-startSketchOn('XY')
+startSketchOn(XY)
   |> startProfileAt([0, 0], %)
   |> polygon({
        radius = 10,

docs/kcl/pi.md

@@ -30,7 +30,7 @@ pi(): number
 ```js
 circumference = 70
 
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> circle(center = [0, 0], radius = circumference / (2 * pi()))
 
 example = extrude(exampleSketch, length = 5)

docs/kcl/polar.md

@@ -27,7 +27,7 @@ polar(data: PolarCoordsData): [number]
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = polar({ angle = 30, length = 5 }), tag = $thing)
   |> line(end = [0, 5])

docs/kcl/polygon.md

@@ -34,7 +34,7 @@ polygon(
 
 ```js
 // Create a regular hexagon inscribed in a circle of radius 10
-hex = startSketchOn('XY')
+hex = startSketchOn(XY)
   |> polygon({
        radius = 10,
        numSides = 6,
@@ -49,7 +49,7 @@ example = extrude(hex, length = 5)
 
 ```js
 // Create a square circumscribed around a circle of radius 5
-square = startSketchOn('XY')
+square = startSketchOn(XY)
   |> polygon({
        radius = 5.0,
        numSides = 4,

docs/kcl/pow.md

@@ -35,7 +35,7 @@ pow(
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({ angle = 50, length = pow(5, 2) }, %)
   |> yLine(endAbsolute = 0)

docs/kcl/reduce.md

@@ -52,7 +52,6 @@ fn sum(arr):
         sumSoFar = add(sumSoFar, i)
     return sumSoFar */
 
-
 // We use `assertEqual` to check that our `sum` function gives the
 // expected result. It's good to check your work!
 assertEqual(sum([1, 2, 3]), 6, 0.00001, "1 + 2 + 3 summed is 6")
@@ -83,7 +82,7 @@ fn decagon(radius) {
   stepAngle = 1 / 10 * TAU
 
   // Start the decagon sketch at this point.
-  startOfDecagonSketch = startSketchOn('XY')
+  startOfDecagonSketch = startSketchOn(XY)
     |> startProfileAt([cos(0) * radius, sin(0) * radius], %)
 
     // Use a `reduce` to draw the remaining decagon sides.
@@ -114,7 +113,6 @@ fn decagon(radius):
     fullDecagon = partialDecagon // it's now full
     return fullDecagon */
 
-
 // Use the `decagon` function declared above, to sketch a decagon with radius 5.
 decagon(5.0)
   |> close()

docs/kcl/round.md

@@ -31,7 +31,7 @@ round(num: number): number
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(endAbsolute = [12, 10])
   |> line(end = [round(7.02986), 0])

docs/kcl/segAng.md

@@ -27,7 +27,7 @@ segAng(tag: TagIdentifier): number
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [10, 0])
   |> line(end = [5, 10], tag = $seg01)

docs/kcl/segEnd.md

@@ -28,7 +28,7 @@ segEnd(tag: TagIdentifier): [number]
 
 ```js
 w = 15
-cube = startSketchOn('XY')
+cube = startSketchOn(XY)
   |> startProfileAt([0, 0], %)
   |> line(end = [w, 0], tag = $line1)
   |> line(end = [0, w], tag = $line2)
@@ -38,7 +38,7 @@ cube = startSketchOn('XY')
   |> extrude(length = 5)
 
 fn cylinder(radius, tag) {
-  return startSketchOn('XY')
+  return startSketchOn(XY)
     |> startProfileAt([0, 0], %)
     |> circle(radius = radius, center = segEnd(tag))
     |> extrude(length = radius)

docs/kcl/segEndX.md

@@ -27,7 +27,7 @@ segEndX(tag: TagIdentifier): number
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [20, 0], tag = $thing)
   |> line(end = [0, 5])

docs/kcl/segEndY.md

@@ -27,7 +27,7 @@ segEndY(tag: TagIdentifier): number
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [20, 0])
   |> line(end = [0, 3], tag = $thing)

docs/kcl/segLen.md

@@ -27,7 +27,7 @@ segLen(tag: TagIdentifier): number
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({ angle = 60, length = 10 }, %, $thing)
   |> tangentialArc({ offset = -120, radius = 5 }, %)

docs/kcl/segStart.md

@@ -28,7 +28,7 @@ segStart(tag: TagIdentifier): [number]
 
 ```js
 w = 15
-cube = startSketchOn('XY')
+cube = startSketchOn(XY)
   |> startProfileAt([0, 0], %)
   |> line(end = [w, 0], tag = $line1)
   |> line(end = [0, w], tag = $line2)
@@ -38,7 +38,7 @@ cube = startSketchOn('XY')
   |> extrude(length = 5)
 
 fn cylinder(radius, tag) {
-  return startSketchOn('XY')
+  return startSketchOn(XY)
     |> startProfileAt([0, 0], %)
     |> circle(radius = radius, center = segStart(tag))
     |> extrude(length = radius)

docs/kcl/segStartX.md

@@ -27,7 +27,7 @@ segStartX(tag: TagIdentifier): number
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [20, 0], tag = $thing)
   |> line(end = [0, 5])

docs/kcl/segStartY.md

@@ -27,7 +27,7 @@ segStartY(tag: TagIdentifier): number
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [20, 0])
   |> line(end = [0, 3], tag = $thing)

docs/kcl/shell.md

@@ -10,10 +10,10 @@ Remove volume from a 3-dimensional shape such that a wall of the provided thickn
 
 ```js
 shell(
-  solidSet: SolidSet,
+  solids: [Solid],
   thickness: number,
   faces: [FaceTag],
-): SolidSet
+): [Solid]
 ```
 
 
@@ -21,20 +21,20 @@ shell(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `solidSet` | [`SolidSet`](/docs/kcl/types/SolidSet) | Which solid (or solids) to shell out | Yes |
+| `solids` | [`[Solid]`](/docs/kcl/types/Solid) | Which solid (or solids) to shell out | Yes |
 | `thickness` | [`number`](/docs/kcl/types/number) | The thickness of the shell | Yes |
 | `faces` | [`[FaceTag]`](/docs/kcl/types/FaceTag) | The faces you want removed | Yes |
 
 ### Returns
 
-[`SolidSet`](/docs/kcl/types/SolidSet) - A solid or a group of solids.
+[`[Solid]`](/docs/kcl/types/Solid)
 
 
 ### Examples
 
 ```js
 // Remove the end face for the extrusion.
-firstSketch = startSketchOn('XY')
+firstSketch = startSketchOn(XY)
   |> startProfileAt([-12, 12], %)
   |> line(end = [24, 0])
   |> line(end = [0, -24])
@@ -50,7 +50,7 @@ shell(firstSketch, faces = ['end'], thickness = 0.25)
 
 ```js
 // Remove the start face for the extrusion.
-firstSketch = startSketchOn('-XZ')
+firstSketch = startSketchOn(-XZ)
   |> startProfileAt([-12, 12], %)
   |> line(end = [24, 0])
   |> line(end = [0, -24])
@@ -66,7 +66,7 @@ shell(firstSketch, faces = ['start'], thickness = 0.25)
 
 ```js
 // Remove a tagged face and the end face for the extrusion.
-firstSketch = startSketchOn('XY')
+firstSketch = startSketchOn(XY)
   |> startProfileAt([-12, 12], %)
   |> line(end = [24, 0])
   |> line(end = [0, -24])
@@ -82,7 +82,7 @@ shell(firstSketch, faces = [myTag], thickness = 0.25)
 
 ```js
 // Remove multiple faces at once.
-firstSketch = startSketchOn('XY')
+firstSketch = startSketchOn(XY)
   |> startProfileAt([-12, 12], %)
   |> line(end = [24, 0])
   |> line(end = [0, -24])
@@ -99,7 +99,7 @@ shell(firstSketch, faces = [myTag, 'end'], thickness = 0.25)
 ```js
 // Shell a sketch on face.
 size = 100
-case = startSketchOn('-XZ')
+case = startSketchOn(-XZ)
   |> startProfileAt([-size, -size], %)
   |> line(end = [2 * size, 0])
   |> line(end = [0, 2 * size])
@@ -124,7 +124,7 @@ shell(case, faces = ['start'], thickness = 5)
 ```js
 // Shell a sketch on face object on the end face.
 size = 100
-case = startSketchOn('XY')
+case = startSketchOn(XY)
   |> startProfileAt([-size, -size], %)
   |> line(end = [2 * size, 0])
   |> line(end = [0, 2 * size])
@@ -152,7 +152,7 @@ shell(thing1, faces = ['end'], thickness = 5)
 
 
 size = 100
-case = startSketchOn('XY')
+case = startSketchOn(XY)
   |> startProfileAt([-size, -size], %)
   |> line(end = [2 * size, 0])
   |> line(end = [0, 2 * size])

docs/kcl/sqrt.md

@@ -31,7 +31,7 @@ sqrt(num: number): number
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({ angle = 50, length = sqrt(2500) }, %)
   |> yLine(endAbsolute = 0)

docs/kcl/tau.md

@@ -28,7 +28,7 @@ tau(): number
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({ angle = 50, length = 10 * tau() }, %)
   |> yLine(endAbsolute = 0)

docs/kcl/toDegrees.md

@@ -31,7 +31,7 @@ toDegrees(num: number): number
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
        angle = 50,

docs/kcl/toRadians.md

@@ -31,7 +31,7 @@ toRadians(num: number): number
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
        angle = 50,

docs/kcl/types/Face.md

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

docs/kcl/types/Helix.md

@@ -1,26 +1,12 @@
 ---
-title: "Helix"
+title: "std::Helix"
 excerpt: "A helix."
 layout: manual
 ---
 
 A helix.
 
-**Type:** `object`
 
 
 
 
-
-## Properties
-
-| Property | Type | Description | Required |
-|----------|------|-------------|----------|
-| `value` |[`string`](/docs/kcl/types/string)| The id of the helix. | No |
-| `artifactId` |[`ArtifactId`](/docs/kcl/types/ArtifactId)| The artifact ID. | No |
-| `revolutions` |[`number`](/docs/kcl/types/number)| Number of revolutions. | No |
-| `angleStart` |[`number`](/docs/kcl/types/number)| Start angle (in degrees). | No |
-| `ccw` |`boolean`| Is the helix rotation counter clockwise? | No |
-| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
-
-

docs/kcl/types/HelixValue.md

@@ -21,6 +21,7 @@ A helix.
 | `revolutions` |[`number`](/docs/kcl/types/number)| Number of revolutions. | No |
 | `angleStart` |[`number`](/docs/kcl/types/number)| Start angle (in degrees). | No |
 | `ccw` |`boolean`| Is the helix rotation counter clockwise? | No |
+| `cylinderId` |[`string`](/docs/kcl/types/string)| The cylinder the helix was created on. | No |
 | `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
 
 

docs/kcl/types/KclValue.md

@@ -100,6 +100,22 @@ Any KCL value.
 
 
 
+## Properties
+
+| Property | Type | Description | Required |
+|----------|------|-------------|----------|
+| `type` |enum: `HomArray`|  | No |
+| `value` |`[` [`KclValue`](/docs/kcl/types/KclValue) `]`|  | No |
+
+
+----
+
+**Type:** `object`
+
+
+
+
+
 ## Properties
 
 | Property | Type | Description | Required |
@@ -122,7 +138,6 @@ Any KCL value.
 |----------|------|-------------|----------|
 | `type` |enum: [`TagIdentifier`](/docs/kcl/types#tag-identifier)|  | No |
 | `value` |[`string`](/docs/kcl/types/string)|  | No |
-| `info` |[`TagEngineInfo`](/docs/kcl/types/TagEngineInfo)|  | No |
 
 
 ----
@@ -173,7 +188,7 @@ Any KCL value.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `type` |enum: [`Face`](/docs/kcl/types/Face)|  | No |
-| `value` |[`Face`](/docs/kcl/types/Face)| A face. | No |
+| `value` |[`Face`](/docs/kcl/types/Face)|  | No |
 
 
 ----
@@ -200,22 +215,6 @@ Any KCL value.
 
 
 
-## Properties
-
-| Property | Type | Description | Required |
-|----------|------|-------------|----------|
-| `type` |enum: `Sketches`|  | No |
-| `value` |`[` [`Sketch`](/docs/kcl/types/Sketch) `]`|  | No |
-
-
-----
-
-**Type:** `object`
-
-
-
-
-
 ## Properties
 
 | Property | Type | Description | Required |
@@ -232,28 +231,12 @@ Any KCL value.
 
 
 
-## Properties
-
-| Property | Type | Description | Required |
-|----------|------|-------------|----------|
-| `type` |enum: `Solids`|  | No |
-| `value` |`[` [`Solid`](/docs/kcl/types/Solid) `]`|  | No |
-
-
-----
-
-**Type:** `object`
-
-
-
-
-
 ## Properties
 
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `type` |enum: [`Helix`](/docs/kcl/types/Helix)|  | No |
-| `value` |[`Helix`](/docs/kcl/types/Helix)| A helix. | No |
+| `value` |[`Helix`](/docs/kcl/types/Helix)|  | No |
 
 
 ----
@@ -338,22 +321,6 @@ Data for an imported geometry.
 
 ----
 
-**Type:** `object`
-
-
-
-
-
-## Properties
-
-| Property | Type | Description | Required |
-|----------|------|-------------|----------|
-| `type` |enum: `Tombstone`|  | No |
-| `value` |`null`|  | No |
-
-
-----
-
 
 
 

docs/kcl/types/Path.md

@@ -126,6 +126,30 @@ A base path.
 | `__geoMeta` |[`GeoMeta`](/docs/kcl/types/GeoMeta)| Metadata. | No |
 
 
+----
+A base path.
+
+**Type:** `object`
+
+
+
+
+
+## Properties
+
+| Property | Type | Description | Required |
+|----------|------|-------------|----------|
+| `type` |enum: `ArcThreePoint`|  | No |
+| `p1` |`[number, number]`| Point 1 of the arc (base on the end of previous segment) | No |
+| `p2` |`[number, number]`| Point 2 of the arc (interior kwarg) | No |
+| `p3` |`[number, number]`| Point 3 of the arc (end kwarg) | No |
+| `from` |`[number, number]`| The from point. | No |
+| `to` |`[number, number]`| The to point. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
+| [`tag`](/docs/kcl/types/tag) |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag of the path. | No |
+| `__geoMeta` |[`GeoMeta`](/docs/kcl/types/GeoMeta)| Metadata. | No |
+
+
 ----
 A path that is horizontal.
 

docs/kcl/types/Point2d.md

@@ -0,0 +1,17 @@
+---
+title: "std::Point2d"
+excerpt: "A point in two dimensional space."
+layout: manual
+---
+
+A point in two dimensional space.
+
+```kcl
+type Point2d = [number; 2]
+```
+
+`Point2d` is an alias for a two-element array of [number](/docs/kcl/types/number)s. To write a value
+with type `Point2d`, use an array, e.g., `[0, 0]` or `[5.0, 3.14]`.
+
+
+

docs/kcl/types/Point3d.md

@@ -1,22 +1,17 @@
 ---
-title: "Point3d"
+title: "std::Point3d"
-excerpt: ""
+excerpt: "A point in three dimensional space."
 layout: manual
 ---
 
+A point in three dimensional space.
 
-**Type:** `object`
+```kcl
+type Point3d = [number; 3]
+```
+
+`Point3d` is an alias for a three-element array of [number](/docs/kcl/types/number)s. To write a value
+with type `Point3d`, use an array, e.g., `[0, 0, 0]` or `[5.0, 3.14, 6.8]`.
 
 
 
-
-
-## Properties
-
-| Property | Type | Description | Required |
-|----------|------|-------------|----------|
-| `x` |[`number`](/docs/kcl/types/number)|  | No |
-| `y` |[`number`](/docs/kcl/types/number)|  | No |
-| `z` |[`number`](/docs/kcl/types/number)|  | No |
-
-

docs/kcl/types/SketchSet.md

@@ -1,56 +0,0 @@
----
-title: "SketchSet"
-excerpt: "A sketch or a group of sketches."
-layout: manual
----
-
-A sketch or a group of sketches.
-
-
-
-
-
-**This schema accepts exactly one of the following:**
-
-
-**Type:** `object`
-
-
-
-
-
-## Properties
-
-| Property | Type | Description | Required |
-|----------|------|-------------|----------|
-| `type` |enum: `sketch`|  | No |
-| `id` |[`string`](/docs/kcl/types/string)| The id of the sketch (this will change when the engine's reference to it changes). | No |
-| `paths` |`[` [`Path`](/docs/kcl/types/Path) `]`| The paths in the sketch. | No |
-| `on` |[`SketchSurface`](/docs/kcl/types/SketchSurface)| What the sketch is on (can be a plane or a face). | No |
-| `start` |[`BasePath`](/docs/kcl/types/BasePath)| The starting path. | No |
-| `tags` |`object`| Tag identifiers that have been declared in this sketch. | No |
-| `artifactId` |[`ArtifactId`](/docs/kcl/types/ArtifactId)| The original id of the sketch. This stays the same even if the sketch is is sketched on face etc. | No |
-| `originalId` |[`string`](/docs/kcl/types/string)|  | No |
-| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
-
-
-----
-
-**Type:** `[object, array]`
-
-`[` [`Sketch`](/docs/kcl/types/Sketch) `]`
-
-
-
-## Properties
-
-| Property | Type | Description | Required |
-|----------|------|-------------|----------|
-| `type` |enum: `sketches`|  | No |
-
-
-----
-
-
-
-