Move String utilities to their own class

[MatthewBlanski]

The string utilities for ApexDocJs are not well-encapsulated and are repeated throughout the project. These utilities should be placed into a separate class in order to leverage their capabilities throughout the project.

Example classes are:

• ApexDoc.strPrevWord
• ApexDoc.countChars

[arvind0598]

I could help out.

[MatthewBlanski]

I could help out.

Please feel free to submit a PR. I don't have much in the way of code styling yet for this project.

[arvind0598]

There's a lot of places in the code where its currently:

let idxStart = comment.toLowerCase().indexOf("@author");
if (idxStart != -1) {
    cModel.setAuthor(comment.substring(idxStart + 7).trim());
    inDescription = false;
    return;
}

Any comments on me creating and using a function as so:

function getPostSubstringIfExists(str, sub) {
    return str.toLowerCase().indexOf(sub) < 0 ? null : str.substring(sub.length).trim();
}

const authorComment = getPostSubstringIfExists(comment, "@author");
if (authorComment) {
    cModel.setAuthor(authorComment);
    inDescription = false;
    return;
}

Of course, I can't use this for the "@group " case with its extra space, but should I add this function to the stringUtils class too?

[MatthewBlanski]

I think that's a fine idea. You also may want to consider using a regular expression pattern to match that instead of basic string manipulation. I'm leaning in the direction of using regular expressions for this form of parsing as they are ideal for performing complex string manipulation.

For example:

let authorMatch = comment.match(/@author(.*)$/);
if (authorMatch) {
  cModel.setAuthor(authorMatch[1]);
  inDescription = false;
  return;
}