mooeypoo / dom-word-replacer Goto Github PK

The readme right now is a big messy, and tries to explain about the general concepts alongside the technical options/config.

There are a few concepts that require explanation:

• Dictionaries and the expected structure, nuances of "ambiguous" terms, random choice from multiple replacement options, groupings, etc.
• Installation and usage examples
• Config options for instantiation
• Option object for the replacement method

There should be an organized README with, potentially, some wiki pages to delve deeper into usage examples and explanations without overwhelming the page completely.

Add a mode that goes over matches but does not replace them -- instead, provides the available replacement suggestions in a data-suggested-replacements (or similar) prop.

The goal:

Analyzing web pages and tagging/flagging words that should or could be considered for replacement, and providing available options, allowing consumers to create a popup or hover that provides explanation and suggestion.

Probably depends on #1 - Since this adds yet another parameter to the .replace(...) call, also consider making the optional configuration inside a config variable (which would be a breaking change).

The replace method is starting to be extremely verbose in terms of the parameters it allows, and there are several future enhancement considerations that may add even more to it.

The call should be replaced to have the optional parameters as part of a configuration options object, which will also allow for more flexibility in the future.

Instead of

replacer.replace(htmlString, keyFrom, keyTo,baseUrl, bothWays);

It should be something like

replacer.replace(html, this.keys[0], this.keys[1], {
  baseUrl: '...',
  bothWays: '...'
});

And then include other upcoming modes.

There are currently benchmarking of performance done in the demos folder, but these should be made into actual tests with proper performance benchmarking to make sure the operation doesn't take an unreasonable amount of time.

Replacing words should result with the same casing (in English, at least). Foo replaced with Bar rather than bar.

Since replacements aren't necessarily the same amount of letters, there are really only two cases the system should keep case for:

• Capitalization of first letter (Foo -> Bar)
• Capitalization of the entire word (FOO -> BAR)