Should the Parser.set function validate variable names?

[orelbn]

According to documentation, variable names must meet certain criteria:
https://mathjs.org/docs/expressions/syntax.html#constants-and-variables

But if you use the set function on the parser, it does not validate that criteria.

/**
 * Set a symbol (a function or variable) by name from the parsers scope.
 * @param {string} name
 * @param {* | undefined} value
 */
Parser.prototype.set = function (name, value) {
  this.scope.set(name, value)
  return value
}

[josdejong]

Thanks, good point. Right now the parser allows setting any variable name, and only when using the variable in an expression, an error will be thrown. It would be good to validate the variable name in the method Parser.set.

@nkumawat34 this actually is a very nice first issue, is this something you would like to pick up?

[nkumawat34]

Yes I will pick it.

[josdejong]

Thanks! 💪

[nkumawat34]

  function isValidVariableName(name) {
    const reservedKeywords = ['mod', 'to', 'in', 'and', 'xor', 'or', 'not', 'end'];

    // Regular expression to match the variable name rules
    const regex = /^[a-zA-Z_$\u00C0-\u02AF\u0370-\u03FF\u2100-\u214F\u{1D400}-\u{1D7FF}][a-zA-Z0-9_$\u00C0-\u02AF\u0370-\u03FF\u2100-\u214F\u{1D400}-\u{1D7FF}]*$/u;

    // Check if the name matches the regex and is not a reserved keyword
    return regex.test(name) && !reservedKeywords.includes(name);
  }

  /**
   * Set a symbol (a function or variable) by name from the parsers scope.
   * @param {string} name
   * @param {* | undefined} value
   */
    Parser.prototype.set = function (name, value) {
      if (!isValidVariableName(name)) {
        throw new Error(`Invalid variable name: '${name}'. Variable names must follow the specified rules.`);
      }
      this.scope.set(name, value);
      return value;
    };

[nkumawat34]

can I make a PR of this with unit test cases.

[josdejong]

Yes please 👍

[nkumawat34]

Please check the PR for issue #3308

[josdejong]

Thanks, the PR looks good on first sight. I'll look into it in more detail this week.

[josdejong]

A fix is published now in [email protected].