Change the name of registerDocumentFormats

[chris48s]

Today in "naming things is hard"..

The term "format" is too overloaded, particularly given you refer to the output formats as just --format.

Maybe change this to either registerDocumentParsers or registerDocumentFormatParsers

Compare

/**
 * Use the `registerDocumentFormats` hook to tell v8r about additional
 * document formats that can be parsed. Any formats registered with this hook
 * become valid values for the `parser` property in custom schemas.
 *
 * @returns {string[]}
 */
registerDocumentFormats() {
  return [];
}

to

/**
 * Use the `registerDocumentParsers` hook to tell v8r about additional
 * document formats that can be parsed. Any parsers registered with this hook
 * become valid values for the `parser` property in custom schemas.
 *
 * @returns {string[]}
 */
registerDocumentParsers() {
  return [];
}

I feel like the second is clearer.

[chris48s]

I reckon also change the name of the 3rd argument to parseDocument() from format to parser and update the docs accordingly

[chris48s]

Hmm, but does parser imply it is the parser function itself. At least with format it is more clear this is a string like "toml" or "json".

You could always consider a breaking change to the config file/command line args to clean up the terminology there a bit.

Decisions decisions.

[chris48s]

I ended up going with

• registerInputFileParsers()
• parseInputFile(contents, fileLocation, parser)

see
#487 (comment)