tag as top level part 2 (#2773)

* updates Signed-off-by: Jess Frazelle <[email protected]> * A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu) * updates Signed-off-by: Jess Frazelle <[email protected]> * fmt Signed-off-by: Jess Frazelle <[email protected]> * updates Signed-off-by: Jess Frazelle <[email protected]> * unit tests pass Signed-off-by: Jess Frazelle <[email protected]> * playwright Signed-off-by: Jess Frazelle <[email protected]> * updates Signed-off-by: Jess Frazelle <[email protected]> * format Signed-off-by: Jess Frazelle <[email protected]> * format Signed-off-by: Jess Frazelle <[email protected]> * updates Signed-off-by: Jess Frazelle <[email protected]> * more literals gone Signed-off-by: Jess Frazelle <[email protected]> * updates Signed-off-by: Jess Frazelle <[email protected]> * fixes Signed-off-by: Jess Frazelle <[email protected]> * remove console log Signed-off-by: Jess Frazelle <[email protected]> * fixes Signed-off-by: Jess Frazelle <[email protected]> * remove only Signed-off-by: Jess Frazelle <[email protected]> * fix some recast shit Signed-off-by: Jess Frazelle <[email protected]> * updates Signed-off-by: Jess Frazelle <[email protected]> * last Signed-off-by: Jess Frazelle <[email protected]> --------- Signed-off-by: Jess Frazelle <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
KittyCAD · Jun 25, 2024 · da6cd5c · da6cd5c
1 parent ad5bfa1
commit da6cd5c
Show file tree

Hide file tree

