properly flush batch (#5565)

* properly flush batch

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

* add test

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

* add test

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

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

* only flush if not on error

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

* better method

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

* updates

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

* ensure nothing in batch assembly test

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

---------

Signed-off-by: Jess Frazelle <github@jessfraz.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

.eslintignore

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

.gitattributes

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

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

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

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

@@ -22,6 +22,9 @@ jobs:
         uses: Swatinem/rust-cache@v2
         with:
           workspaces: './src/wasm-lib'
+      - uses: taiki-e/install-action@2dbeb927f58939d3aa13bf06ba0c0a34b76b9bfb
+        with:
+          tool: wasm-pack
       - name: build wasm
         run: yarn build:wasm
 

.github/workflows/build-apps.yml

@@ -7,14 +7,11 @@ on:
       - main
     tags:
       - 'v[0-9]+.[0-9]+.[0-9]+'
-  schedule:
+      - 'nightly-v[0-9]+.[0-9]+.[0-9]+'
-    - cron: '0 4 * * *'
-  # Daily at 04:00 AM UTC
-  # Will checkout the last commit from the default branch (main as of 2023-10-04)
 
 env:
-  IS_RELEASE: ${{ github.ref_type == 'tag' }}
+  IS_RELEASE: ${{ github.ref_type == 'tag' && startsWith(github.ref_name, 'v') }}
-  IS_NIGHTLY: ${{ github.event_name == 'schedule' }}
+  IS_NIGHTLY: ${{ github.ref_type == 'tag' && startsWith(github.ref_name, 'nightly-v') }}
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
@@ -44,12 +41,19 @@ jobs:
           workspaces: './src/wasm-lib'
 
       # TODO: see if we can fetch from main instead if no diff at src/wasm-lib
+      - uses: taiki-e/install-action@2dbeb927f58939d3aa13bf06ba0c0a34b76b9bfb
+        with:
+          tool: wasm-pack
+
       - name: Run build:wasm
         run: "yarn build:wasm"
 
       - name: Set nightly version, product name, release notes, and icons
         if: ${{ env.IS_NIGHTLY == 'true' }}
-        run: yarn files:flip-to-nightly
+        run: |
+          export VERSION=${GITHUB_REF_NAME#nightly-v}
+          yarn files:set-version
+          yarn files:flip-to-nightly
 
       - name: Set release version
         if: ${{ env.IS_RELEASE == 'true' }}
@@ -128,7 +132,7 @@ jobs:
 
       - name: yarn install
         # Windows is picky sometimes and fails on fetch. Step takes about ~30s
-        uses: nick-fields/retry@v3.0.0
+        uses: nick-fields/retry@v3.0.1
         with:
           timeout_minutes: 2
           max_attempts: 3
@@ -179,7 +183,7 @@ jobs:
           WINDOWS_CERTIFICATE_THUMBPRINT: ${{ secrets.WINDOWS_CERTIFICATE_THUMBPRINT }}
           DEBUG: "electron-notarize*"
         # TODO: Fix electron-notarize flakes. The logs above should help gather more data on failures
-        uses: nick-fields/retry@v3.0.0
+        uses: nick-fields/retry@v3.0.1
         with:
           timeout_minutes: 10
           max_attempts: 3
@@ -240,7 +244,7 @@ jobs:
           WINDOWS_CERTIFICATE_THUMBPRINT: ${{ secrets.WINDOWS_CERTIFICATE_THUMBPRINT }}
           DEBUG: "electron-notarize*"
         # TODO: Fix electron-notarize flakes. The logs above should help gather more data on failures
-        uses: nick-fields/retry@v3.0.0
+        uses: nick-fields/retry@v3.0.1
         with:
           timeout_minutes: 10
           max_attempts: 3
@@ -269,7 +273,7 @@ jobs:
     runs-on: ubuntu-22.04
     permissions:
       contents: write
-    if: ${{ github.ref_type == 'tag' || github.event_name == 'schedule' }}
+    if: ${{ github.ref_type == 'tag' }}
     env:
       VERSION_NO_V: ${{ needs.prepare-files.outputs.version }}
       VERSION: ${{ format('v{0}', needs.prepare-files.outputs.version) }}
@@ -326,8 +330,8 @@ jobs:
         env:
           NOTES: ${{ needs.prepare-files.outputs.notes }}
           PUB_DATE: ${{ github.event.repository.updated_at }}
-          WEBSITE_DIR: ${{ github.event_name == 'schedule' && 'dl.zoo.dev/releases/modeling-app/nightly' || 'dl.zoo.dev/releases/modeling-app' }}
+          WEBSITE_DIR: ${{ env.IS_NIGHTLY == 'true' && 'dl.zoo.dev/releases/modeling-app/nightly' || 'dl.zoo.dev/releases/modeling-app' }}
-          URL_CODED_NAME: ${{ github.event_name == 'schedule' && 'Zoo%20Modeling%20App%20%28Nightly%29' || 'Zoo%20Modeling%20App' }}
+          URL_CODED_NAME: ${{ env.IS_NIGHTLY == 'true' && 'Zoo%20Modeling%20App%20%28Nightly%29' || 'Zoo%20Modeling%20App' }}
         run: |
           RELEASE_DIR=https://${WEBSITE_DIR}
           jq --null-input \
@@ -382,7 +386,7 @@ jobs:
           # see https://github.com/actions/checkout/issues/1471
           git fetch --prune --unshallow --tags
           export TAG="nightly-${VERSION}"
-          export PREVIOUS_TAG=$(git describe --tags --match="nightly-v[0-9]*" --abbrev=0)
+          export PREVIOUS_TAG=$(git tag --list --sort=-committerdate "nightly-v[0-9]*" | head -n2 | tail -n1)
           export NOTES=$(./scripts/get-nightly-changelog.sh)
           yarn files:set-notes
 
@@ -410,14 +414,3 @@ jobs:
       - name: Invalidate bucket cache on latest*.yml and last_download.json files
         if: ${{ env.IS_NIGHTLY == 'true' }}
         run: yarn files:invalidate-bucket:nightly
-
-      - name: Tag nightly commit
-        if: ${{ env.IS_NIGHTLY == 'true' }}
-        uses: actions/github-script@v7
-        with:
-          script: |
-            const { VERSION } = process.env          
-            const { owner, repo } = context.repo
-            const { sha } = context
-            const ref = `refs/tags/nightly-${VERSION}`
-            github.rest.git.createRef({ owner, repo, sha, ref })

.github/workflows/cargo-test.yml

@@ -46,7 +46,7 @@ jobs:
         shell: bash
         run: |-
           cd "${{ matrix.dir }}"
-          cargo llvm-cov nextest --workspace --lcov --output-path lcov.info --test-threads=1 --no-fail-fast -P ci 2>&1 | tee /tmp/github-actions.log
+          cargo llvm-cov nextest --workspace --lcov --output-path lcov.info --test-threads=1 --retries=2 --no-fail-fast -P ci 2>&1 | tee /tmp/github-actions.log
         env:
           KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
           RUST_MIN_STACK: 10485760000

.github/workflows/check-exampleKcl.yml

@@ -27,6 +27,15 @@ jobs:
             const owner = context.repo.owner;
             const repo = context.repo.repo;
             
+            const { data: comments } = await github.rest.issues.listComments({
+              owner,
+              repo,
+              issue_number
+            });
+
+            const commentExists = comments.some(comment => comment.body === message);
+
+            if (!commentExists) {
               // Post a comment on the PR
               await github.rest.issues.createComment({
                 owner,
@@ -34,3 +43,4 @@ jobs:
                 issue_number,
                 body: message,
               });
+            }

.github/workflows/e2e-tests.yml

@@ -3,6 +3,8 @@ on:
   push:
     branches: [ main ]
   pull_request:
+  schedule:
+    - cron: 0 * * * *  # hourly
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
@@ -15,23 +17,6 @@ permissions:
 
 
 jobs:
-
-  check-rust-changes:
-    runs-on: ubuntu-latest
-    outputs:
-      rust-changed: ${{ steps.filter.outputs.rust }}
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - id: filter
-        name: Check for Rust changes
-        uses: dorny/paths-filter@v3
-        with:
-          filters: |
-            rust:
-              - 'src/wasm-lib/**'
-
   electron:
     timeout-minutes: 60
     name: playwright:electron:${{ matrix.os }} ${{ matrix.shardIndex }} ${{ matrix.shardTotal }}
@@ -42,8 +27,8 @@ jobs:
         os: [namespace-profile-ubuntu-8-cores, namespace-profile-macos-8-cores, windows-16-cores]
         shardIndex: [1, 2, 3, 4]
         shardTotal: [4]
+        # TODO: add ref here for main and latest release tag
     runs-on: ${{ matrix.os }}
-    needs: check-rust-changes
     steps:
     - uses: actions/create-github-app-token@v1
       id: app-token
@@ -54,6 +39,13 @@ jobs:
     - uses: actions/checkout@v4
       with:
         token: ${{ steps.app-token.outputs.token }}
+    - id: filter
+      name: Check for Rust changes
+      uses: dorny/paths-filter@v3
+      with:
+        filters: |
+          rust:
+            - 'src/wasm-lib/**'
     - uses: actions/setup-node@v4
       with:
         node-version-file: '.nvmrc'
@@ -73,7 +65,7 @@ jobs:
       run: yarn playwright install --with-deps
     - name: Download Wasm Cache
       id: download-wasm
-      if: needs.check-rust-changes.outputs.rust-changed == 'false'
+      if: github.event_name != 'schedule' && steps.filter.outputs.rust == 'false'
       uses: dawidd6/action-download-artifact@v7
       continue-on-error: true
       with:
@@ -83,14 +75,17 @@ jobs:
         branch: main
         path: src/wasm-lib/pkg
     - name: copy wasm blob
-      if: needs.check-rust-changes.outputs.rust-changed == 'false'
+      if: github.event_name != 'schedule' && steps.filter.outputs.rust == 'false'
       shell: bash
       run: cp src/wasm-lib/pkg/wasm_lib_bg.wasm public
       continue-on-error: true
     - name: Setup Rust
       uses: dtolnay/rust-toolchain@stable
+    - uses: taiki-e/install-action@2dbeb927f58939d3aa13bf06ba0c0a34b76b9bfb
+      with:
+        tool: wasm-pack
     - name: Cache Wasm (because rust diff)
-      if: needs.check-rust-changes.outputs.rust-changed == 'true'
+      if: github.event_name == 'schedule' || steps.filter.outputs.rust == 'true'
       uses: Swatinem/rust-cache@v2
       with:
         workspaces: './src/wasm-lib'
@@ -123,7 +118,7 @@ jobs:
         cat /tmp/vector.toml
         ${HOME}/.vector/bin/vector --config /tmp/vector.toml &
     - name: Build Wasm (because rust diff)
-      if: needs.check-rust-changes.outputs.rust-changed == 'true'
+      if: github.event_name == 'schedule' || steps.filter.outputs.rust == 'true'
       shell: bash
       run: yarn build:wasm
     - name: OR Build Wasm (because wasm cache failed)
@@ -139,7 +134,7 @@ jobs:
       # TODO: break this in its own job, for now it's not slowing down the overall execution as ubuntu is the quickest,
       # but we could do better. This forces a large 1/1 shard of all 20 snapshot tests that runs in about 3 minutes.
       run: |
-        PLATFORM=web yarn playwright test --config=playwright.config.ts --retries="3" --update-snapshots --grep=@snapshot  --shard=1/1
+        PLATFORM=web yarn playwright test --config=playwright.config.ts --retries="3" --update-snapshots --grep=@snapshot --trace=on --shard=1/1
       env:
         CI: true
         NODE_ENV: development
@@ -150,7 +145,7 @@ jobs:
     - uses: actions/upload-artifact@v4
       if: ${{ !cancelled() && (success() || failure()) }}
       with:
-        name: playwright-report-${{ matrix.os }}-snapshot-${{ matrix.shardIndex }}-${{ github.sha }}
+        name: playwright-report-snapshots-${{ matrix.os }}-snapshot-${{ matrix.shardIndex }}-${{ github.sha }}
         path: playwright-report/
         include-hidden-files: true
         retention-days: 30
@@ -164,7 +159,7 @@ jobs:
       shell: bash
       id: git-check
       run: |
-          git add e2e/playwright/snapshot-tests.spec.ts-snapshots
+          git add e2e/playwright/snapshot-tests.spec.ts-snapshots e2e/playwright/snapshots
           if git status | grep -q "Changes to be committed"
           then echo "modified=true" >> $GITHUB_OUTPUT
           else echo "modified=false" >> $GITHUB_OUTPUT
@@ -173,7 +168,7 @@ jobs:
       if: steps.git-check.outputs.modified == 'true'
       shell: bash
       run: |
-        git add e2e/playwright/snapshot-tests.spec.ts-snapshots
+        git add e2e/playwright/snapshot-tests.spec.ts-snapshots e2e/playwright/snapshots
         git config --local user.email "github-actions[bot]@users.noreply.github.com"
         git config --local user.name "github-actions[bot]"
         git remote set-url origin https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git
@@ -200,9 +195,11 @@ jobs:
     - name: Run playwright/electron flow (with retries)
       id: retry
       if: ${{ !cancelled() && (success() || failure()) }}
-      shell: bash
+      uses: nick-fields/retry@v3.0.1
-      run: |
+      with:
-        .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}} ${{matrix.os}}
+        timeout_minutes: 30
+        max_attempts: 25
       env:
         CI: true
         FAIL_ON_CONSOLE_ERRORS: true

