ByoungSooPark/modeling-app
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

internal linter for making sure everything is camel case (#3172)

Browse Source 
* updates

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

* add lint rule for object property key

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

* add linter to example shit

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

* fix samples

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

* fix lints

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

* updates

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

* generate docs

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

---------

Signed-off-by: Jess Frazelle <github@jessfraz.com>
This commit is contained in:
Jess Frazelle
2024-07-29 13:18:55 -07:00
committed by GitHub
parent 6ed4e72e1d
commit a1c2e817a4
69 changed files with 845 additions and 689 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/kcl/angleToMatchLengthX.md
View File

@ -166,7 +166,7 @@ const extrusion = extrude(5, sketch001)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -180,7 +180,7 @@ const extrusion = extrude(5, sketch001)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

4
docs/kcl/angleToMatchLengthY.md
View File

@ -170,7 +170,7 @@ const extrusion = extrude(5, sketch001)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -184,7 +184,7 @@ const extrusion = extrude(5, sketch001)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/angledLine.md
View File

@ -85,7 +85,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -99,7 +99,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -497,7 +497,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -511,7 +511,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/angledLineOfXLength.md
View File

@ -84,7 +84,7 @@ const extrusion = extrude(10, sketch001)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -98,7 +98,7 @@ const extrusion = extrude(10, sketch001)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -496,7 +496,7 @@ const extrusion = extrude(10, sketch001)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -510,7 +510,7 @@ const extrusion = extrude(10, sketch001)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/angledLineOfYLength.md
View File

@ -86,7 +86,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -100,7 +100,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -498,7 +498,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -512,7 +512,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/angledLineThatIntersects.md
View File

@ -178,7 +178,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -192,7 +192,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -590,7 +590,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -604,7 +604,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/angledLineToX.md
View File

@ -83,7 +83,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -97,7 +97,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -495,7 +495,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -509,7 +509,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/angledLineToY.md
View File

@ -83,7 +83,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -97,7 +97,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -495,7 +495,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -509,7 +509,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

16
docs/kcl/arc.md
View File

@ -19,8 +19,8 @@ const exampleSketch = startSketchOn('XZ')
|> startProfileAt([0, 0], %)
|> line([10, 0], %)
|> arc({
angle_start: 0,
angle_end: 280,
angleStart: 0,
angleEnd: 280,
radius: 16
}, %)
|> close(%)
@ -34,9 +34,9 @@ const exampleSketch = startSketchOn('XZ')
```js
{
// The end angle.
angle_end: number,
angleEnd: number,
// The start angle.
angle_start: number,
angleStart: number,
// The radius.
radius: number,
} |
@ -94,7 +94,7 @@ const exampleSketch = startSketchOn('XZ')
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -108,7 +108,7 @@ const exampleSketch = startSketchOn('XZ')
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -506,7 +506,7 @@ const exampleSketch = startSketchOn('XZ')
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -520,7 +520,7 @@ const exampleSketch = startSketchOn('XZ')
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/bezierCurve.md
View File

@ -89,7 +89,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -103,7 +103,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -501,7 +501,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -515,7 +515,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

16
docs/kcl/chamfer.md
View File

@ -149,7 +149,7 @@ const mountingPlate = extrude(thickness, mountingPlateSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -163,7 +163,7 @@ const mountingPlate = extrude(thickness, mountingPlateSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -223,7 +223,7 @@ const mountingPlate = extrude(thickness, mountingPlateSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -237,7 +237,7 @@ const mountingPlate = extrude(thickness, mountingPlateSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -549,7 +549,7 @@ const mountingPlate = extrude(thickness, mountingPlateSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -563,7 +563,7 @@ const mountingPlate = extrude(thickness, mountingPlateSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -623,7 +623,7 @@ const mountingPlate = extrude(thickness, mountingPlateSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -637,7 +637,7 @@ const mountingPlate = extrude(thickness, mountingPlateSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

12
docs/kcl/circle.md
View File

@ -82,7 +82,7 @@ const example = extrude(5, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -96,7 +96,7 @@ const example = extrude(5, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -366,7 +366,7 @@ const example = extrude(5, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -380,7 +380,7 @@ const example = extrude(5, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -661,7 +661,7 @@ const example = extrude(5, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -675,7 +675,7 @@ const example = extrude(5, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/close.md
View File

@ -84,7 +84,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -98,7 +98,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -496,7 +496,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -510,7 +510,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

20
docs/kcl/extrude.md
View File

@ -19,8 +19,8 @@ const example = startSketchOn('XZ')
|> startProfileAt([0, 0], %)
|> line([10, 0], %)
|> arc({
angle_end: 0,
angle_start: 120,
angleStart: 120,
angleEnd: 0,
radius: 5
}, %)
|> line([5, 0], %)
@ -41,8 +41,8 @@ const example = startSketchOn('XZ')
const exampleSketch = startSketchOn('XZ')
|> startProfileAt([-10, 0], %)
|> arc({
angle_end: -60,
angle_start: 120,
angleStart: 120,
angleEnd: -60,
radius: 5
}, %)
|> line([10, 0], %)
@ -109,7 +109,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -123,7 +123,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -479,7 +479,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -493,7 +493,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -553,7 +553,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -567,7 +567,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

16
docs/kcl/fillet.md
View File

@ -149,7 +149,7 @@ const mountingPlate = extrude(thickness, mountingPlateSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -163,7 +163,7 @@ const mountingPlate = extrude(thickness, mountingPlateSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -223,7 +223,7 @@ const mountingPlate = extrude(thickness, mountingPlateSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -237,7 +237,7 @@ const mountingPlate = extrude(thickness, mountingPlateSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -549,7 +549,7 @@ const mountingPlate = extrude(thickness, mountingPlateSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -563,7 +563,7 @@ const mountingPlate = extrude(thickness, mountingPlateSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -623,7 +623,7 @@ const mountingPlate = extrude(thickness, mountingPlateSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -637,7 +637,7 @@ const mountingPlate = extrude(thickness, mountingPlateSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

23
docs/kcl/helix.md
View File

@ -19,10 +19,9 @@ const part001 = startSketchOn('XY')
|> circle([5, 5], 10, %)
|> extrude(10, %)
|> helix({
angle_start: 0,
angleStart: 0,
ccw: true,
revolutions: 16,
angle_start: 0
revolutions: 16
}, %)
```
@ -34,7 +33,7 @@ const part001 = startSketchOn('XY')
```js
{
// Start angle (in degrees).
angle_start: number,
angleStart: number,
// Is the helix rotation counter clockwise? The default is `false`.
ccw: string,
// Length of the helix. If this argument is not provided, the height of the extrude group is used.
@ -51,7 +50,7 @@ const part001 = startSketchOn('XY')
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -65,7 +64,7 @@ const part001 = startSketchOn('XY')
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -125,7 +124,7 @@ const part001 = startSketchOn('XY')
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -139,7 +138,7 @@ const part001 = startSketchOn('XY')
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -442,7 +441,7 @@ const part001 = startSketchOn('XY')
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -456,7 +455,7 @@ const part001 = startSketchOn('XY')
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -516,7 +515,7 @@ const part001 = startSketchOn('XY')
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -530,7 +529,7 @@ const part001 = startSketchOn('XY')
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

12
docs/kcl/hole.md
View File

@ -95,7 +95,7 @@ const example = extrude(1, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -109,7 +109,7 @@ const example = extrude(1, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -499,7 +499,7 @@ const example = extrude(1, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -513,7 +513,7 @@ const example = extrude(1, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -902,7 +902,7 @@ const example = extrude(1, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -916,7 +916,7 @@ const example = extrude(1, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

4
docs/kcl/lastSegX.md
View File

@ -75,7 +75,7 @@ const example = extrude(5, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -89,7 +89,7 @@ const example = extrude(5, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

4
docs/kcl/lastSegY.md
View File

@ -75,7 +75,7 @@ const example = extrude(5, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -89,7 +89,7 @@ const example = extrude(5, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/line.md
View File

@ -88,7 +88,7 @@ const example = extrude(5, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -102,7 +102,7 @@ const example = extrude(5, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -500,7 +500,7 @@ const example = extrude(5, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -514,7 +514,7 @@ const example = extrude(5, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/lineTo.md
View File

@ -75,7 +75,7 @@ const example = extrude(5, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -89,7 +89,7 @@ const example = extrude(5, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -487,7 +487,7 @@ const example = extrude(5, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -501,7 +501,7 @@ const example = extrude(5, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

4
docs/kcl/patternCircular2d.md
View File

@ -93,7 +93,7 @@ const example = extrude(1, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -107,7 +107,7 @@ const example = extrude(1, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/patternCircular3d.md
View File

@ -55,7 +55,7 @@ const example = extrude(-5, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -69,7 +69,7 @@ const example = extrude(-5, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -129,7 +129,7 @@ const example = extrude(-5, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -143,7 +143,7 @@ const example = extrude(-5, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

4
docs/kcl/patternLinear2d.md
View File

@ -86,7 +86,7 @@ const example = extrude(1, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -100,7 +100,7 @@ const example = extrude(1, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/patternLinear3d.md
View File

@ -53,7 +53,7 @@ const example = extrude(1, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -67,7 +67,7 @@ const example = extrude(1, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -127,7 +127,7 @@ const example = extrude(1, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -141,7 +141,7 @@ const example = extrude(1, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/patternTransform.md
View File

@ -55,7 +55,7 @@ let vase = layer()
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -69,7 +69,7 @@ let vase = layer()
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -129,7 +129,7 @@ let vase = layer()
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -143,7 +143,7 @@ let vase = layer()
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

4
docs/kcl/profileStart.md
View File

@ -76,7 +76,7 @@ const sketch001 = startSketchOn('XY')
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -90,7 +90,7 @@ const sketch001 = startSketchOn('XY')
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

4
docs/kcl/profileStartX.md
View File

@ -71,7 +71,7 @@ const sketch001 = startSketchOn('XY')
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -85,7 +85,7 @@ const sketch001 = startSketchOn('XY')
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

4
docs/kcl/profileStartY.md
View File

@ -70,7 +70,7 @@ const sketch001 = startSketchOn('XY')
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -84,7 +84,7 @@ const sketch001 = startSketchOn('XY')
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

12
docs/kcl/revolve.md
View File

@ -292,7 +292,7 @@ uuid |
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -306,7 +306,7 @@ uuid |
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -658,7 +658,7 @@ uuid |
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -672,7 +672,7 @@ uuid |
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -732,7 +732,7 @@ uuid |
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -746,7 +746,7 @@ uuid |
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

16
docs/kcl/shell.md
View File

@ -137,7 +137,7 @@ shell({ faces: ['end'], thickness: 0.25 }, firstSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -151,7 +151,7 @@ shell({ faces: ['end'], thickness: 0.25 }, firstSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -211,7 +211,7 @@ shell({ faces: ['end'], thickness: 0.25 }, firstSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -225,7 +225,7 @@ shell({ faces: ['end'], thickness: 0.25 }, firstSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -528,7 +528,7 @@ shell({ faces: ['end'], thickness: 0.25 }, firstSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -542,7 +542,7 @@ shell({ faces: ['end'], thickness: 0.25 }, firstSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -602,7 +602,7 @@ shell({ faces: ['end'], thickness: 0.25 }, firstSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -616,7 +616,7 @@ shell({ faces: ['end'], thickness: 0.25 }, firstSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/startProfileAt.md
View File

@ -97,7 +97,7 @@ const example = extrude(5, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -111,7 +111,7 @@ const example = extrude(5, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -453,7 +453,7 @@ const example = extrude(5, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -467,7 +467,7 @@ const example = extrude(5, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

4
docs/kcl/startSketchAt.md
View File

@ -101,7 +101,7 @@ const example = extrude(5, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -115,7 +115,7 @@ const example = extrude(5, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

20
docs/kcl/startSketchOn.md
View File

@ -106,9 +106,9 @@ const example002 = extrude(5, exampleSketch002)
const a1 = startSketchOn({
plane: {
origin: { x: 0, y: 0, z: 0 },
x_axis: { x: 1, y: 0, z: 0 },
y_axis: { x: 0, y: 1, z: 0 },
z_axis: { x: 0, y: 0, z: 1 }
xAxis: { x: 1, y: 0, z: 0 },
yAxis: { x: 0, y: 1, z: 0 },
zAxis: { x: 0, y: 0, z: 1 }
}
})
|> startProfileAt([0, 0], %)
@ -141,19 +141,19 @@ const a1 = startSketchOn({
z: number,
},
// What should the plane’s X axis be?
x_axis: {
xAxis: {
x: number,
y: number,
z: number,
},
// What should the plane’s Y axis be?
y_axis: {
yAxis: {
x: number,
y: number,
z: number,
},
// The z-axis (normal).
z_axis: {
zAxis: {
x: number,
y: number,
z: number,
@ -166,7 +166,7 @@ const a1 = startSketchOn({
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -180,7 +180,7 @@ const a1 = startSketchOn({
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -578,7 +578,7 @@ const a1 = startSketchOn({
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -592,7 +592,7 @@ const a1 = startSketchOn({
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

794
docs/kcl/std.json
View File

File diff suppressed because it is too large Load Diff

8
docs/kcl/tangentialArc.md
View File

@ -84,7 +84,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -98,7 +98,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -496,7 +496,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -510,7 +510,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/tangentialArcTo.md
View File

@ -75,7 +75,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -89,7 +89,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -487,7 +487,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -501,7 +501,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/xLine.md
View File

@ -78,7 +78,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -92,7 +92,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -490,7 +490,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -504,7 +504,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/xLineTo.md
View File

@ -78,7 +78,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -92,7 +92,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -490,7 +490,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -504,7 +504,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/yLine.md
View File

@ -76,7 +76,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -90,7 +90,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -488,7 +488,7 @@ const example = extrude(10, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -502,7 +502,7 @@ const example = extrude(10, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

8
docs/kcl/yLineTo.md
View File

@ -74,7 +74,7 @@ const example = extrude(5, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -88,7 +88,7 @@ const example = extrude(5, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
@ -486,7 +486,7 @@ const example = extrude(5, exampleSketch)
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
@ -500,7 +500,7 @@ const example = extrude(5, exampleSketch)
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
edgeId: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,

166
src-tauri/Cargo.lock generated
View File

@ -188,7 +188,7 @@ dependencies = [
"tauri-plugin-shell",
"tauri-plugin-updater",
"tokio",
"toml 0.8.14",
"toml 0.8.16",
"url",
]
@ -332,7 +332,7 @@ checksum = "3b43422f69d8ff38f95f1b2bb76517c91589a924d1559a0e935d7c8ce0274c11"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -367,7 +367,7 @@ checksum = "6e0c28dcc82d7c8ead5cb13beb15405b57b8546e93215673ff8ca0349a028107"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -407,7 +407,7 @@ checksum = "3c87f3f15e7794432337fc718554eaa4dc8f04c9677a950ffe366f20a162ae42"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -550,7 +550,7 @@ dependencies = [
"proc-macro-crate 3.1.0",
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
"syn_derive",
]
@ -721,7 +721,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8a969e13a7589e9e3e4207e153bae624ade2b5622fb4684a4923b23ec3d57719"
dependencies = [
"serde",
"toml 0.8.14",
"toml 0.8.16",
]
[[package]]
@ -792,9 +792,9 @@ dependencies = [
[[package]]
name = "clap"
version = "4.5.9"
version = "4.5.11"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "64acc1846d54c1fe936a78dc189c34e28d3f5afc348403f28ecf53660b9b8462"
checksum = "35723e6a11662c2afb578bcf0b88bf6ea8e21282a953428f240574fcc3a2b5b3"
dependencies = [
"clap_builder",
"clap_derive",
@ -802,9 +802,9 @@ dependencies = [
[[package]]
name = "clap_builder"
version = "4.5.9"
version = "4.5.11"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6fb8393d67ba2e7bfaf28a23458e4e2b543cc73a99595511eb207fdb8aede942"
checksum = "49eb96cbfa7cfa35017b7cd548c75b14c3118c98b423041d70562665e07fb0fa"
dependencies = [
"anstream",
"anstyle",
@ -816,14 +816,14 @@ dependencies = [
[[package]]
name = "clap_derive"
version = "4.5.8"
version = "4.5.11"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2bac35c6dafb060fd4d275d9a4ffae97917c13a6327903a8be2153cd964f7085"
checksum = "5d029b67f89d30bbb547c89fd5161293c0aec155fc691d7924b64550662db93e"
dependencies = [
"heck 0.5.0",
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -1073,7 +1073,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "13b588ba4ac1a99f7f2964d24b3d896ddc6bf847ee3855dbd4366f058cfcd331"
dependencies = [
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -1083,7 +1083,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "edb49164822f3ee45b17acd4a208cfc1251410cf0cad9a833234c9890774dd9f"
dependencies = [
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -1107,7 +1107,7 @@ dependencies = [
"proc-macro2",
"quote",
"strsim 0.10.0",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -1118,7 +1118,7 @@ checksum = "a668eda54683121533a393014d8692171709ff57a7d61f187b6e782719f8933f"
dependencies = [
"darling_core",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -1179,7 +1179,7 @@ checksum = "4078275de501a61ceb9e759d37bdd3d7210e654dbc167ac1a3678ef4435ed57b"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
"synstructure",
]
@ -1216,7 +1216,7 @@ dependencies = [
"regex",
"serde",
"serde_tokenstream",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -1227,7 +1227,7 @@ checksum = "67e77553c4162a157adbf834ebae5b415acbecbeafc7a74b0e886657506a7611"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -1288,7 +1288,7 @@ checksum = "487585f4d0c6655fe74905e2504d8ad6908e4db67f744eb140876906c2f3175d"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -1320,7 +1320,7 @@ checksum = "f2b99bf03862d7f545ebc28ddd33a665b50865f4dfd84031a393823879bd4c54"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -1383,7 +1383,7 @@ dependencies = [
"cc",
"memchr",
"rustc_version",
"toml 0.8.14",
"toml 0.8.16",
"vswhom",
"winreg 0.52.0",
]
@ -1427,7 +1427,7 @@ checksum = "5c785274071b1b420972453b306eeca06acf4633829db4223b58a2a8c5953bc4"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -1588,7 +1588,7 @@ checksum = "1a5c6c585bc94aaf2c7b51dd4c2ba22680844aba4c687be581871a6f518c5742"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -1704,7 +1704,7 @@ checksum = "87750cf4b7a4c0625b1529e4c543c2182106e4dedc60a2a6455e00d212c489ac"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -1980,7 +1980,7 @@ dependencies = [
"proc-macro-error",
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -2008,7 +2008,7 @@ dependencies = [
"inflections",
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -2083,7 +2083,7 @@ dependencies = [
"proc-macro-error",
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -2571,7 +2571,7 @@ dependencies = [
[[package]]
name = "kcl-lib"
version = "0.2.0"
version = "0.2.2"
dependencies = [
"anyhow",
"approx",
@ -2581,6 +2581,7 @@ dependencies = [
"bson",
"chrono",
"clap",
"convert_case 0.6.0",
"dashmap 6.0.1",
"databake",
"derive-docs",
@ -2602,7 +2603,7 @@ dependencies = [
"thiserror",
"tokio",
"tokio-tungstenite",
"toml 0.8.14",
"toml 0.8.16",
"tower-lsp",
"ts-rs",
"url",
@ -2628,9 +2629,9 @@ dependencies = [
[[package]]
name = "kittycad"
version = "0.3.7"
version = "0.3.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e1777b503442fa4666564cc3ab237d456df853a09648a4b2bb09622d25d021a5"
checksum = "36b87a9cca545825ba18005c1944b8525fac28867d99984178bf22c79fb5ec25"
dependencies = [
"anyhow",
"async-trait",
@ -3368,7 +3369,7 @@ dependencies = [
"regex",
"regex-syntax 0.8.3",
"structmeta",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -3487,7 +3488,7 @@ dependencies = [
"phf_shared 0.11.2",
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -3555,7 +3556,7 @@ checksum = "2f38a4412a78282e09a2cf38d195ea5420d15ba0602cb375210efbc877243965"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -4429,7 +4430,7 @@ dependencies = [
"proc-macro2",
"quote",
"serde_derive_internals",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -4549,7 +4550,7 @@ checksum = "e0cd7e117be63d3c3678776753929474f3b04a43a080c744d6b0ae2a8c28e222"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -4560,17 +4561,18 @@ checksum = "330f01ce65a3a5fe59a60c82f3c9a024b573b8a6e875bd233fe5f934e71d54e3"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
name = "serde_json"
version = "1.0.120"
version = "1.0.121"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "4e0d21c9a8cae1235ad58a00c11cb40d4b1e5c784f1ef2c537876ed6ffd8b7c5"
checksum = "4ab380d7d9f22ef3f21ad3e6c1ebe8e4fc7a2000ccba2e4d71fc96f15b2cb609"
dependencies = [
"indexmap 2.2.6",
"itoa 1.0.11",
"memchr",
"ryu",
"serde",
]
@ -4593,14 +4595,14 @@ checksum = "6c64451ba24fc7a6a2d60fc75dd9c83c90903b19028d4eff35e88fc1e86564e9"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
name = "serde_spanned"
version = "0.6.6"
version = "0.6.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "79e674e01f999af37c49f70a6ede167a8a60b2503e56c5599532a65baa5969a0"
checksum = "eb5b1b31579f3811bf615c144393417496f152e12ac8b7663bf664f4a815306d"
dependencies = [
"serde",
]
@ -4614,7 +4616,7 @@ dependencies = [
"proc-macro2",
"quote",
"serde",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -4656,7 +4658,7 @@ dependencies = [
"darling",
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -4924,7 +4926,7 @@ dependencies = [
"proc-macro2",
"quote",
"structmeta-derive",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -4935,7 +4937,7 @@ checksum = "152a0b65a590ff6c3da95cabe2353ee04e6167c896b28e3b14478c2636c922fc"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -4957,7 +4959,7 @@ dependencies = [
"proc-macro2",
"quote",
"rustversion",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -4990,9 +4992,9 @@ dependencies = [
[[package]]
name = "syn"
version = "2.0.71"
version = "2.0.72"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b146dcf730474b4bcd16c311627b31ede9ab149045db4d6088b3becaea046462"
checksum = "dc4b9b9bf2add8093d3f2c0204471e951b2285580335de42f9d2534f3ae7a8af"
dependencies = [
"proc-macro2",
"quote",
@ -5008,7 +5010,7 @@ dependencies = [
"proc-macro-error",
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -5025,7 +5027,7 @@ checksum = "c8af7666ab7b6390ab78131fb5b0fce11d6b7a6951602017c35fa82800708971"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -5067,7 +5069,7 @@ dependencies = [
"cfg-expr",
"heck 0.5.0",
"pkg-config",
"toml 0.8.14",
"toml 0.8.16",
"version-compare",
]
@ -5220,7 +5222,7 @@ dependencies = [
"serde_json",
"tauri-utils",
"tauri-winres",
"toml 0.8.14",
"toml 0.8.16",
"walkdir",
]
@ -5242,7 +5244,7 @@ dependencies = [
"serde",
"serde_json",
"sha2",
"syn 2.0.71",
"syn 2.0.72",
"tauri-utils",
"thiserror",
"time",
@ -5260,7 +5262,7 @@ dependencies = [
"heck 0.5.0",
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
"tauri-codegen",
"tauri-utils",
]
@ -5278,7 +5280,7 @@ dependencies = [
"serde",
"serde_json",
"tauri-utils",
"toml 0.8.14",
"toml 0.8.16",
"walkdir",
]
@ -5562,7 +5564,7 @@ dependencies = [
"serde_with",
"swift-rs",
"thiserror",
"toml 0.8.14",
"toml 0.8.16",
"url",
"urlpattern",
"walkdir",
@ -5618,22 +5620,22 @@ checksum = "8eaa81235c7058867fa8c0e7314f33dcce9c215f535d1913822a2b3f5e289f3c"
[[package]]
name = "thiserror"
version = "1.0.62"
version = "1.0.63"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f2675633b1499176c2dff06b0856a27976a8f9d436737b4cf4f312d4d91d8bbb"
checksum = "c0342370b38b6a11b6cc11d6a805569958d54cfa061a29969c3b5ce2ea405724"
dependencies = [
"thiserror-impl",
]
[[package]]
name = "thiserror-impl"
version = "1.0.62"
version = "1.0.63"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d20468752b09f49e909e55a5d338caa8bedf615594e9d80bc4c565d30faf798c"
checksum = "a4558b58466b9ad7ca0f102865eccc95938dca1a74a856f2b57b6629050da261"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -5730,7 +5732,7 @@ checksum = "693d596312e88961bc67d7f1f97af8a70227d9f90c31bba5806eec004978d752"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -5809,21 +5811,21 @@ dependencies = [
[[package]]
name = "toml"
version = "0.8.14"
version = "0.8.16"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6f49eb2ab21d2f26bd6db7bf383edc527a7ebaee412d17af4d40fdccd442f335"
checksum = "81967dd0dd2c1ab0bc3468bd7caecc32b8a4aa47d0c8c695d8c2b2108168d62c"
dependencies = [
"serde",
"serde_spanned",
"toml_datetime",
"toml_edit 0.22.14",
"toml_edit 0.22.17",
]
[[package]]
name = "toml_datetime"
version = "0.6.6"
version = "0.6.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "4badfd56924ae69bcc9039335b2e017639ce3f9b001c393c1b2d1ef846ce2cbf"
checksum = "f8fb9f64314842840f1d940ac544da178732128f1c78c21772e876579e0da1db"
dependencies = [
"serde",
]
@ -5865,9 +5867,9 @@ dependencies = [
[[package]]
name = "toml_edit"
version = "0.22.14"
version = "0.22.17"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f21c7aaf97f1bd9ca9d4f9e73b0a6c74bd5afef56f2bc931943a6e1c37e04e38"
checksum = "8d9f8729f5aea9562aac1cc0441f5d6de3cff1ee0c5d67293eeca5eb36ee7c16"
dependencies = [
"indexmap 2.2.6",
"serde",
@ -5930,7 +5932,7 @@ checksum = "84fd902d4e0b9a4b27f2f440108dc034e1758628a9b702f8ec61ad66355422fa"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -5959,7 +5961,7 @@ checksum = "34704c8d6ebcbc939824180af020566b01a7c01f80641264eba0999f6c2b6be7"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -6089,7 +6091,7 @@ checksum = "c88cc88fd23b5a04528f3a8436024f20010a16ec18eb23c164b1242f65860130"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
"termcolor",
]
@ -6306,7 +6308,7 @@ dependencies = [
"proc-macro-error",
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -6405,7 +6407,7 @@ dependencies = [
"once_cell",
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
"wasm-bindgen-shared",
]
@ -6439,7 +6441,7 @@ checksum = "e94f17b526d0a461a191c78ea52bbce64071ed5c04c9ffe424dcb38f74171bb7"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
"wasm-bindgen-backend",
"wasm-bindgen-shared",
]
@ -6580,7 +6582,7 @@ checksum = "ac1345798ecd8122468840bcdf1b95e5dc6d2206c5e4b0eafa078d061f59c9bc"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -6686,7 +6688,7 @@ checksum = "9107ddc059d5b6fbfbffdfa7a7fe3e22a226def0b2608f72e9d552763d3e1ad7"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -6697,7 +6699,7 @@ checksum = "29bee4b38ea3cde66011baa44dba677c432a78593e202392d1e9070cf2a7fca7"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]
@ -7149,7 +7151,7 @@ checksum = "9ce1b18ccd8e73a9321186f97e46f9f04b778851177567b1975109d26a08d2a6"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.71",
"syn 2.0.72",
]
[[package]]

2
src/wasm-lib/Cargo.lock generated
View File

@ -718,7 +718,7 @@ dependencies = [
[[package]]
name = "derive-docs"
version = "0.1.20"
version = "0.1.21"
dependencies = [
"Inflector",
"anyhow",

2
src/wasm-lib/derive-docs/Cargo.toml
View File

@ -1,7 +1,7 @@
[package]
name = "derive-docs"
description = "A tool for generating documentation from Rust derive macros"
version = "0.1.20"
version = "0.1.21"
edition = "2021"
license = "MIT"
repository = "https://github.com/KittyCAD/modeling-app"

6
src/wasm-lib/derive-docs/src/lib.rs
View File

@ -797,6 +797,12 @@ fn generate_code_block_test(fn_name: &str, code_block: &str, index: usize) -> pr
ctx.run(&program, None).await.unwrap();
// Ensure it lints.
let results = program.lint_all().unwrap();
if !results.is_empty() {
panic!("Linting failed: {:?}", results);
}
// Zoom to fit.
ctx.engine
.send_modeling_cmd(

5
src/wasm-lib/derive-docs/tests/args_with_lifetime.gen
View File

@ -46,6 +46,11 @@ mod test_examples_someFn {
.await
.unwrap();
ctx.run(&program, None).await.unwrap();
let results = program.lint_all().unwrap();
if !results.is_empty() {
panic!("Linting failed: {:?}", results);
}
ctx.engine
.send_modeling_cmd(
uuid::Uuid::new_v4(),

5
src/wasm-lib/derive-docs/tests/args_with_refs.gen
View File

@ -46,6 +46,11 @@ mod test_examples_someFn {
.await
.unwrap();
ctx.run(&program, None).await.unwrap();
let results = program.lint_all().unwrap();
if !results.is_empty() {
panic!("Linting failed: {:?}", results);
}
ctx.engine
.send_modeling_cmd(
uuid::Uuid::new_v4(),

10
src/wasm-lib/derive-docs/tests/array.gen
View File

@ -46,6 +46,11 @@ mod test_examples_show {
.await
.unwrap();
ctx.run(&program, None).await.unwrap();
let results = program.lint_all().unwrap();
if !results.is_empty() {
panic!("Linting failed: {:?}", results);
}
ctx.engine
.send_modeling_cmd(
uuid::Uuid::new_v4(),
@ -136,6 +141,11 @@ mod test_examples_show {
.await
.unwrap();
ctx.run(&program, None).await.unwrap();
let results = program.lint_all().unwrap();
if !results.is_empty() {
panic!("Linting failed: {:?}", results);
}
ctx.engine
.send_modeling_cmd(
uuid::Uuid::new_v4(),

5
src/wasm-lib/derive-docs/tests/box.gen
View File

@ -46,6 +46,11 @@ mod test_examples_show {
.await
.unwrap();
ctx.run(&program, None).await.unwrap();
let results = program.lint_all().unwrap();
if !results.is_empty() {
panic!("Linting failed: {:?}", results);
}
ctx.engine
.send_modeling_cmd(
uuid::Uuid::new_v4(),

10
src/wasm-lib/derive-docs/tests/doc_comment_with_code.gen
View File

@ -48,6 +48,11 @@ mod test_examples_my_func {
.await
.unwrap();
ctx.run(&program, None).await.unwrap();
let results = program.lint_all().unwrap();
if !results.is_empty() {
panic!("Linting failed: {:?}", results);
}
ctx.engine
.send_modeling_cmd(
uuid::Uuid::new_v4(),
@ -138,6 +143,11 @@ mod test_examples_my_func {
.await
.unwrap();
ctx.run(&program, None).await.unwrap();
let results = program.lint_all().unwrap();
if !results.is_empty() {
panic!("Linting failed: {:?}", results);
}
ctx.engine
.send_modeling_cmd(
uuid::Uuid::new_v4(),

10
src/wasm-lib/derive-docs/tests/lineTo.gen
View File

@ -48,6 +48,11 @@ mod test_examples_line_to {
.await
.unwrap();
ctx.run(&program, None).await.unwrap();
let results = program.lint_all().unwrap();
if !results.is_empty() {
panic!("Linting failed: {:?}", results);
}
ctx.engine
.send_modeling_cmd(
uuid::Uuid::new_v4(),
@ -138,6 +143,11 @@ mod test_examples_line_to {
.await
.unwrap();
ctx.run(&program, None).await.unwrap();
let results = program.lint_all().unwrap();
if !results.is_empty() {
panic!("Linting failed: {:?}", results);
}
ctx.engine
.send_modeling_cmd(
uuid::Uuid::new_v4(),

10
src/wasm-lib/derive-docs/tests/min.gen
View File

@ -46,6 +46,11 @@ mod test_examples_min {
.await
.unwrap();
ctx.run(&program, None).await.unwrap();
let results = program.lint_all().unwrap();
if !results.is_empty() {
panic!("Linting failed: {:?}", results);
}
ctx.engine
.send_modeling_cmd(
uuid::Uuid::new_v4(),
@ -136,6 +141,11 @@ mod test_examples_min {
.await
.unwrap();
ctx.run(&program, None).await.unwrap();
let results = program.lint_all().unwrap();
if !results.is_empty() {
panic!("Linting failed: {:?}", results);
}
ctx.engine
.send_modeling_cmd(
uuid::Uuid::new_v4(),

5
src/wasm-lib/derive-docs/tests/option.gen
View File

@ -46,6 +46,11 @@ mod test_examples_show {
.await
.unwrap();
ctx.run(&program, None).await.unwrap();
let results = program.lint_all().unwrap();
if !results.is_empty() {
panic!("Linting failed: {:?}", results);
}
ctx.engine
.send_modeling_cmd(
uuid::Uuid::new_v4(),

5
src/wasm-lib/derive-docs/tests/option_input_format.gen
View File

@ -46,6 +46,11 @@ mod test_examples_import {
.await
.unwrap();
ctx.run(&program, None).await.unwrap();
let results = program.lint_all().unwrap();
if !results.is_empty() {
panic!("Linting failed: {:?}", results);
}
ctx.engine
.send_modeling_cmd(
uuid::Uuid::new_v4(),

5
src/wasm-lib/derive-docs/tests/return_vec_box_sketch_group.gen
View File

@ -46,6 +46,11 @@ mod test_examples_import {
.await
.unwrap();
ctx.run(&program, None).await.unwrap();
let results = program.lint_all().unwrap();
if !results.is_empty() {
panic!("Linting failed: {:?}", results);
}
ctx.engine
.send_modeling_cmd(
uuid::Uuid::new_v4(),

5
src/wasm-lib/derive-docs/tests/return_vec_sketch_group.gen
View File

@ -46,6 +46,11 @@ mod test_examples_import {
.await
.unwrap();
ctx.run(&program, None).await.unwrap();
let results = program.lint_all().unwrap();
if !results.is_empty() {
panic!("Linting failed: {:?}", results);
}
ctx.engine
.send_modeling_cmd(
uuid::Uuid::new_v4(),

5
src/wasm-lib/derive-docs/tests/show.gen
View File

@ -46,6 +46,11 @@ mod test_examples_show {
.await
.unwrap();
ctx.run(&program, None).await.unwrap();
let results = program.lint_all().unwrap();
if !results.is_empty() {
panic!("Linting failed: {:?}", results);
}
ctx.engine
.send_modeling_cmd(
uuid::Uuid::new_v4(),

4
src/wasm-lib/kcl/Cargo.toml
View File

@ -17,9 +17,10 @@ async-trait = "0.1.81"
base64 = "0.22.1"
chrono = "0.4.38"
clap = { version = "4.5.11", default-features = false, optional = true }
convert_case = "0.6.0"
dashmap = "6.0.1"
databake = { version = "0.1.8", features = ["derive"] }
derive-docs = { version = "0.1.20", path = "../derive-docs" }
derive-docs = { version = "0.1.21", path = "../derive-docs" }
form_urlencoded = "1.2.1"
futures = { version = "0.3.30" }
git_rev = "0.1.0"
@ -82,7 +83,6 @@ debug = true # Flamegraphs of benchmarks require accurate debug symbols
[dev-dependencies]
base64 = "0.22.1"
convert_case = "0.6.0"
criterion = { version = "0.5.1", features = ["async_tokio"] }
expectorate = "1.1.0"
iai = "0.1"

1
src/wasm-lib/kcl/src/ast/types.rs
View File

@ -209,6 +209,7 @@ impl Program {
pub fn lint_all(&self) -> Result<Vec<crate::lint::Discovered>> {
let rules = vec![
crate::lint::checks::lint_variables,
crate::lint::checks::lint_object_properties,
crate::lint::checks::lint_call_expressions,
];

13
src/wasm-lib/kcl/src/docs.rs
View File

@ -3,6 +3,7 @@
use std::path::Path;
use anyhow::Result;
use convert_case::Casing;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use tower_lsp::lsp_types::{
@ -56,7 +57,10 @@ pub struct StdLibFnArg {
impl StdLibFnArg {
#[allow(dead_code)]
pub fn get_type_string(&self) -> Result<(String, bool)> {
get_type_string_from_schema(&self.schema.clone())
match get_type_string_from_schema(&self.schema.clone()) {
Ok(r) => Ok(r),
Err(e) => anyhow::bail!("error getting type string for {}: {:#?}", self.type_, e),
}
}
pub fn get_autocomplete_string(&self) -> Result<String> {
@ -364,6 +368,13 @@ pub fn get_type_string_from_schema(schema: &schemars::schema::Schema) -> Result<
continue;
}
// Make sure none of the object properties are in snake case.
// We want the language to be consistent.
// This will fail in the docs generation and not at runtime.
if !prop_name.is_case(convert_case::Case::Camel) {
anyhow::bail!("expected camel case: {:#?}", prop_name);
}
if let Some(description) = get_description_string_from_schema(prop) {
fn_docs.push_str(&format!("\t// {}\n", description));
}

2
src/wasm-lib/kcl/src/executor.rs
View File

@ -1008,6 +1008,7 @@ pub enum FilletOrChamfer {
id: uuid::Uuid,
radius: f64,
/// The engine id of the edge to fillet.
#[serde(rename = "edgeId")]
edge_id: uuid::Uuid,
tag: Box<Option<TagDeclarator>>,
},
@ -1017,6 +1018,7 @@ pub enum FilletOrChamfer {
id: uuid::Uuid,
length: f64,
/// The engine id of the edge to chamfer.
#[serde(rename = "edgeId")]
edge_id: uuid::Uuid,
tag: Box<Option<TagDeclarator>>,
},

42
src/wasm-lib/kcl/src/lint/checks/camel_case.rs
View File

@ -1,7 +1,8 @@
use anyhow::Result;
use convert_case::Casing;
use crate::{
ast::types::VariableDeclarator,
ast::types::{ObjectProperty, VariableDeclarator},
executor::SourceRange,
lint::rule::{def_finding, Discovered, Finding},
walk::Node,
@ -22,17 +23,25 @@ https://en.wikipedia.org/wiki/Camel_case
"
);
fn lint_lower_camel_case(decl: &VariableDeclarator) -> Result<Vec<Discovered>> {
fn lint_lower_camel_case_var(decl: &VariableDeclarator) -> Result<Vec<Discovered>> {
let mut findings = vec![];
let ident = &decl.id;
let name = &ident.name;
if !name.chars().next().unwrap().is_lowercase() {
if !name.is_case(convert_case::Case::Camel) {
findings.push(Z0001.at(format!("found '{}'", name), SourceRange::new(ident.start, ident.end)));
return Ok(findings);
}
if name.contains('-') || name.contains('_') {
Ok(findings)
}
fn lint_lower_camel_case_property(decl: &ObjectProperty) -> Result<Vec<Discovered>> {
let mut findings = vec![];
let ident = &decl.key;
let name = &ident.name;
if !name.is_case(convert_case::Case::Camel) {
findings.push(Z0001.at(format!("found '{}'", name), SourceRange::new(ident.start, ident.end)));
return Ok(findings);
}
@ -48,13 +57,25 @@ pub fn lint_variables(decl: Node) -> Result<Vec<Discovered>> {
Ok(decl
.declarations
.iter()
.flat_map(|v| lint_lower_camel_case(v).unwrap_or_default())
.flat_map(|v| lint_lower_camel_case_var(v).unwrap_or_default())
.collect())
}
pub fn lint_object_properties(decl: Node) -> Result<Vec<Discovered>> {
let Node::ObjectExpression(decl) = decl else {
return Ok(vec![]);
};
Ok(decl
.properties
.iter()
.flat_map(|v| lint_lower_camel_case_property(v).unwrap_or_default())
.collect())
}
#[cfg(test)]
mod tests {
use super::{lint_variables, Z0001};
use super::{lint_object_properties, lint_variables, Z0001};
use crate::lint::rule::{assert_finding, test_finding, test_no_finding};
#[test]
@ -134,6 +155,15 @@ const part001 = startSketchOn('XY')
|> angledLineToX({ angle: 60, to: pipeLargeDia }, %)
|> close(%)
|> revolve({ axis: 'y' }, %)
"
);
test_finding!(
z0001_full_bad_object,
lint_object_properties,
Z0001,
"\
let circ = {angle_start: 0, angle_end: 360, radius: radius}
"
);
}

2
src/wasm-lib/kcl/src/lint/checks/mod.rs
View File

@ -2,5 +2,5 @@ mod camel_case;
mod std_lib_args;
#[allow(unused_imports)]
pub use camel_case::{lint_variables, Z0001};
pub use camel_case::{lint_object_properties, lint_variables, Z0001};
pub use std_lib_args::{lint_call_expressions, Z0002};

20
src/wasm-lib/kcl/src/lint/checks/std_lib_args.rs
View File

@ -21,6 +21,26 @@ Previously, we have not been failing when too many arguments are passed to a std
fn lint_too_many_args_std_lib_function(f: Box<dyn StdLibFn>, exp: &CallExpression) -> Result<Vec<Discovered>> {
let mut findings = vec![];
if f.name() == "pow" {
if exp.arguments.len() != 2 {
findings.push(Z0002.at(
format!("expected 2 arguments, found {}", exp.arguments.len()),
SourceRange::new(exp.start, exp.end),
));
}
return Ok(findings);
}
if f.name() == "max" || f.name() == "min" {
if exp.arguments.len() < 2 {
findings.push(Z0002.at(
format!("expected at least 2 arguments, found {}", exp.arguments.len()),
SourceRange::new(exp.start, exp.end),
));
}
return Ok(findings);
}
if exp.arguments.len() > f.args().len() {
findings.push(Z0002.at(
format!("expected {} arguments, found {}", f.args().len(), exp.arguments.len()),

8
src/wasm-lib/kcl/src/std/args.rs
View File

@ -1,5 +1,9 @@
use std::any::type_name;
use kittycad::types::OkWebSocketResponseData;
use serde::de::DeserializeOwned;
use super::{shapes::SketchSurfaceOrGroup, sketch::FaceTag, FnAsArg};
use crate::{
ast::types::{parse_json_number_as_f64, TagDeclarator},
errors::{KclError, KclErrorDetails},
@ -8,10 +12,6 @@ use crate::{
SketchGroup, SketchGroupSet, SketchSurface, SourceRange, TagIdentifier,
},
};
use kittycad::types::OkWebSocketResponseData;
use serde::de::DeserializeOwned;
use super::{shapes::SketchSurfaceOrGroup, sketch::FaceTag, FnAsArg};
#[derive(Debug, Clone)]
pub struct Args {

8
src/wasm-lib/kcl/src/std/extrude.rs
View File

@ -30,8 +30,8 @@ pub async fn extrude(args: Args) -> Result<MemoryItem, KclError> {
/// |> startProfileAt([0, 0], %)
/// |> line([10, 0], %)
/// |> arc({
/// angle_end: 0,
/// angle_start: 120,
/// angleStart: 120,
/// angleEnd: 0,
/// radius: 5,
/// }, %)
/// |> line([5, 0], %)
@ -50,8 +50,8 @@ pub async fn extrude(args: Args) -> Result<MemoryItem, KclError> {
/// const exampleSketch = startSketchOn('XZ')
/// |> startProfileAt([-10, 0], %)
/// |> arc({
/// angle_end: -60,
/// angle_start: 120,
/// angleStart: 120,
/// angleEnd: -60,
/// radius: 5,
/// }, %)
/// |> line([10, 0], %)

4
src/wasm-lib/kcl/src/std/helix.rs
View File

@ -19,6 +19,7 @@ pub struct HelixData {
/// Number of revolutions.
pub revolutions: f64,
/// Start angle (in degrees).
#[serde(rename = "angleStart", alias = "angle_start")]
pub angle_start: f64,
/// Is the helix rotation counter clockwise?
/// The default is `false`.
@ -44,10 +45,9 @@ pub async fn helix(args: Args) -> Result<MemoryItem, KclError> {
/// |> circle([5, 5], 10, %)
/// |> extrude(10, %)
/// |> helix({
/// angle_start: 0,
/// angleStart: 0,
/// ccw: true,
/// revolutions: 16,
/// angle_start: 0
/// }, %)
/// ```
#[stdlib {

2
src/wasm-lib/kcl/src/std/mod.rs
View File

@ -23,6 +23,7 @@ pub mod utils;
use std::collections::HashMap;
use anyhow::Result;
pub use args::Args;
use derive_docs::stdlib;
use lazy_static::lazy_static;
use parse_display::{Display, FromStr};
@ -36,7 +37,6 @@ use crate::{
executor::{MemoryItem, ProgramMemory, SketchGroup, SketchSurface},
std::kcl_stdlib::KclStdLibFn,
};
pub use args::Args;
pub type StdFn = fn(Args) -> std::pin::Pin<Box<dyn std::future::Future<Output = Result<MemoryItem, KclError>> + Send>>;

15
src/wasm-lib/kcl/src/std/sketch.rs
View File

@ -902,10 +902,13 @@ pub enum PlaneData {
/// Origin of the plane.
origin: Box<Point3d>,
/// What should the plane’s X axis be?
#[serde(rename = "xAxis", alias = "x_axis")]
x_axis: Box<Point3d>,
/// What should the plane’s Y axis be?
#[serde(rename = "yAxis", alias = "y_axis")]
y_axis: Box<Point3d>,
/// The z-axis (normal).
#[serde(rename = "zAxis", alias = "z_axis")]
z_axis: Box<Point3d>,
},
}
@ -1084,9 +1087,9 @@ pub async fn start_sketch_on(args: Args) -> Result<MemoryItem, KclError> {
/// const a1 = startSketchOn({
/// plane: {
/// origin: { x: 0, y: 0, z: 0 },
/// x_axis: { x: 1, y: 0, z: 0 },
/// y_axis: { x: 0, y: 1, z: 0 },
/// z_axis: { x: 0, y: 0, z: 1 }
/// xAxis: { x: 1, y: 0, z: 0 },
/// yAxis: { x: 0, y: 1, z: 0 },
/// zAxis: { x: 0, y: 0, z: 1 }
/// }
/// })
/// |> startProfileAt([0, 0], %)
@ -1466,8 +1469,10 @@ pub enum ArcData {
/// Angles and radius with an optional tag.
AnglesAndRadius {
/// The start angle.
#[serde(rename = "angleStart", alias = "angle_start")]
angle_start: f64,
/// The end angle.
#[serde(rename = "angleEnd", alias = "angle_end")]
angle_end: f64,
/// The radius.
radius: f64,
@ -1499,8 +1504,8 @@ pub async fn arc(args: Args) -> Result<MemoryItem, KclError> {
/// |> startProfileAt([0, 0], %)
/// |> line([10, 0], %)
/// |> arc({
/// angle_start: 0,
/// angle_end: 280,
/// angleStart: 0,
/// angleEnd: 280,
/// radius: 16
/// }, %)
/// |> close(%)