Showing 44 changed files with 720 additions and 536 deletions.
diff --git a/docs/kcl/angleToMatchLengthX.md b/docs/kcl/angleToMatchLengthX.md
@@ -17,11 +17,8 @@ angleToMatchLengthX(segment_name: TagIdentifier, to: number, sketch_group: Sketc
 ```js
 const sketch001 = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
-  |> line([2, 5], %, 'seg01')
-  |> angledLineToX([
-       -angleToMatchLengthX('seg01', 7, %),
-       10
-     ], %)
+  |> line([2, 5], %, $seg01)
+  |> angledLineToX([-angleToMatchLengthX(seg01, 7, %), 10], %)
   |> close(%)
 
 const extrusion = extrude(5, sketch001)

diff --git a/docs/kcl/angleToMatchLengthY.md b/docs/kcl/angleToMatchLengthY.md
@@ -17,9 +17,9 @@ angleToMatchLengthY(segment_name: TagIdentifier, to: number, sketch_group: Sketc
 ```js
 const sketch001 = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
-  |> line([1, 2], %, 'seg01')
+  |> line([1, 2], %, $seg01)
   |> angledLine({
-       angle: angleToMatchLengthY('seg01', 15, %),
+       angle: angleToMatchLengthY(seg01, 15, %),
        length: 5
      }, %)
   |> yLineTo(0, %)

diff --git a/docs/kcl/angledLineOfXLength.md b/docs/kcl/angledLineOfXLength.md
@@ -17,10 +17,10 @@ angledLineOfXLength(data: AngledLineData, sketch_group: SketchGroup, tag?: TagDe
 ```js
 const sketch001 = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
-  |> angledLineOfXLength({ angle: 45, length: 10 }, %, "edge1")
-  |> angledLineOfXLength({ angle: -15, length: 20 }, %, "edge2")
+  |> angledLineOfXLength({ angle: 45, length: 10 }, %, $edge1)
+  |> angledLineOfXLength({ angle: -15, length: 20 }, %, $edge2)
   |> line([0, -5], %)
-  |> close(%, "edge3")
+  |> close(%, $edge3)
 
 const extrusion = extrude(10, sketch001)
 ```

diff --git a/docs/kcl/angledLineThatIntersects.md b/docs/kcl/angledLineThatIntersects.md
@@ -18,7 +18,7 @@ angledLineThatIntersects(data: AngledLineThatIntersectsData, sketch_group: Sketc
 const exampleSketch = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
   |> lineTo([5, 10], %)
-  |> lineTo([-10, 10], %, "lineToIntersect")
+  |> lineTo([-10, 10], %, $lineToIntersect)
   |> lineTo([0, 20], %)
   |> angledLineThatIntersects({
        angle: 80,

diff --git a/docs/kcl/chamfer.md b/docs/kcl/chamfer.md
@@ -22,19 +22,19 @@ const chamferLength = 2
 
 const mountingPlateSketch = startSketchOn("XY")
   |> startProfileAt([-width / 2, -length / 2], %)
-  |> lineTo([width / 2, -length / 2], %, 'edge1')
-  |> lineTo([width / 2, length / 2], %, 'edge2')
-  |> lineTo([-width / 2, length / 2], %, 'edge3')
-  |> close(%, 'edge4')
+  |> lineTo([width / 2, -length / 2], %, $edge1)
+  |> lineTo([width / 2, length / 2], %, $edge2)
+  |> lineTo([-width / 2, length / 2], %, $edge3)
+  |> close(%, $edge4)
 
 const mountingPlate = extrude(thickness, mountingPlateSketch)
   |> chamfer({
        length: chamferLength,
        tags: [
-         getNextAdjacentEdge('edge1', %),
-         getNextAdjacentEdge('edge2', %),
-         getNextAdjacentEdge('edge3', %),
-         getNextAdjacentEdge('edge4', %)
+         getNextAdjacentEdge(edge1, %),
+         getNextAdjacentEdge(edge2, %),
+         getNextAdjacentEdge(edge3, %),
+         getNextAdjacentEdge(edge4, %)
        ]
      }, %)
 ```

diff --git a/docs/kcl/circle.md b/docs/kcl/circle.md
@@ -9,7 +9,7 @@ Sketch a circle.
 
 
 ```js
-circle(center: [number], radius: number, tag?: TagDeclarator, sketch_surface_or_group: SketchSurfaceOrGroup) -> SketchGroup
+circle(center: [number], radius: number, sketch_surface_or_group: SketchSurfaceOrGroup, tag?: TagDeclarator) -> SketchGroup
 ```
 
 ### Examples
@@ -41,14 +41,6 @@ const example = extrude(5, exampleSketch)
 
 * `center`: `[number]` (REQUIRED)
 * `radius`: `number` (REQUIRED)
-* `tag`: `TagDeclarator` (OPTIONAL)
-```js
-{
-	end: number,
-	start: number,
-	value: string,
-}
-```
 * `sketch_surface_or_group`: `SketchSurfaceOrGroup` - A sketch surface or a sketch group. (REQUIRED)
 ```js
 {
@@ -510,6 +502,14 @@ const example = extrude(5, exampleSketch)
 }],
 }
 ```
+* `tag`: `TagDeclarator` (OPTIONAL)
+```js
+{
+	end: number,
+	start: number,
+	value: string,
+}
+```
 
 ### Returns
 

diff --git a/docs/kcl/fillet.md b/docs/kcl/fillet.md
@@ -22,19 +22,19 @@ const filletRadius = 2
 
 const mountingPlateSketch = startSketchOn("XY")
   |> startProfileAt([-width / 2, -length / 2], %)
-  |> lineTo([width / 2, -length / 2], %, 'edge1')
-  |> lineTo([width / 2, length / 2], %, 'edge2')
-  |> lineTo([-width / 2, length / 2], %, 'edge3')
-  |> close(%, 'edge4')
+  |> lineTo([width / 2, -length / 2], %, $edge1)
+  |> lineTo([width / 2, length / 2], %, $edge2)
+  |> lineTo([-width / 2, length / 2], %, $edge3)
+  |> close(%, $edge4)
 
 const mountingPlate = extrude(thickness, mountingPlateSketch)
   |> fillet({
        radius: filletRadius,
        tags: [
-         getNextAdjacentEdge('edge1', %),
-         getNextAdjacentEdge('edge2', %),
-         getNextAdjacentEdge('edge3', %),
-         getNextAdjacentEdge('edge4', %)
+         getNextAdjacentEdge(edge1, %),
+         getNextAdjacentEdge(edge2, %),
+         getNextAdjacentEdge(edge3, %),
+         getNextAdjacentEdge(edge4, %)
        ]
      }, %)
 ```

diff --git a/docs/kcl/getEdge.md b/docs/kcl/getEdge.md
@@ -17,7 +17,7 @@ getEdge(tag: TagIdentifier, extrude_group: ExtrudeGroup) -> Uuid
 ```js
 const box = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
-  |> line([0, 10], %, 'revolveAxis')
+  |> line([0, 10], %, $revolveAxis)
   |> line([10, 0], %)
   |> line([0, -10], %)
   |> close(%)
@@ -30,7 +30,7 @@ const revolution = startSketchOn(box, "revolveAxis")
   |> line([0, -10], %)
   |> close(%)
   |> revolve({
-       axis: getEdge('revolveAxis', box),
+       axis: getEdge(revolveAxis, box),
        angle: 90
      }, %)
 ```

diff --git a/docs/kcl/getNextAdjacentEdge.md b/docs/kcl/getNextAdjacentEdge.md
@@ -21,15 +21,13 @@ const exampleSketch = startSketchOn('XZ')
   |> angledLine({ angle: 60, length: 10 }, %)
   |> angledLine({ angle: 120, length: 10 }, %)
   |> line([-10, 0], %)
-  |> angledLine({ angle: 240, length: 10 }, %, 'referenceEdge')
+  |> angledLine({ angle: 240, length: 10 }, %, $referenceEdge)
   |> close(%)
 
 const example = extrude(5, exampleSketch)
   |> fillet({
        radius: 3,
-       tags: [
-         getNextAdjacentEdge("referenceEdge", %)
-       ]
+       tags: [getNextAdjacentEdge(referenceEdge, %)]
      }, %)
 ```
 

diff --git a/docs/kcl/getOppositeEdge.md b/docs/kcl/getOppositeEdge.md
@@ -21,13 +21,13 @@ const exampleSketch = startSketchOn('XZ')
   |> angledLine({ angle: 60, length: 10 }, %)
   |> angledLine({ angle: 120, length: 10 }, %)
   |> line([-10, 0], %)
-  |> angledLine({ angle: 240, length: 10 }, %, 'referenceEdge')
+  |> angledLine({ angle: 240, length: 10 }, %, $referenceEdge)
   |> close(%)
 
 const example = extrude(5, exampleSketch)
   |> fillet({
        radius: 3,
-       tags: [getOppositeEdge("referenceEdge", %)]
+       tags: [getOppositeEdge(referenceEdge, %)]
      }, %)
 ```
 

diff --git a/docs/kcl/getPreviousAdjacentEdge.md b/docs/kcl/getPreviousAdjacentEdge.md
@@ -21,14 +21,14 @@ const exampleSketch = startSketchOn('XZ')
   |> angledLine({ angle: 60, length: 10 }, %)
   |> angledLine({ angle: 120, length: 10 }, %)
   |> line([-10, 0], %)
-  |> angledLine({ angle: 240, length: 10 }, %, 'referenceEdge')
+  |> angledLine({ angle: 240, length: 10 }, %, $referenceEdge)
   |> close(%)
 
 const example = extrude(5, exampleSketch)
   |> fillet({
        radius: 3,
        tags: [
-         getPreviousAdjacentEdge("referenceEdge", %)
+         getPreviousAdjacentEdge(referenceEdge, %)
        ]
      }, %)
 ```

diff --git a/docs/kcl/profileStart.md b/docs/kcl/profileStart.md
@@ -17,9 +17,9 @@ profileStart(sketch_group: SketchGroup) -> [number]
 ```js
 const sketch001 = startSketchOn('XY')
   |> startProfileAt([5, 2], %)
-  |> angledLine({ angle: 120, length: 50 }, %, 'seg01')
+  |> angledLine({ angle: 120, length: 50 }, %, $seg01)
   |> angledLine({
-       angle: segAng('seg01', %) + 120,
+       angle: segAng(seg01, %) + 120,
        length: 50
      }, %)
   |> lineTo(profileStart(%), %)

diff --git a/docs/kcl/revolve.md b/docs/kcl/revolve.md
@@ -99,15 +99,15 @@ const box = startSketchOn('XY')
   |> startProfileAt([0, 0], %)
   |> line([0, 20], %)
   |> line([20, 0], %)
-  |> line([0, -20], %, 'revolveAxis')
+  |> line([0, -20], %, $revolveAxis)
   |> close(%)
   |> extrude(20, %)
 
 const sketch001 = startSketchOn(box, "END")
   |> circle([10, 10], 4, %)
   |> revolve({
        angle: 90,
-       axis: getOppositeEdge('revolveAxis', box)
+       axis: getOppositeEdge(revolveAxis, box)
      }, %)
 ```
 

diff --git a/docs/kcl/segAng.md b/docs/kcl/segAng.md
@@ -18,11 +18,11 @@ segAng(segment_name: TagIdentifier, sketch_group: SketchGroup) -> number
 const exampleSketch = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
   |> line([10, 0], %)
-  |> line([5, 10], %, 'seg01')
+  |> line([5, 10], %, $seg01)
   |> line([-10, 0], %)
-  |> angledLine([segAng('seg01', %), 10], %)
+  |> angledLine([segAng(seg01, %), 10], %)
   |> line([-10, 0], %)
-  |> angledLine([segAng('seg01', %), -15], %)
+  |> angledLine([segAng(seg01, %), -15], %)
   |> close(%)
 
 const example = extrude(4, exampleSketch)

diff --git a/docs/kcl/segEndX.md b/docs/kcl/segEndX.md
@@ -17,9 +17,9 @@ segEndX(segment_name: TagIdentifier, sketch_group: SketchGroup) -> number
 ```js
 const exampleSketch = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
-  |> line([20, 0], %, "thing")
+  |> line([20, 0], %, $thing)
   |> line([0, 5], %)
-  |> line([segEndX("thing", %), 0], %)
+  |> line([segEndX(thing, %), 0], %)
   |> line([-20, 10], %)
   |> close(%)
 

diff --git a/docs/kcl/segEndY.md b/docs/kcl/segEndY.md
@@ -18,9 +18,9 @@ segEndY(segment_name: TagIdentifier, sketch_group: SketchGroup) -> number
 const exampleSketch = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
   |> line([20, 0], %)
-  |> line([0, 3], %, "thing")
+  |> line([0, 3], %, $thing)
   |> line([-10, 0], %)
-  |> line([0, segEndY("thing", %)], %)
+  |> line([0, segEndY(thing, %)], %)
   |> line([-10, 0], %)
   |> close(%)
 

diff --git a/docs/kcl/segLen.md b/docs/kcl/segLen.md
@@ -17,12 +17,9 @@ segLen(segment_name: TagIdentifier, sketch_group: SketchGroup) -> number
 ```js
 const exampleSketch = startSketchOn("XZ")
   |> startProfileAt([0, 0], %)
-  |> angledLine({ angle: 60, length: 10 }, %, "thing")
+  |> angledLine({ angle: 60, length: 10 }, %, $thing)
   |> tangentialArc({ offset: -120, radius: 5 }, %)
-  |> angledLine({
-       angle: -60,
-       length: segLen("thing", %)
-     }, %)
+  |> angledLine({ angle: -60, length: segLen(thing, %) }, %)
   |> close(%)
 
 const example = extrude(5, exampleSketch)

diff --git a/docs/kcl/startSketchOn.md b/docs/kcl/startSketchOn.md
@@ -49,7 +49,7 @@ const example003 = extrude(5, exampleSketch003)
 const exampleSketch = startSketchOn("XY")
   |> startProfileAt([0, 0], %)
   |> line([10, 0], %)
-  |> line([0, 10], %, 'sketchingFace')
+  |> line([0, 10], %, $sketchingFace)
   |> line([-10, 0], %)
   |> close(%)
 
@@ -60,7 +60,7 @@ const exampleSketch002 = startSketchOn(example, 'sketchingFace')
   |> line([8, 0], %)
   |> line([0, 8], %)
   |> line([-8, 0], %)
-  |> close(%, 'sketchingFace002')
+  |> close(%, $sketchingFace002)
 
 const example002 = extrude(10, exampleSketch002)