Take Before

Command: take-before

Description: Return all text before the specified character occurrence, optionally including the character itself.

Arguments

• char : The character to find (required)
• index : Which occurrence of the character to use (defaults to 1)
• inclusive : If true, includes the designated character in the result (defaults to false)

Source Code

function takeBefore(working, command, p) {
  const char = command.getArg("char");
  const index = command.getArg("index") ?? 1;
  const inclusive = command.getArg("inclusive") ?? false;

  if (!char) {
    throw new Error("The 'char' argument is required for takeBefore command");
  }

  const indexNum = Number(index);
  if (isNaN(indexNum) || indexNum < 1) {
    throw new Error(`The 'index' argument must be a positive number, got ${index}`);
  }

  // Find the index-th occurrence of the character
  let count = 0;
  for (let i = 0; i < working.text.length; i++) {
    if (working.text[i] === char) {
      count++;
      if (count === indexNum) {
        const endIndex = inclusive ? i + 1 : i;
        return working.text.substring(0, endIndex);
      }
    }
  }

  // Character not found at the specified index
  return "";
}

takeBefore.title = "Take Before";
takeBefore.description =
  "Return all text before the specified character occurrence, optionally including the character itself.";
takeBefore.args = [
  {
    name: "char",
    type: "string",
    description: "The character to find (required)",
  },
  {
    name: "index",
    type: "number",
    description: "Which occurrence of the character to use (defaults to 1)",
  },
  {
    name: "inclusive",
    type: "string",
    description: "If true, includes the designated character in the result (defaults to false)",
  },
];
takeBefore.parseValidators = [
  {
    test: (command) => command.hasArg("char"),
    message: "You must provide a 'char' argument specifying which character to find",
  },
];

export default takeBefore;