.github/workflows/static-analysis.yml

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

.github/workflows/tag-nightly.yml

@@ -0,0 +1,39 @@
+name: tag-nightly
+
+permissions:
+  contents: write
+on:
+  schedule:
+    - cron: '0 4 * * *'
+  # Daily at 04:00 AM UTC
+  # Will checkout the last commit from the default branch (main as of 2023-10-04)
+  
+jobs:
+  tag-nightly:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/create-github-app-token@v1
+        id: app-token
+        with:
+          app-id: ${{ secrets.MODELING_APP_GH_APP_ID }}
+          private-key: ${{ secrets.MODELING_APP_GH_APP_PRIVATE_KEY }}
+          owner: ${{ github.repository_owner }}
+
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ steps.app-token.outputs.token }}
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+
+      - run: yarn install
+
+      - name: Push tag
+        run: |
+          VERSION_NO_V=$(date +'%-y.%-m.%-d')
+          TAG="nightly-v$VERSION_NO_V"
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git tag $TAG
+          git push origin tag $TAG

.gitignore

@@ -41,9 +41,12 @@ e2e/playwright/playwright-secrets.env
 e2e/playwright/temp1.png
 e2e/playwright/temp2.png
 e2e/playwright/temp3.png
+# this will be overridden for specific directories
+e2e/playwright/**/*.png
 # exports from snapshot-tests.spec.ts "exports of each format should work"
 e2e/playwright/export-snapshots/*
 !e2e/playwright/export-snapshots/*.png
+!e2e/playwright/snapshot-tests.spec.ts-snapshots/*.png
 
 /kcl-samples
 /test-results/
@@ -68,3 +71,4 @@ venv
 
 # electron
 out/
+*.snap.new

.prettierignore

@@ -10,6 +10,7 @@ target
 src/wasm-lib/pkg
 src/wasm-lib/kcl/bindings
 e2e/playwright/export-snapshots
+e2e/playwright/snapshots/prompt-to-edit
 
 
 # XState generated files

README.md

@@ -48,22 +48,49 @@ We recommend downloading the latest application binary from [our Releases page](
 
 ## Running a development build
 
-First, [install Rust via `rustup`](https://www.rust-lang.org/tools/install). This project uses a lot of Rust compiled to [WASM](https://webassembly.org/) within it. We always use the latest stable version of Rust, so you may need to run `rustup update stable`. Then, run:
+Install a node version manager such as [fnm](https://github.com/Schniz/fnm?tab=readme-ov-#installation).
 
+On Windows, it's also recommended to [upgrade your PowerShell version](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.5#winget), we're using 7.
+
+Then in the repo run the following to install and use the node version specified in `.nvmrc`. You might need to specify your processor architecture with `--arch arm64` or `--arch x64` if it's not autodetected. 
+```
+fnm install --corepack-enabled
+fnm use
+```
+
+Install the NPM dependencies with:
 ```
 yarn install
 ```
 
-followed by:
+This project uses a lot of Rust compiled to [WASM](https://webassembly.org/) within it. We have package scripts to run rustup, see `package.json` for reference:
-
 ```
+# macOS/Linux
+yarn install:rust
+yarn install:wasm-pack:sh
+
+# Windows
+yarn install:rust:windows
+yarn install:wasm-pack:cargo
+```
+
+Then to build the WASM layer, run:
+```
+# macOS/Linux
 yarn build:wasm
+
+# Windows
+yarn build:wasm:windows
 ```
 
-or if you have the gh cli installed
+Or if you have the `gh` cli installed and want to download the latest main wasm bundle. Note that on Windows, you need to associate .ps1 files with PowerShell, which can be done via the right click menu, selecting `C:\Program Files\PowerShell\7\pwsh.exe`, and you can install tools like `gh` via `yarn install:tools:windows`.
 
 ```
-./get-latest-wasm-bundle.sh # this will download the latest main wasm bundle
+# macOS/Linux
+yarn fetch:wasm
+
+# Windows
+yarn fetch:wasm:windows
 ```
 
 That will build the WASM binary and put in the `public` dir (though gitignored).
@@ -74,7 +101,7 @@ Finally, to run the web app only, run:
 yarn start
 ```
 
-If you're not an KittyCAD employee you won't be able to access the dev environment, you should copy everything from `.env.production` to `.env.development` to make it point to production instead, then when you navigate to `localhost:3000` the easiest way to sign in is to paste `localStorage.setItem('TOKEN_PERSIST_KEY', "your-token-from-https://zoo.dev/account/api-tokens")` replacing the with a real token from https://zoo.dev/account/api-tokens of course, then navigate to localhost:3000 again. Note that navigating to `localhost:3000/signin` removes your token so you will need to set the token again.
+If you're not a Zoo employee you won't be able to access the dev environment, you should copy everything from `.env.production` to `.env.development` to make it point to production instead, then when you navigate to `localhost:3000` the easiest way to sign in is to paste `localStorage.setItem('TOKEN_PERSIST_KEY', "your-token-from-https://zoo.dev/account/api-tokens")` replacing the with a real token from https://zoo.dev/account/api-tokens of course, then navigate to localhost:3000 again. Note that navigating to `localhost:3000/signin` removes your token so you will need to set the token again.
 
 ### Development environment variables
 
@@ -101,7 +128,7 @@ This will start the application and hot-reload on changes.
 
 Devtools can be opened with the usual Cmd-Opt-I (Mac) or Ctrl-Shift-I (Linux and Windows).
 
-To build 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
 

docs/kcl/angledLine.md

@@ -9,7 +9,11 @@ Draw a line segment relative to the current origin using the polar
 measure of some angle and distance.
 
 ```js
-angledLine(data: AngledLineData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+angledLine(
+  data: AngledLineData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ angledLine(data: AngledLineData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> yLineTo(15, %)
   |> angledLine({ angle = 30, length = 15 }, %)

docs/kcl/angledLineThatIntersects.md

@@ -9,7 +9,11 @@ Draw an angled line from the current origin, constructing a line segment
 such that the newly created line intersects the desired target line segment.
 
 ```js
-angledLineThatIntersects(data: AngledLineThatIntersectsData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+angledLineThatIntersects(
+  data: AngledLineThatIntersectsData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ angledLineThatIntersects(data: AngledLineThatIntersectsData, sketch: Sketch, tag
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(endAbsolute = [5, 10])
   |> line(endAbsolute = [-10, 10], tag = $lineToIntersect)

docs/kcl/angledLineToX.md

@@ -9,7 +9,11 @@ Create a line segment from the current 2-dimensional sketch origin
 along some angle (in degrees) for some length, ending at the provided value in the 'x' dimension.
 
 ```js
-angledLineToX(data: AngledLineToData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+angledLineToX(
+  data: AngledLineToData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -29,7 +33,7 @@ angledLineToX(data: AngledLineToData, sketch: Sketch, tag?: TagDeclarator) -> Sk
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLineToX({ angle = 30, to = 10 }, %)
   |> line(end = [0, 10])

docs/kcl/assert.md

@@ -9,7 +9,10 @@ Check a value at runtime, and raise an error if the argument provided
 is false.
 
 ```js
-assert(data: bool, message: string) -> ()
+assert(
+  data: bool,
+  message: string,
+) -> ()
 ```
 
 

docs/kcl/assertEqual.md

@@ -9,7 +9,12 @@ Check that a numerical value equals another at runtime,
 otherwise raise an error.
 
 ```js
-assertEqual(left: number, right: number, epsilon: number, message: string) -> ()
+assertEqual(
+  left: number,
+  right: number,
+  epsilon: number,
+  message: string,
+) -> ()
 ```
 
 

docs/kcl/assertGreaterThan.md

@@ -9,7 +9,11 @@ Check that a numerical value is greater than another at runtime,
 otherwise raise an error.
 
 ```js
-assertGreaterThan(left: number, right: number, message: string) -> ()
+assertGreaterThan(
+  left: number,
+  right: number,
+  message: string,
+) -> ()
 ```
 
 

docs/kcl/assertGreaterThanOrEq.md

@@ -9,7 +9,11 @@ Check that a numerical value is greater than or equal to another at runtime,
 otherwise raise an error.
 
 ```js
-assertGreaterThanOrEq(left: number, right: number, message: string) -> ()
+assertGreaterThanOrEq(
+  left: number,
+  right: number,
+  message: string,
+) -> ()
 ```
 
 

docs/kcl/assertLessThan.md

@@ -9,7 +9,11 @@ Check that a numerical value is less than to another at runtime,
 otherwise raise an error.
 
 ```js
-assertLessThan(left: number, right: number, message: string) -> ()
+assertLessThan(
+  left: number,
+  right: number,
+  message: string,
+) -> ()
 ```
 
 

docs/kcl/assertLessThanOrEq.md

@@ -9,7 +9,11 @@ Check that a numerical value is less than or equal to another at runtime,
 otherwise raise an error.
 
 ```js
-assertLessThanOrEq(left: number, right: number, message: string) -> ()
+assertLessThanOrEq(
+  left: number,
+  right: number,
+  message: string,
+) -> ()
 ```
 
 

docs/kcl/atan2.md

@@ -9,7 +9,10 @@ Compute the four quadrant arctangent of Y and X (in radians).
 
 
 ```js
-atan2(y: number, x: number) -> number
+atan2(
+  y: number,
+  x: number,
+) -> number
 ```
 
 ### Tags

docs/kcl/const_std-HALF_TURN.md

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

docs/kcl/const_std-QUARTER_TURN.md

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

docs/kcl/const_std-THREE_QUARTER_TURN.md

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

docs/kcl/const_std-XY.md

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

docs/kcl/const_std-XZ.md

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

docs/kcl/const_std-YZ.md

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

docs/kcl/const_std-ZERO.md

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

docs/kcl/e.md

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

docs/kcl/index.md

@@ -6,9 +6,23 @@ layout: manual
 
 ## Table of Contents
 
-* [Types](kcl/types)
+### Language
-* [Modules](kcl/modules)
+
-* [Known Issues](kcl/KNOWN-ISSUES)
+* [`Types`](kcl/types)
+* [`Modules`](kcl/modules)
+* [`Settings`](kcl/settings)
+* [`Known Issues`](kcl/known-issues)
+
+### Standard library
+
+* **`std`**
+  * [`HALF_TURN`](kcl/const_std-HALF_TURN)
+  * [`QUARTER_TURN`](kcl/const_std-QUARTER_TURN)
+  * [`THREE_QUARTER_TURN`](kcl/const_std-THREE_QUARTER_TURN)
+  * [`XY`](kcl/const_std-XY)
+  * [`XZ`](kcl/const_std-XZ)
+  * [`YZ`](kcl/const_std-YZ)
+  * [`ZERO`](kcl/const_std-ZERO)
   * [`abs`](kcl/abs)
   * [`acos`](kcl/acos)
   * [`angleToMatchLengthX`](kcl/angleToMatchLengthX)
@@ -38,8 +52,6 @@ layout: manual
   * [`circleThreePoint`](kcl/circleThreePoint)
   * [`close`](kcl/close)
   * [`cm`](kcl/cm)
-* [`cos`](kcl/cos)
-* [`e`](kcl/e)
   * [`extrude`](kcl/extrude)
   * [`fillet`](kcl/fillet)
   * [`floor`](kcl/floor)
@@ -76,7 +88,6 @@ layout: manual
   * [`patternLinear3d`](kcl/patternLinear3d)
   * [`patternTransform`](kcl/patternTransform)
   * [`patternTransform2d`](kcl/patternTransform2d)
-* [`pi`](kcl/pi)
   * [`polar`](kcl/polar)
   * [`polygon`](kcl/polygon)
   * [`pop`](kcl/pop)
@@ -88,7 +99,9 @@ layout: manual
   * [`reduce`](kcl/reduce)
   * [`rem`](kcl/rem)
   * [`revolve`](kcl/revolve)
+  * [`rotate`](kcl/rotate)
   * [`round`](kcl/round)
+  * [`scale`](kcl/scale)
   * [`segAng`](kcl/segAng)
   * [`segEnd`](kcl/segEnd)
   * [`segEndX`](kcl/segEndX)
@@ -98,21 +111,26 @@ layout: manual
   * [`segStartX`](kcl/segStartX)
   * [`segStartY`](kcl/segStartY)
   * [`shell`](kcl/shell)
-* [`sin`](kcl/sin)
   * [`sqrt`](kcl/sqrt)
   * [`startProfileAt`](kcl/startProfileAt)
   * [`startSketchOn`](kcl/startSketchOn)
   * [`sweep`](kcl/sweep)
-* [`tan`](kcl/tan)
   * [`tangentToEnd`](kcl/tangentToEnd)
   * [`tangentialArc`](kcl/tangentialArc)
   * [`tangentialArcTo`](kcl/tangentialArcTo)
   * [`tangentialArcToRelative`](kcl/tangentialArcToRelative)
-* [`tau`](kcl/tau)
   * [`toDegrees`](kcl/toDegrees)
   * [`toRadians`](kcl/toRadians)
+  * [`translate`](kcl/translate)
   * [`xLine`](kcl/xLine)
   * [`xLineTo`](kcl/xLineTo)
   * [`yLine`](kcl/yLine)
   * [`yLineTo`](kcl/yLineTo)
   * [`yd`](kcl/yd)
+* **`std::math`**
+  * [`E`](kcl/const_std-math-E)
+  * [`PI`](kcl/const_std-math-PI)
+  * [`TAU`](kcl/const_std-math-TAU)
+  * [`cos`](kcl/std-math-cos)
+  * [`sin`](kcl/std-math-sin)
+  * [`tan`](kcl/std-math-tan)

docs/kcl/legAngX.md

@@ -9,7 +9,10 @@ Compute the angle of the given leg for x.
 
 
 ```js
-legAngX(hypotenuse: number, leg: number) -> number
+legAngX(
+  hypotenuse: number,
+  leg: number,
+) -> number
 ```
 
 ### Tags

docs/kcl/legAngY.md

@@ -9,7 +9,10 @@ Compute the angle of the given leg for y.
 
 
 ```js
-legAngY(hypotenuse: number, leg: number) -> number
+legAngY(
+  hypotenuse: number,
+  leg: number,
+) -> number
 ```
 
 ### Tags

docs/kcl/legLen.md

@@ -9,7 +9,10 @@ Compute the length of the given leg.
 
 
 ```js
-legLen(hypotenuse: number, leg: number) -> number
+legLen(
+  hypotenuse: number,
+  leg: number,
+) -> number
 ```
 
 ### Tags

docs/kcl/line.md

@@ -9,7 +9,12 @@ Extend the current sketch with a new straight line.
 
 
 ```js
-line(sketch: Sketch, end_absolute?: [number], end?: [number], tag?: TagDeclarator) -> Sketch
+line(
+  sketch: Sketch,
+  endAbsolute?: [number],
+  end?: [number],
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -18,7 +23,7 @@ line(sketch: Sketch, end_absolute?: [number], end?: [number], tag?: TagDeclarato
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | Which sketch should this path be added to? | Yes |
-| `end_absolute` | `[number]` | Which absolute point should this line go to? Incompatible with `end`. | No |
+| `endAbsolute` | `[number]` | Which absolute point should this line go to? Incompatible with `end`. | No |
 | `end` | `[number]` | How far away (along the X and Y axes) should this line go? Incompatible with `endAbsolute`. | No |
 | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this line | No |
 
@@ -30,7 +35,7 @@ line(sketch: Sketch, end_absolute?: [number], end?: [number], tag?: TagDeclarato
 ### Examples
 
 ```js
-triangle = startSketchOn("XZ")
+triangle = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   // The 'end' argument means it ends at exactly [10, 0].
   // This is an absolute measurement, it is NOT relative to
@@ -41,7 +46,7 @@ triangle = startSketchOn("XZ")
   |> close()
   |> extrude(length = 5)
 
-box = startSketchOn("XZ")
+box = startSketchOn(XZ)
   |> startProfileAt([10, 10], %)
   // The 'to' argument means move the pen this much.
   // So, [10, 0] is a relative distance away from the current point.

docs/kcl/map.md

@@ -9,7 +9,10 @@ Apply a function to every element of a list.
 Given a list like `[a, b, c]`, and a function like `f`, returns `[f(a), f(b), f(c)]`
 
 ```js
-map(array: [KclValue], map_fn: FunctionParam) -> [KclValue]
+map(
+  array: [KclValue],
+  mapFn: FunctionSource,
+) -> [KclValue]
 ```
 
 
@@ -18,7 +21,7 @@ map(array: [KclValue], map_fn: FunctionParam) -> [KclValue]
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `array` | [`[KclValue]`](/docs/kcl/types/KclValue) |  | Yes |
-| `map_fn` | `FunctionParam` |  | Yes |
+| `mapFn` | `FunctionSource` |  | Yes |
 
 ### Returns
 

docs/kcl/modules.md

@@ -20,7 +20,7 @@ export fn increment(x) {
 Other files in the project can now import functions that have been exported.
 This makes them available to use in another file.
 
-```
+```norun
 // main.kcl
 import increment from "util.kcl"
 
@@ -48,13 +48,13 @@ export fn decrement(x) {
 
 When importing, you can import multiple functions at once.
 
-```
+```norun
 import increment, decrement from "util.kcl"
 ```
 
 Imported symbols can be renamed for convenience or to avoid name collisions.
 
-```
+```norun
 import increment as inc, decrement as dec from "util.kcl"
 ```
 
@@ -63,13 +63,13 @@ import increment as inc, decrement as dec from "util.kcl"
 `import` can also be used to import files from other CAD systems. The format of the statement is the
 same as for KCL files. You can only import the whole file, not items from it. E.g.,
 
-```
+```norun
 import "tests/inputs/cube.obj"
 
 // Use `cube` just like a KCL object.
 ```
 
-```
+```norun
 import "tests/inputs/cube-2.sldprt" as cube
 
 // Use `cube` just like a KCL object.
@@ -78,7 +78,7 @@ import "tests/inputs/cube-2.sldprt" as cube
 You can make the file format explicit using a format attribute (useful if using a different
 extension), e.g.,
 
-```
+```norun
 @(format = obj)
 import "tests/inputs/cube"
 ```
@@ -87,7 +87,7 @@ For formats lacking unit data (such as STL, OBJ, or PLY files), the default
 unit of measurement is millimeters. Alternatively you may specify the unit
 by using an attirbute. Likewise, you can also specify a coordinate system. E.g.,
 
-```
+```norun
 @(unitLength = ft, coords = opengl)
 import "tests/inputs/cube.obj"
 ```

docs/kcl/patternCircular2d.md

@@ -9,7 +9,14 @@ Repeat a 2-dimensional sketch some number of times along a partial or
 complete circle some specified number of times. Each object may additionally be rotated along the circle, ensuring orentation of the solid with respect to the center of the circle is maintained.
 
 ```js
-patternCircular2d(sketch_set: SketchSet, instances: integer, center: [number], arc_degrees: number, rotate_duplicates: bool, use_original?: bool) -> [Sketch]
+patternCircular2d(
+  sketchSet: SketchSet,
+  instances: integer,
+  center: [number],
+  arcDegrees: number,
+  rotateDuplicates: bool,
+  useOriginal?: bool,
+) -> [Sketch]
 ```
 
 
@@ -17,12 +24,12 @@ patternCircular2d(sketch_set: SketchSet, instances: integer, center: [number], a
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `sketch_set` | [`SketchSet`](/docs/kcl/types/SketchSet) | Which sketch(es) to pattern | Yes |
+| `sketchSet` | [`SketchSet`](/docs/kcl/types/SketchSet) | Which sketch(es) to pattern | Yes |
 | `instances` | `integer` | The number of total instances. Must be greater than or equal to 1. This includes the original entity. For example, if instances is 2, there will be two copies -- the original, and one new copy. If instances is 1, this has no effect. | Yes |
 | `center` | `[number]` | The center about which to make the pattern. This is a 2D vector. | Yes |
-| `arc_degrees` | `number` | The arc angle (in degrees) to place the repetitions. Must be greater than 0. | Yes |
+| `arcDegrees` | `number` | The arc angle (in degrees) to place the repetitions. Must be greater than 0. | Yes |
-| `rotate_duplicates` | `bool` | Whether or not to rotate the duplicates as they are copied. | Yes |
+| `rotateDuplicates` | `bool` | Whether or not to rotate the duplicates as they are copied. | Yes |
-| `use_original` | `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 |
+| `useOriginal` | `bool` | If the target was sketched on an extrusion, setting this will use the original sketch as the target, not the entire joined solid. Defaults to false. | No |
 
 ### Returns
 

docs/kcl/pi.md

@@ -4,9 +4,11 @@ excerpt: "Return the value of `pi`. Archimedes’ constant (π)."
 layout: manual
 ---
 
+**WARNING:** This function is deprecated.
+
 Return the value of `pi`. Archimedes’ constant (π).
 
-
+**DEPRECATED** use the constant PI
 
 ```js
 pi() -> number

docs/kcl/polygon.md

@@ -9,7 +9,11 @@ Create a regular polygon with the specified number of sides that is either inscr
 
 
 ```js
-polygon(data: PolygonData, sketch_surface_or_group: SketchOrSurface, tag?: TagDeclarator) -> Sketch
+polygon(
+  data: PolygonData,
+  sketchSurfaceOrGroup: SketchOrSurface,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 
@@ -18,7 +22,7 @@ polygon(data: PolygonData, sketch_surface_or_group: SketchOrSurface, tag?: TagDe
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `data` | [`PolygonData`](/docs/kcl/types/PolygonData) | Data for drawing a polygon | Yes |
-| `sketch_surface_or_group` | [`SketchOrSurface`](/docs/kcl/types/SketchOrSurface) | A sketch surface or a sketch. | Yes |
+| `sketchSurfaceOrGroup` | [`SketchOrSurface`](/docs/kcl/types/SketchOrSurface) | A sketch surface or a sketch. | Yes |
 | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
 
 ### Returns

docs/kcl/pow.md

@@ -9,7 +9,10 @@ Compute the number to a power.
 
 
 ```js
-pow(num: number, pow: number) -> number
+pow(
+  num: number,
+  pow: number,
+) -> number
 ```
 
 ### Tags

docs/kcl/profileStartX.md

@@ -27,7 +27,7 @@ profileStartX(sketch: Sketch) -> number
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XY')
+sketch001 = startSketchOn(XY)
   |> startProfileAt([5, 2], %)
   |> angledLine([-26.6, 50], %)
   |> angledLine([90, 50], %)

docs/kcl/profileStartY.md

@@ -27,7 +27,7 @@ profileStartY(sketch: Sketch) -> number
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XY')
+sketch001 = startSketchOn(XY)
   |> startProfileAt([5, 2], %)
   |> angledLine({ angle = -60, length = 14 }, %)
   |> angledLineToY({ angle = 30, to = profileStartY(%) }, %)

docs/kcl/push.md

@@ -9,7 +9,10 @@ Append an element to the end of an array.
 Returns a new array with the element appended.
 
 ```js
-push(array: [KclValue], elem: KclValue) -> KclValue
+push(
+  array: [KclValue],
+  elem: KclValue,
+) -> KclValue
 ```
 
 

docs/kcl/reduce.md

@@ -9,7 +9,11 @@ Take a starting value. Then, for each element of an array, calculate the next va
 using the previous value and the element.
 
 ```js
-reduce(array: [KclValue], start: KclValue, reduce_fn: FunctionParam) -> KclValue
+reduce(
+  array: [KclValue],
+  start: KclValue,
+  reduceFn: FunctionSource,
+) -> KclValue
 ```
 
 
@@ -19,7 +23,7 @@ reduce(array: [KclValue], start: KclValue, reduce_fn: FunctionParam) -> KclValue
 |----------|------|-------------|----------|
 | `array` | [`[KclValue]`](/docs/kcl/types/KclValue) |  | Yes |
 | `start` | [`KclValue`](/docs/kcl/types/KclValue) | Any KCL value. | Yes |
-| `reduce_fn` | `FunctionParam` |  | Yes |
+| `reduceFn` | `FunctionSource` |  | Yes |
 
 ### Returns
 
@@ -76,7 +80,7 @@ assertEqual(sum, 6, 0.00001, "1 + 2 + 3 summed is 6")
 // Declare a function that sketches a decagon.
 fn decagon(radius) {
   // Each side of the decagon is turned this many degrees from the previous angle.
-  stepAngle = 1 / 10 * tau()
+  stepAngle = 1 / 10 * TAU
 
   // Start the decagon sketch at this point.
   startOfDecagonSketch = startSketchOn('XY')
@@ -97,7 +101,7 @@ fn decagon(radius) {
 
 /* The `decagon` above is basically like this pseudo-code:
 fn decagon(radius):
-    stepAngle = (1/10) * tau()
+    stepAngle = (1/10) * TAU
     plane = startSketchOn('XY')
     startOfDecagonSketch = startProfileAt([(cos(0)*radius), (sin(0) * radius)], plane)
 

docs/kcl/rem.md

@@ -9,7 +9,10 @@ Compute the remainder after dividing `num` by `div`.
 If `num` is negative, the result will be too.
 
 ```js
-rem(num: number, divisor: number) -> number
+rem(
+  num: number,
+  divisor: number,
+) -> number
 ```
 
 ### Tags

docs/kcl/settings.md

@@ -0,0 +1,30 @@
+---
+title: "KCL settings"
+excerpt: "Documentation of settings for the KCL language and Zoo Modeling App."
+layout: manual
+---
+
+# Per-file settings
+
+Settings which affect a single file are configured using the settings attribute.
+This must be at the top of the KCL file (comments before the attribute are permitted).
+E.g.,
+
+```
+// The settings attribute.
+@settings(defaultLengthUnit = in)
+
+// The rest of your KCL code goes below...
+
+x = 42 // Represents 42 inches.
+```
+
+The settings attribute may contain multiple properties separated by commas.
+Valid properties are:
+
+- `defaultLengthUnit`: the default length unit to use for numbers declared in this file.
+  - Accepted values: `mm`, `cm`, `m`, `in` (inches), `ft` (feet), `yd` (yards).
+- `defaultAngleUnit`: the default angle unit to use for numbers declared in this file.
+  - Accepted values: `deg` (degrees), `rad` (radians).
+
+These settings override any project-wide settings (configured in project.toml or via the UI).