Use named constants for relativeTo in Shell codemod (#8893)

* Use named constants for relativeTo in Shell codemod
Fixes #8892

* Polish

* Fix test

Author: pierremtb

e2e/playwright/point-click.spec.ts

@@ -1153,7 +1153,7 @@ sketch002 = startSketchOn(plane001)
 sketch001 = startSketchOn(XZ)
 profile001 = ${circleCode}`
     const sweepDeclaration = 'sweep001 = sweep(profile001, path = helix001)'
-    const editedSweepDeclaration = `sweep001 = sweep(profile001, path = helix001, relativeTo = "sketchPlane")`
+    const editedSweepDeclaration = `sweep001 = sweep(profile001, path = helix001, relativeTo = sweep::SKETCH_PLANE)`
 
     await context.addInitScript((initialCode) => {
       localStorage.setItem('persistCode', initialCode)
@@ -1235,11 +1235,11 @@ profile001 = ${circleCode}`
         highlightedHeaderArg: 'relativeTo',
         commandName: 'Sweep',
       })
-      await cmdBar.selectOption({ name: 'sketchPlane' }).click()
+      await cmdBar.selectOption({ name: 'Sketch Plane' }).click()
       await cmdBar.expectState({
         stage: 'review',
         headerArguments: {
-          RelativeTo: 'sketchPlane',
+          RelativeTo: 'SKETCH_PLANE',
         },
         commandName: 'Sweep',
       })

src/lang/modifyAst/sweeps.spec.ts

@@ -542,7 +542,7 @@ profile002 = startProfile(sketch002, at = [0, 0])
         kclManagerInThisFile
       )
       const sectional = true
-      const relativeTo = 'sketchPlane'
+      const relativeTo = 'SKETCH_PLANE'
       const result = addSweep({ ast, sketches, path, sectional, relativeTo })
       if (err(result)) throw result
       await runNewAstAndCheckForSweep(result.modifiedAst, rustContextInThisFile)
@@ -552,7 +552,7 @@ profile002 = startProfile(sketch002, at = [0, 0])
   profile001,
   path = profile002,
   sectional = true,
-  relativeTo = "sketchPlane",
+  relativeTo = sweep::SKETCH_PLANE,
 )`)
     })
 
@@ -562,15 +562,15 @@ sweep001 = sweep(
   profile001,
   path = profile002,
   sectional = true,
-  relativeTo = 'sketchPlane',
+  relativeTo = sweep::SKETCH_PLANE,
 )`
       const { ast, sketches, path } = await getAstAndSketchesForSweep(
         circleAndLineCodeWithSweep,
         instanceInThisFile,
         kclManagerInThisFile
       )
       const sectional = false
