Move axes to std constants; move helix, revolve, and mirror2d to be declated in KCL

Signed-off-by: Nick Cameron <nrc@ncameron.org>

.env.development

@@ -1,5 +1,6 @@
 NODE_ENV=development
 DEV=true
+
 VITE_KC_API_WS_MODELING_URL=wss://api.dev.zoo.dev/ws/modeling/commands
 VITE_KC_API_BASE_URL=https://api.dev.zoo.dev
 VITE_KC_SITE_BASE_URL=https://dev.zoo.dev
@@ -8,3 +9,5 @@ VITE_KC_SKIP_AUTH=false
 VITE_KC_CONNECTION_TIMEOUT_MS=5000
 # ONLY add your token in .env.development.local if you want to skip auth, otherwise this token takes precedence!
 #VITE_KC_DEV_TOKEN="your token from dev.zoo.dev should go in .env.development.local"
+
+FAIL_ON_CONSOLE_ERRORS=true

.envrc

@@ -1 +1,13 @@
+# Load optional shared environment variables
+source_up_if_exists
+
+# Load default development environment variables
+dotenv .env.development
+
+# Load optional environment variables overrides
+dotenv_if_exists .env.development.local
+
+# Load optional testing environment variables
+dotenv_if_exists e2e/playwright/playwright-secrets.env
+
 use flake .

.eslintrc

