Make the list of options extensible

[jmini]

For some linter projects additional project specific options are required. The JXLint framework should be extensible in this area.

For the maven use case: the project specific Mojo (extending AbstractJxlintMojo) can contain additional parameters. The method createProgramOptions() can be overridden to handle the mapping.

For the command line use case: at the moment I have the feeling that there is too much calls of static methods. One approach could be to have a project specific subclass of Jxlint to somehow influence/replace the calls of CommandLineOptions.generateJxlintOptions() and ProgramOptionExtractor.extractProgramOptions(CommandLine) in the method Jxlint#parseArgumentsAndDispatch(String[]).

What do you think?

[selesse]

Your proposed changes sound good to me. I'd be a bit curious to see what the use case is for the additional parameters in the AbstractJxlintMojo.

[jmini]

The additional option you might want to add really depends on the nature of the checker you write with jxlint.

One example I can imagine:
Have an additional option to define the regex pattern for the file name that should be scanned by your rules. You would implement getFilesToValidate() like this:

  @Override
  public List<File> getFilesToValidate() {
    String regex = //read the value from the option "MATCHING_FILE_REGEX"
    return FileUtils.allFilesMatching(getSourceDirectory(), regex);
  }

But this means you need to add a way to define matchingFileRegex in your Mojo or to define it from your checker CLI.

Of course this is just an example, for my htmlchecker project, I have one or two options in mind that are really specific for this checker.

Does it make sense? How would you customize the rules logic without having to add an additional option?

[selesse]

I wouldn't allow customizing the logic like that without an additional option. Supplying a regex for getFilesToValidate seem like something the framework should handle through either a CLI option or a configuration file. I feel the same way about adding the ability to ignore lint failures for a certain file. If all of these things are handled by the jxlint CLI, but there's still a need to add custom options through overriding createProgramOptions, I'm OK with adding a mechanism that makes it easy.