-      const relativeTo = 'trajectoryCurve'
+      const relativeTo = 'TRAJECTORY'
       const nodeToEdit = createPathToNodeForLastVariable(ast)
       const result = addSweep({
         ast,
@@ -585,7 +585,7 @@ sweep001 = sweep(
       const newCode = recast(result.modifiedAst, instanceInThisFile)
       expect(newCode).toContain(circleAndLineCode)
       expect(newCode).toContain(
-        `sweep001 = sweep(profile001, path = profile002, relativeTo = "trajectoryCurve")`
+        `sweep001 = sweep(profile001, path = profile002, relativeTo = sweep::TRAJECTORY)`
       )
     })
 

src/lang/modifyAst/sweeps.ts

@@ -3,6 +3,7 @@ import type { OpArg, OpKclValue } from '@rust/kcl-lib/bindings/Operation'
 
 import {
   createCallExpressionStdLibKw,
+  createName,
   createLabeledArg,
   createLiteral,
   createLocalName,
@@ -202,6 +203,14 @@ export function addExtrude({
   }
 }
 
+// From rust/kcl-lib/std/sweep.kcl
+export type SweepRelativeTo = 'SKETCH_PLANE' | 'TRAJECTORY'
+export const SWEEP_CONSTANTS: Record<string, SweepRelativeTo> = {
+  SKETCH_PLANE: 'SKETCH_PLANE',
+  TRAJECTORY: 'TRAJECTORY',
+}
+export const SWEEP_MODULE = 'sweep'
+
 export function addSweep({
   ast,
   sketches,
@@ -216,7 +225,7 @@ export function addSweep({
   sketches: Selections
   path: Selections
   sectional?: boolean
-  relativeTo?: string
+  relativeTo?: SweepRelativeTo
   tagStart?: string
   tagEnd?: string
   nodeToEdit?: PathToNode
@@ -254,7 +263,7 @@ export function addSweep({
     ? [createLabeledArg('sectional', createLiteral(sectional))]
     : []
   const relativeToExpr = relativeTo
-    ? [createLabeledArg('relativeTo', createLiteral(relativeTo))]
+    ? [createLabeledArg('relativeTo', createName([SWEEP_MODULE], relativeTo))]
     : []
   const tagStartExpr = tagStart
     ? [createLabeledArg('tagStart', createTagDeclarator(tagStart))]

src/lib/commandBarConfigs/modelingCommandConfig.ts

@@ -48,6 +48,7 @@ import {
   addLoft,
   addRevolve,
   addSweep,
+  type SweepRelativeTo,
 } from '@src/lang/modifyAst/sweeps'
 import { mockExecAstAndReportErrors } from '@src/lang/modelingWorkflows'
 import { addHole, addOffsetPlane, addShell } from '@src/lang/modifyAst/faces'
@@ -148,7 +149,7 @@ export type ModelingCommandSchema = {
     path: Selections
     sectional?: boolean
     // TODO: figure out if we should expose `tolerance` or not
-    relativeTo?: string
+    relativeTo?: SweepRelativeTo
     tagStart?: string
     tagEnd?: string
   }
@@ -659,8 +660,8 @@ export const modelingMachineCommandConfig: StateMachineCommandSetConfig<
         inputType: 'options',
         required: false,
         options: [
-          { name: 'sketchPlane', value: 'sketchPlane' },
-          { name: 'trajectoryCurve', value: 'trajectoryCurve' },
+          { name: 'Sketch Plane', value: 'SKETCH_PLANE' },
+          { name: 'Trajectory Curve', value: 'TRAJECTORY' },
         ],
       },
       tagStart: {

src/lib/operations.ts

@@ -12,6 +12,9 @@ import {
 import {
   retrieveAxisOrEdgeSelectionsFromOpArg,
   retrieveTagDeclaratorFromOpArg,
+  SWEEP_CONSTANTS,
+  SWEEP_MODULE,
+  type SweepRelativeTo,
 } from '@src/lang/modifyAst/sweeps'
 import {
   getNodeFromPath,
@@ -899,15 +902,22 @@ const prepareToEditSweep: PrepareToEditCallback = async ({ operation }) => {
       ) === 'true'
   }
 
-  let relativeTo: string | undefined
+  let relativeTo: SweepRelativeTo | undefined
   if (
     'relativeTo' in operation.labeledArgs &&
     operation.labeledArgs.relativeTo
   ) {
-    relativeTo = codeManager.code.slice(
+    const result = codeManager.code.slice(
       operation.labeledArgs.relativeTo.sourceRange[0],
       operation.labeledArgs.relativeTo.sourceRange[1]
     )
+    if (result === `${SWEEP_MODULE}::${SWEEP_CONSTANTS.SKETCH_PLANE}`) {
+      relativeTo = SWEEP_CONSTANTS.SKETCH_PLANE
+    } else if (result === `${SWEEP_MODULE}::${SWEEP_CONSTANTS.TRAJECTORY}`) {
+      relativeTo = SWEEP_CONSTANTS.TRAJECTORY
+    } else {
+      return { reason: "Couldn't retrieve relativeTo argument" }
+    }
   }
 
   // tagStart and tagEng arguments