@@ -20,6 +20,7 @@
       "plugin:react-hooks/recommended"
     ],
     "rules": {
+      "@typescript-eslint/no-empty-object-type": "error",
       "@typescript-eslint/no-floating-promises": "error",
       "@typescript-eslint/no-misused-promises": "error",
       "@typescript-eslint/no-unused-vars": ["error", {

.github/workflows/e2e-tests.yml

@@ -1,7 +1,9 @@
 name: E2E Tests
 on:
   push:
-    branches: [ main ]
+    branches:
+      - main
+      - all-e2e # this bypasses `fixme()` using `orRunWhenFullSuiteEnabled()`
   pull_request:
   schedule:
     - cron: 0 * * * *  # hourly
@@ -15,7 +17,6 @@ permissions:
   pull-requests: write
   actions: read
 
-
 jobs:
 
   conditions:
@@ -67,14 +68,16 @@ jobs:
       - name: Display conditions
         shell: bash
         run: |
-          # For debugging purposes.
+          # For debugging purposes
           set -euo pipefail
+          echo "GITHUB_REF: $GITHUB_REF"
+          echo "GITHUB_HEAD_REF: $GITHUB_HEAD_REF"
+          echo "GITHUB_BASE_REF: $GITHUB_BASE_REF"
           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
+    # separate 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:
@@ -160,7 +163,6 @@ jobs:
           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
@@ -243,7 +245,7 @@ jobs:
           retention-days: 30
           overwrite: true
 
-      - name: check for changes
+      - name: Check for changes
         if: ${{ needs.conditions.outputs.should-run == 'true' && github.ref != 'refs/heads/main' }}
         shell: bash
         id: git-check
@@ -255,7 +257,8 @@ jobs:
             fi
 
       - name: Commit changes, if any
-        if: ${{ needs.conditions.outputs.should-run == 'true' && steps.git-check.outputs.modified == 'true' }}
+        # TODO: find a more reliable way to detect visual changes
+        if: ${{ false && 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
@@ -341,7 +344,7 @@ jobs:
         run: yarn tronb:vite:dev
 
       - name: Install vector
-        if: contains(matrix.os, 'ubuntu')
+        if: ${{ needs.conditions.outputs.should-run == 'true' && contains(matrix.os, 'ubuntu') }}
         shell: bash
         run: |
           curl --proto '=https' --tlsv1.2 -sSfL https://sh.vector.dev > /tmp/vector.sh

.github/workflows/static-analysis.yml

@@ -141,13 +141,13 @@ jobs:
         if: ${{ github.event_name != 'release' && github.event_name != 'schedule' }}
         run: yarn playwright install chromium --with-deps
 
-      - name: run unit tests
+      - name: Run unit tests
         if: ${{ github.event_name != 'release' && github.event_name != 'schedule' }}
         run: xvfb-run -a yarn test:unit
         env:
           VITE_KC_DEV_TOKEN: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
 
-      - name: check for changes
+      - name: Check for changes
         if: ${{ github.event_name != 'release' && github.event_name != 'schedule' }}
         id: git-check
         run: |

.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,45 @@
+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/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: Sync with main
+        run: |
+          # Create the branch
+          git checkout all-e2e || git checkout -b all-e2e
+
+          # Reset to main
+          git fetch origin
+          git reset --hard origin/main
+
+          # Get a new SHA to prevent overwriting the commit status on main
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git commit --allow-empty --message="[all-e2e] $(git log --max-count=1 --pretty=%B)"
+
+          # Overwrite the branch
+          git remote set-url origin https://x-access-token:${{ steps.app-token.outputs.token }}@github.com/${{ github.repository }}.git
+          git push --force origin all-e2e

Makefile

@@ -20,8 +20,12 @@ $(WASM_PACK):
 ###############################################################################
 # BUILD
 
-RUST_SOURCES := $(wildcard rust/*) $(wildcard rust/**/*)
+CARGO_SOURCES := rust/.cargo/config.toml $(wildcard rust/Cargo.*) $(wildcard rust/**/Cargo.*)
-TYPESCRIPT_SOURCES := $(wildcard src/**/*.tsx) $(wildcard src/**/*.ts)
+RUST_SOURCES := $(wildcard rust/**/*.rs)
+
+REACT_SOURCES := $(wildcard src/*.tsx) $(wildcard src/**/*.tsx)
+TYPESCRIPT_SOURCES := tsconfig.* $(wildcard src/*.ts) $(wildcard src/**/*.ts)
+VITE_SOURCES := $(wildcard vite.*) $(wildcard vite/**/*.tsx)
 
 .PHONY: build
 build: build-web build-desktop
@@ -32,13 +36,13 @@ 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)
+public/kcl_wasm_lib_bg.wasm: $(CARGO_SOURCES)$(RUST_SOURCES)
 	yarn build:wasm
 
-build/index.html: $(TYPESCRIPT_SOURCES)
+build/index.html: $(REACT_SOURCES) $(TYPESCRIPT_SOURCES) $(VITE_SOURCES)
 	yarn build:local
 
-.vite/build/main.js: $(TYPESCRIPT_SOURCES)
+.vite/build/main.js: $(REACT_SOURCES) $(TYPESCRIPT_SOURCES) $(VITE_SOURCES)
 	yarn tronb:vite:dev
 
 ###############################################################################
@@ -73,19 +77,29 @@ run-desktop: install build-desktop ## Start the desktop app
 ###############################################################################
 # TEST
 
-GREP ?= ""
+E2E_WORKERS ?= 1
+E2E_FAILURES ?= 1
+E2E_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 )
+	@ curl -fs localhost:3000 >/dev/null || ( 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
+test-e2e: test-e2e-desktop
-	yarn test:playwright:electron --workers=1 --grep=$(GREP)
+
+.PHONY: test-e2e-web
+test-e2e-web: install build-web ## Run the web e2e tests
+	@ curl -fs localhost:3000 >/dev/null || ( echo "Error: localhost:3000 not available, 'make run-web' first" && exit 1 )
+	yarn chrome:test --headed --workers=$(E2E_WORKERS) --max-failures=$(E2E_FAILURES) --grep=$(E2E_GREP)
+
+.PHONY: test-e2e-desktop
+test-e2e-desktop: install build-desktop ## Run the desktop e2e tests
+	yarn test:playwright:electron --workers=$(E2E_WORKERS) --max-failures=$(E2E_FAILURES) --grep=$(E2E_GREP)
 
 ###############################################################################
 # CLEAN

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

@@ -36,7 +36,7 @@ appearance(
 
 ```js
 // Add color to an extruded solid.
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(endAbsolute = [10, 0])
   |> line(endAbsolute = [0, 10])
@@ -52,9 +52,9 @@ example = extrude(exampleSketch, length = 5)
 
 ```js
 // Add color to a revolved solid.
-sketch001 = startSketchOn('XY')
+sketch001 = startSketchOn(XY)
   |> circle(center = [15, 0], radius = 5)
-  |> revolve(angle = 360, axis = 'y')
+  |> revolve(angle = 360, axis = Y)
   |> appearance(color = '#ff0000', metalness = 90, roughness = 90)
 ```
 
@@ -63,7 +63,7 @@ sketch001 = startSketchOn('XY')
 ```js
 // Add color to different solids.
 fn cube(center) {
-  return startSketchOn('XY')
+  return startSketchOn(XY)
     |> startProfileAt([center[0] - 10, center[1] - 10], %)
     |> line(endAbsolute = [center[0] + 10, center[1] - 10])
     |> line(endAbsolute = [center[0] + 10, center[1] + 10])
@@ -95,7 +95,7 @@ appearance(
 ```js
 // You can set the appearance before or after you shell it will yield the same result.
 // This example shows setting the appearance _after_ the shell.
-firstSketch = startSketchOn('XY')
+firstSketch = startSketchOn(XY)
   |> startProfileAt([-12, 12], %)
   |> line(end = [24, 0])
   |> line(end = [0, -24])
@@ -112,7 +112,7 @@ shell(firstSketch, faces = ['end'], thickness = 0.25)
 ```js
 // You can set the appearance before or after you shell it will yield the same result.
 // This example shows setting the appearance _before_ the shell.
-firstSketch = startSketchOn('XY')
+firstSketch = startSketchOn(XY)
   |> startProfileAt([-12, 12], %)
   |> line(end = [24, 0])
   |> line(end = [0, -24])
@@ -129,7 +129,7 @@ shell(firstSketch, faces = ['end'], thickness = 0.25)
 ```js
 // Setting the appearance of a 3D pattern can be done _before_ or _after_ the pattern.
 // This example shows _before_ the pattern.
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [0, 2])
   |> line(end = [3, 1])
@@ -146,7 +146,7 @@ example = extrude(exampleSketch, length = 1)
 ```js
 // Setting the appearance of a 3D pattern can be done _before_ or _after_ the pattern.
 // This example shows _after_ the pattern.
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [0, 2])
   |> line(end = [3, 1])
@@ -162,7 +162,7 @@ example = extrude(exampleSketch, length = 1)
 
 ```js
 // Color the result of a 2D pattern that was extruded.
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([.5, 25], %)
   |> line(end = [0, 5])
   |> line(end = [-1, 0])
@@ -185,7 +185,7 @@ example = extrude(exampleSketch, length = 1)
 // Color the result of a sweep.
 
 // Create a path for the sweep.
-sweepPath = startSketchOn('XZ')
+sweepPath = startSketchOn(XZ)
   |> startProfileAt([0.05, 0.05], %)
   |> line(end = [0, 7])
   |> tangentialArc({ offset = 90, radius = 5 }, %)
@@ -193,10 +193,10 @@ sweepPath = startSketchOn('XZ')
   |> tangentialArc({ offset = -90, radius = 5 }, %)
   |> line(end = [0, 7])
 
-pipeHole = startSketchOn('XY')
+pipeHole = startSketchOn(XY)
   |> circle(center = [0, 0], radius = 1.5)
 
-sweepSketch = startSketchOn('XY')
+sweepSketch = startSketchOn(XY)
   |> circle(center = [0, 0], radius = 2)
   |> hole(pipeHole, %)
   |> sweep(path = sweepPath)

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

@@ -10,10 +10,10 @@ Construct a circle derived from 3 points.
 
 ```js
 circleThreePoint(
+  sketchSurfaceOrGroup: SketchOrSurface,
   p1: [number],
   p2: [number],
   p3: [number],
-  sketchSurfaceOrGroup: SketchOrSurface,
   tag?: TagDeclarator,
 ): Sketch
 ```
@@ -23,10 +23,10 @@ circleThreePoint(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
+| `sketchSurfaceOrGroup` | [`SketchOrSurface`](/docs/kcl/types/SketchOrSurface) | Plane or surface to sketch on. | 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`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Identifier for the circle to reference elsewhere. | No |
 
 ### Returns
@@ -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/consts.md

@@ -9,13 +9,12 @@ layout: manual
 
 ### `std`
 
-- [`HALF_TURN`](/docs/kcl/consts/std-HALF_TURN)
+- [`X`](/docs/kcl/consts/std-X)
-- [`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)
+- [`Y`](/docs/kcl/consts/std-Y)
 - [`YZ`](/docs/kcl/consts/std-YZ)
-- [`ZERO`](/docs/kcl/consts/std-ZERO)
+- [`Z`](/docs/kcl/consts/std-Z)
 
 ### `std::math`
 
@@ -23,3 +22,10 @@ layout: manual
 - [`PI`](/docs/kcl/consts/std-math-PI)
 - [`TAU`](/docs/kcl/consts/std-math-TAU)
 
+### `std::turns`
+
+- [`HALF_TURN`](/docs/kcl/consts/std-turns-HALF_TURN)
+- [`QUARTER_TURN`](/docs/kcl/consts/std-turns-QUARTER_TURN)
+- [`THREE_QUARTER_TURN`](/docs/kcl/consts/std-turns-THREE_QUARTER_TURN)
+- [`ZERO`](/docs/kcl/consts/std-turns-ZERO)
+

docs/kcl/consts/std-HALF_TURN.md

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

docs/kcl/consts/std-QUARTER_TURN.md

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

docs/kcl/consts/std-THREE_QUARTER_TURN.md

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

docs/kcl/consts/std-X.md

@@ -1,5 +1,5 @@
 ---
-title: "std::ZERO"
+title: "std::X"
 excerpt: ""
 layout: manual
 ---
@@ -9,7 +9,7 @@ layout: manual
 
 
 ```js
-std::ZERO: number = 0
+std::X
 ```
 
 

docs/kcl/consts/std-Y.md

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

docs/kcl/consts/std-Z.md

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

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

@@ -15,7 +15,7 @@ std::math::E: number = 2.71828182845904523536028747135266250_
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
     angle = 30,

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

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

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

@@ -15,7 +15,7 @@ std::math::TAU: number = 6.28318530717958647692528676655900577_
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
     angle = 50,

docs/kcl/consts/std-turns-HALF_TURN.md

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

docs/kcl/consts/std-turns-QUARTER_TURN.md

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

docs/kcl/consts/std-turns-THREE_QUARTER_TURN.md

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

docs/kcl/consts/std-turns-ZERO.md

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

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

@@ -31,7 +31,7 @@ getCommonEdge(faces: [TagIdentifier]): Uuid
 
 
 scale = 20
-part001 = startSketchOn('XY')
+part001 = startSketchOn(XY)
   |> startProfileAt([0, 0], %)
   |> line(end = [0, scale])
   |> line(end = [scale, 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/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,20 +22,22 @@ layout: manual
   * [`string`](kcl/types/string)
   * [`tag`](kcl/types/tag)
 * **std**
+  * [`Axis2d`](kcl/types/Axis2d)
+  * [`Axis3d`](kcl/types/Axis3d)
+  * [`Edge`](kcl/types/Edge)
   * [`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)
+  * [`X`](kcl/consts/std-X)
   * [`XY`](kcl/consts/std-XY)
   * [`XZ`](kcl/consts/std-XZ)
+  * [`Y`](kcl/consts/std-Y)
   * [`YZ`](kcl/consts/std-YZ)
-  * [`ZERO`](kcl/consts/std-ZERO)
+  * [`Z`](kcl/consts/std-Z)
   * [`abs`](kcl/abs)
   * [`acos`](kcl/acos)
   * [`angleToMatchLengthX`](kcl/angleToMatchLengthX)
@@ -61,7 +63,6 @@ layout: manual
   * [`bezierCurve`](kcl/bezierCurve)
   * [`ceil`](kcl/ceil)
   * [`chamfer`](kcl/chamfer)
-  * [`circle`](kcl/circle)
   * [`circleThreePoint`](kcl/circleThreePoint)
   * [`close`](kcl/close)
   * [`cm`](kcl/cm)
@@ -73,8 +74,7 @@ layout: manual
   * [`getNextAdjacentEdge`](kcl/getNextAdjacentEdge)
   * [`getOppositeEdge`](kcl/getOppositeEdge)
   * [`getPreviousAdjacentEdge`](kcl/getPreviousAdjacentEdge)
-  * [`helix`](kcl/helix)
+  * [`helix`](kcl/std-helix)
-  * [`helixRevolutions`](kcl/helixRevolutions)
   * [`hole`](kcl/hole)
   * [`hollow`](kcl/hollow)
   * [`inch`](kcl/inch)
@@ -93,7 +93,6 @@ layout: manual
   * [`map`](kcl/map)
   * [`max`](kcl/max)
   * [`min`](kcl/min)
-  * [`mirror2d`](kcl/mirror2d)
   * [`mm`](kcl/mm)
   * [`offsetPlane`](kcl/offsetPlane)
   * [`patternCircular2d`](kcl/patternCircular2d)
@@ -112,7 +111,7 @@ layout: manual
   * [`push`](kcl/push)
   * [`reduce`](kcl/reduce)
   * [`rem`](kcl/rem)
-  * [`revolve`](kcl/revolve)
+  * [`revolve`](kcl/std-revolve)
   * [`rotate`](kcl/rotate)
   * [`round`](kcl/round)
   * [`scale`](kcl/scale)
@@ -146,3 +145,11 @@ layout: manual
   * [`cos`](kcl/std-math-cos)
   * [`sin`](kcl/std-math-sin)
   * [`tan`](kcl/std-math-tan)
+* **std::sketch**
+  * [`circle`](kcl/std-sketch-circle)
+  * [`mirror2d`](kcl/std-sketch-mirror2d)
+* **std::turns**
+  * [`turns::HALF_TURN`](kcl/consts/std-turns-HALF_TURN)
+  * [`turns::QUARTER_TURN`](kcl/consts/std-turns-QUARTER_TURN)
+  * [`turns::THREE_QUARTER_TURN`](kcl/consts/std-turns-THREE_QUARTER_TURN)
+  * [`turns::ZERO`](kcl/consts/std-turns-ZERO)

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

@@ -30,7 +30,7 @@ intersect(solids: [Solid]): [Solid]
 
 ```js
 fn cube(center) {
-  return startSketchOn('XY')
+  return startSketchOn(XY)
     |> startProfileAt([center[0] - 10, center[1] - 10], %)
     |> line(endAbsolute = [center[0] + 10, center[1] - 10])
     |> line(endAbsolute = [center[0] + 10, center[1] + 10])

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

@@ -42,7 +42,7 @@ loft(
 
 ```js
 // Loft a square and a triangle.
-squareSketch = startSketchOn('XY')
+squareSketch = startSketchOn(XY)
   |> startProfileAt([-100, 200], %)
   |> line(end = [200, 0])
   |> line(end = [0, -200])
@@ -50,7 +50,7 @@ squareSketch = startSketchOn('XY')
   |> line(endAbsolute = [profileStartX(%), profileStartY(%)])
   |> close()
 
-triangleSketch = startSketchOn(offsetPlane('XY', offset = 75))
+triangleSketch = startSketchOn(offsetPlane(XY, offset = 75))
   |> startProfileAt([0, 125], %)
   |> line(end = [-15, -30])
   |> line(end = [30, 0])
@@ -64,7 +64,7 @@ loft([squareSketch, triangleSketch])
 
 ```js
 // Loft a square, a circle, and another circle.
-squareSketch = startSketchOn('XY')
+squareSketch = startSketchOn(XY)
   |> startProfileAt([-100, 200], %)
   |> line(end = [200, 0])
   |> line(end = [0, -200])
@@ -72,10 +72,10 @@ squareSketch = startSketchOn('XY')
   |> line(endAbsolute = [profileStartX(%), profileStartY(%)])
   |> close()
 
-circleSketch0 = startSketchOn(offsetPlane('XY', offset = 75))
+circleSketch0 = startSketchOn(offsetPlane(XY, offset = 75))
   |> circle(center = [0, 100], radius = 50)
 
-circleSketch1 = startSketchOn(offsetPlane('XY', offset = 150))
+circleSketch1 = startSketchOn(offsetPlane(XY, offset = 150))
   |> circle(center = [0, 100], radius = 20)
 
 loft([
@@ -89,7 +89,7 @@ loft([
 
 ```js
 // Loft a square, a circle, and another circle with options.
-squareSketch = startSketchOn('XY')
+squareSketch = startSketchOn(XY)
   |> startProfileAt([-100, 200], %)
   |> line(end = [200, 0])
   |> line(end = [0, -200])
@@ -97,10 +97,10 @@ squareSketch = startSketchOn('XY')
   |> line(endAbsolute = [profileStartX(%), profileStartY(%)])
   |> close()
 
-circleSketch0 = startSketchOn(offsetPlane('XY', offset = 75))
+circleSketch0 = startSketchOn(offsetPlane(XY, offset = 75))
   |> circle(center = [0, 100], radius = 50)
 
-circleSketch1 = startSketchOn(offsetPlane('XY', offset = 150))
+circleSketch1 = startSketchOn(offsetPlane(XY, offset = 150))
   |> circle(center = [0, 100], radius = 20)
 
 loft(

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

@@ -33,7 +33,7 @@ map(
 ```js
 r = 10 // radius
 fn drawCircle(id) {
-  return startSketchOn("XY")
+  return startSketchOn(XY)
     |> circle(center = [id * 2 * r, 0], radius = r)
 }
 
@@ -49,7 +49,7 @@ circles = map([1..3], drawCircle)
 r = 10 // radius
 // Call `map`, using an anonymous function instead of a named one.
 circles = map([1..3], fn(id) {
-  return startSketchOn("XY")
+  return startSketchOn(XY)
     |> circle(center = [id * 2 * r, 0], radius = r)
 })
 ```

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

@@ -32,7 +32,7 @@ offsetPlane(
 
 ```js
 // Loft a square and a circle on the `XY` plane using offset.
-squareSketch = startSketchOn('XY')
+squareSketch = startSketchOn(XY)
   |> startProfileAt([-100, 200], %)
   |> line(end = [200, 0])
   |> line(end = [0, -200])
@@ -40,7 +40,7 @@ squareSketch = startSketchOn('XY')
   |> line(endAbsolute = [profileStartX(%), profileStartY(%)])
   |> close()
 
-circleSketch = startSketchOn(offsetPlane('XY', offset = 150))
+circleSketch = startSketchOn(offsetPlane(XY, offset = 150))
   |> circle(center = [0, 100], radius = 50)
 
 loft([squareSketch, circleSketch])
@@ -50,7 +50,7 @@ loft([squareSketch, circleSketch])
 
 ```js
 // Loft a square and a circle on the `XZ` plane using offset.
-squareSketch = startSketchOn('XZ')
+squareSketch = startSketchOn(XZ)
   |> startProfileAt([-100, 200], %)
   |> line(end = [200, 0])
   |> line(end = [0, -200])
@@ -58,7 +58,7 @@ squareSketch = startSketchOn('XZ')
   |> line(endAbsolute = [profileStartX(%), profileStartY(%)])
   |> close()
 
-circleSketch = startSketchOn(offsetPlane('XZ', offset = 150))
+circleSketch = startSketchOn(offsetPlane(XZ, offset = 150))
   |> circle(center = [0, 100], radius = 50)
 
 loft([squareSketch, circleSketch])
@@ -68,7 +68,7 @@ loft([squareSketch, circleSketch])
 
 ```js
 // Loft a square and a circle on the `YZ` plane using offset.
-squareSketch = startSketchOn('YZ')
+squareSketch = startSketchOn(YZ)
   |> startProfileAt([-100, 200], %)
   |> line(end = [200, 0])
   |> line(end = [0, -200])
@@ -76,7 +76,7 @@ squareSketch = startSketchOn('YZ')
   |> line(endAbsolute = [profileStartX(%), profileStartY(%)])
   |> close()
 
-circleSketch = startSketchOn(offsetPlane('YZ', offset = 150))
+circleSketch = startSketchOn(offsetPlane(YZ, offset = 150))
   |> circle(center = [0, 100], radius = 50)
 
 loft([squareSketch, circleSketch])
@@ -86,7 +86,7 @@ loft([squareSketch, circleSketch])
 
 ```js
 // Loft a square and a circle on the `-XZ` plane using offset.
-squareSketch = startSketchOn('-XZ')
+squareSketch = startSketchOn(-XZ)
   |> startProfileAt([-100, 200], %)
   |> line(end = [200, 0])
   |> line(end = [0, -200])
@@ -94,7 +94,7 @@ squareSketch = startSketchOn('-XZ')
   |> line(endAbsolute = [profileStartX(%), profileStartY(%)])
   |> close()
 
-circleSketch = startSketchOn(offsetPlane('-XZ', offset = -150))
+circleSketch = startSketchOn(offsetPlane(-XZ, offset = -150))
   |> circle(center = [0, 100], radius = 50)
 
 loft([squareSketch, circleSketch])
@@ -104,12 +104,12 @@ loft([squareSketch, circleSketch])
 
 ```js
 // A circle on the XY plane
-startSketchOn("XY")
+startSketchOn(XY)
   |> startProfileAt([0, 0], %)
   |> circle(radius = 10, center = [0, 0])
 
 // Triangle on the plane 4 units above
-startSketchOn(offsetPlane("XY", offset = 4))
+startSketchOn(offsetPlane(XY, offset = 4))
   |> startProfileAt([0, 0], %)
   |> line(end = [10, 0])
   |> line(end = [0, 10])

docs/kcl/patternCircular2d.md

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

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

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

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

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

@@ -41,7 +41,7 @@ fn transform(id) {
 }
 
 // Sketch 4 circles.
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> circle(center = [0, 0], radius = 2)
   |> patternTransform2d(instances = 4, transform = transform)
 ```

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

@@ -82,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.

docs/kcl/rotate.md

@@ -58,7 +58,7 @@ rotate(
 // Rotate a pipe with roll, pitch, and yaw.
 
 // Create a path for the sweep.
-sweepPath = startSketchOn('XZ')
+sweepPath = startSketchOn(XZ)
   |> startProfileAt([0.05, 0.05], %)
   |> line(end = [0, 7])
   |> tangentialArc({ offset = 90, radius = 5 }, %)
@@ -67,10 +67,10 @@ sweepPath = startSketchOn('XZ')
   |> line(end = [0, 7])
 
 // Create a hole for the pipe.
-pipeHole = startSketchOn('XY')
+pipeHole = startSketchOn(XY)
   |> circle(center = [0, 0], radius = 1.5)
 
-sweepSketch = startSketchOn('XY')
+sweepSketch = startSketchOn(XY)
   |> circle(center = [0, 0], radius = 2)
   |> hole(pipeHole, %)
   |> sweep(path = sweepPath)
@@ -83,7 +83,7 @@ sweepSketch = startSketchOn('XY')
 // Rotate a pipe about an axis with an angle.
 
 // Create a path for the sweep.
-sweepPath = startSketchOn('XZ')
+sweepPath = startSketchOn(XZ)
   |> startProfileAt([0.05, 0.05], %)
   |> line(end = [0, 7])
   |> tangentialArc({ offset = 90, radius = 5 }, %)
@@ -92,10 +92,10 @@ sweepPath = startSketchOn('XZ')
   |> line(end = [0, 7])
 
 // Create a hole for the pipe.
-pipeHole = startSketchOn('XY')
+pipeHole = startSketchOn(XY)
   |> circle(center = [0, 0], radius = 1.5)
 
-sweepSketch = startSketchOn('XY')
+sweepSketch = startSketchOn(XY)
   |> circle(center = [0, 0], radius = 2)
   |> hole(pipeHole, %)
   |> sweep(path = sweepPath)
@@ -120,7 +120,7 @@ cube
 // Sweep two sketches along the same path.
 
 
-sketch001 = startSketchOn('XY')
+sketch001 = startSketchOn(XY)
 rectangleSketch = startProfileAt([-200, 23.86], sketch001)
   |> angledLine([0, 73.47], %, $rectangleSegmentA001)
   |> angledLine([
@@ -136,7 +136,7 @@ rectangleSketch = startProfileAt([-200, 23.86], sketch001)
 
 circleSketch = circle(sketch001, center = [200, -30.29], radius = 32.63)
 
-sketch002 = startSketchOn('YZ')
+sketch002 = startSketchOn(YZ)
 sweepPath = startProfileAt([0, 0], sketch002)
   |> yLine(length = 231.81)
   |> tangentialArc({ radius = 80, offset = -90 }, %)
@@ -152,7 +152,7 @@ rotate(parts, axis = [0, 0, 1.0], angle = 90)
 
 ```js
 // Translate and rotate a sketch to create a loft.
-sketch001 = startSketchOn('XY')
+sketch001 = startSketchOn(XY)
 
 fn square() {
   return startProfileAt([-10, 10], sketch001)

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

@@ -38,7 +38,7 @@ scale(
 // Scale a pipe.
 
 // Create a path for the sweep.
-sweepPath = startSketchOn('XZ')
+sweepPath = startSketchOn(XZ)
   |> startProfileAt([0.05, 0.05], %)
   |> line(end = [0, 7])
   |> tangentialArc({ offset = 90, radius = 5 }, %)
@@ -47,10 +47,10 @@ sweepPath = startSketchOn('XZ')
   |> line(end = [0, 7])
 
 // Create a hole for the pipe.
-pipeHole = startSketchOn('XY')
+pipeHole = startSketchOn(XY)
   |> circle(center = [0, 0], radius = 1.5)
 
-sweepSketch = startSketchOn('XY')
+sweepSketch = startSketchOn(XY)
   |> circle(center = [0, 0], radius = 2)
   |> hole(pipeHole, %)
   |> sweep(path = sweepPath)
@@ -75,7 +75,7 @@ cube
 // Sweep two sketches along the same path.
 
 
-sketch001 = startSketchOn('XY')
+sketch001 = startSketchOn(XY)
 rectangleSketch = startProfileAt([-200, 23.86], sketch001)
   |> angledLine([0, 73.47], %, $rectangleSegmentA001)
   |> angledLine([
@@ -91,7 +91,7 @@ rectangleSketch = startProfileAt([-200, 23.86], sketch001)
 
 circleSketch = circle(sketch001, center = [200, -30.29], radius = 32.63)
 
-sketch002 = startSketchOn('YZ')
+sketch002 = startSketchOn(YZ)
 sweepPath = startProfileAt([0, 0], sketch002)
   |> yLine(length = 231.81)
   |> tangentialArc({ radius = 80, offset = -90 }, %)

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

@@ -34,7 +34,7 @@ shell(
 
 ```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/startSketchOn.md

@@ -146,7 +146,7 @@ exampleSketch = startSketchOn(XY)
   |> line(end = [-2, 0])
   |> close()
 
-example = revolve(exampleSketch, axis = 'y', angle = 180)
+example = revolve(exampleSketch, axis = Y, angle = 180)
 
 exampleSketch002 = startSketchOn(example, 'end')
   |> startProfileAt([4.5, -5], %)
@@ -177,7 +177,7 @@ exampleSketch = startSketchOn(XY)
 
 example = revolve(
   exampleSketch,
-  axis = 'y',
+  axis = Y,
   angle = 180,
   tagEnd = $end01,
 )

docs/kcl/std-math-cos.md

@@ -9,7 +9,7 @@ Compute the cosine of a number (in radians).
 
 
 ```js
-cos(num: number(rad)): number(_)
+cos(@num: number(rad)): number(_)
 ```
 
 
@@ -27,7 +27,7 @@ cos(num: number(rad)): number(_)
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
     angle = 30,

docs/kcl/std-math-sin.md

@@ -9,7 +9,7 @@ Compute the sine of a number (in radians).
 
 
 ```js
-sin(num: number(rad)): number(_)
+sin(@num: number(rad)): number(_)
 ```
 
 
@@ -27,7 +27,7 @@ sin(num: number(rad)): number(_)
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
     angle = 50,

docs/kcl/std-math-tan.md

@@ -9,7 +9,7 @@ Compute the tangent of a number (in radians).
 
 
 ```js
-tan(num: number(rad)): number(_)
+tan(@num: number(rad)): number(_)
 ```
 
 
@@ -27,7 +27,7 @@ tan(num: number(rad)): number(_)
 ### Examples
 
 ```js
-exampleSketch = startSketchOn("XZ")
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLine({
     angle = 50,

docs/kcl/subtract.md

@@ -34,7 +34,7 @@ subtract(
 
 ```js
 fn cube(center) {
-  return startSketchOn('XY')
+  return startSketchOn(XY)
     |> startProfileAt([center[0] - 10, center[1] - 10], %)
     |> line(endAbsolute = [center[0] + 10, center[1] - 10])
     |> line(endAbsolute = [center[0] + 10, center[1] + 10])
@@ -44,7 +44,7 @@ fn cube(center) {
 }
 
 part001 = cube([0, 0])
-part002 = startSketchOn('XY')
+part002 = startSketchOn(XY)
   |> circle(center = [0, 0], radius = 2)
   |> extrude(length = 10)
 

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,