Should the command fixture input selection be indicated with markers?

[JayBazuzi]

Consider this input:

/**
 * @description Rename a function argument
 * @command refakts rename "[function-argument.input.ts 6:22-6:30]" --to "newParam"
 */

function processData(oldParam: string, other: number): string {
  const result = oldParam.toUpperCase();
  return oldParam + result + other;
}

Problem

• When reading this, it's difficult to know what is being renamed.
• If we modify the input code, it's tedious to update the command line correctly.

Proposed solution

• Use special comment markers to indicate the selection range.

Example

/**
 * @description Rename a function argument
 * @command refakts rename "[function-argument.input.ts {{CURRENT_SELECTION}}]" --to "newParam"
 */

function processData(/*|*/oldParam/*|*/: string, other: number): string {
  const result = oldParam.toUpperCase();
  return oldParam + result + other;
}

[devill]

That also looks like an interesting suggestion. Note that the select commands already use a similar marker when they show the selection in context. We used ≫ and ≪ there to mark the start and end of the selection. This could be an option here as well.

Either like this:
function processData(/*≫*/oldParam/*≪*/: string, other: number): string {

Or if we are willing to make a trade off, and accept that the input files don't necessarily compile like this:
function processData(≫oldParam≪: string, other: number): string {

Visually I prefer the second option, however that would mean that when we copy the input file to the received file before running the command we do need to find and replace these characters. To be fair we would be manipulating the file anyway to get the selection bounds, so that might not be that much of an issue.

[JayBazuzi]

It's super convenient to have the input files be actual valid TS without preprocessing, as IDEs, autoformatters, and other tools will continue to do the right thing. (BTW if you decide to break syntax, then don't use .ts as the extension.)

Clutter is annoying though. I'm now thinking that /**/ might be my favorite.

If there's just one, the selection 1 character wide; if there are two, they mark the range. three or more is an error.

[devill]

Yeah, you are probably right about not wanting to break syntax.

I also like /**/. Feels cleaner then previous suggestions.

Another option that I just though of is leaving the format as is, and instead building a simple IntelliJ plugin to highlight the selection. To be fair it would be a lot more complex then adding the comment blocks and wouldn't work for folks using other editors.