~royston/codsen

codsen/packages/string-strip-html/CHANGELOG.md -rw-r--r-- 9.6 KiB
00c01097Roy Revelt docs: example tweak 2 days ago

#Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

#7.0.0 (2020-11-28)

Accidental version bump during migration to sourcehut. Sorry about that.

#6.3.0 (2020-11-10)

#Features

#6.2.0 (2020-10-26)

#Features

  • better recognise some JSON patterns (450d30a)

#6.1.0 (2020-10-13)

#Bug Fixes

  • fix filteredTagLocations closing location on paired tags (43ce393)

#Features

  • wildcard ALL option for opts.stripTogetherWithTheirContents (d2031ab)

#6.0.0 (2020-09-15)

#Bug Fixes

  • correct filteredTagLocations for pair tags which are stripped with content (6bd6f4c)

#BREAKING CHANGES

  • now filteredTagLocations shows only one range for pair tags which are to be stripped with their contents

#5.0.0 (2020-08-16)

Why change what's returned, upon user's request, when we can return everything and let the user pick?

#BREAKING CHANGES

That's why we removed opts.returnRangesOnly.

Function's output is a plain object now, containing:

  1. cleaned string (considering opts.ignoreTags and opts.onlyStripTags)
  2. gathered ranges, used to produce cleaned string (considering opts.ignoreTags and opts.onlyStripTags)
  3. tag locations of all spotted HTML tags IGNORING the whitelist/blacklist opts.ignoreTags and opts.onlyStripTags
  4. locations of filtered HTML tags (considering opts.ignoreTags and opts.onlyStripTags)
  5. plus, some statistics goodies
stripHtml("abc<a>click me</a>def");
// => {
//      log: {
//        timeTakenInMilliseconds: 6
//      },
//      result: "abc click me def",
//      ranges: [
//        [3, 6, " "],
//        [14, 18, " "],
//      ],
//      allTagLocations: [
//        [3, 6],
//        [14, 18],
//      ],
//      filteredTagLocations: [
//        [3, 6],
//        [14, 18],
//      ],
//    }

allTagLocations can be used for syntax highlighting, for example.

Migration instructions:

Previously, function on defaults returned result string. Now it's under result key, in output plain object. Previously, you could request ranges output via opts.returnRangesOnly. Now ranges are always present under key ranges.

Some people mistakenly took ranges output for exact tag locations. Now exact tag locations are under allTagLocations key.

That's different from ranges output, because ranges are instructions: what to add, what to replace and can be merged and their character indexes covered will include whitespace management.

allTagLocations, on other hand, are exact tag locations. If you slice them using String.slice() you'll get string from bracket-to-bracket like <a>.

#4.4.0 (2020-04-26)

#Features

  • harden the linting rules and make them all pass (812d17e)

#4.3.0 (2019-09-23)

#Features

  • respect double line breaks (2c09d59), closes #15

#4.2.0 (2019-09-04)

#Features

  • add previously missing tag.lastClosingBracketAt on ignored tags (f35e595)
  • make the callback (opts.cb) ping the ignored tags too (d9302e7)
  • report tag.slashPresent as index of the slash, not as a boolean (96ce6c8)

#4.1.0 (2019-08-24)

#Features

  • implement callback interface, opts.cb() (79bc8dc)

#3.5.0 (2019-01-20)

  • ✨ Various documentation and setup tweaks after we migrated to monorepo
  • ✨ Setup refresh: updated dependencies and all config files using automated tools

#3.3.0 (2018-12-26)

#Bug Fixes

  • 🐛 Throwing case when tag is the last in string and has closing bracket missing (ef44f63)

#Features

  • ✨ Algorithm improvements (8a82b8e)
  • ✨ Delete trailing whitespace after dirty code chunk: tag + missing opening bracket tag (71f720c)
  • ✨ Improvements to exclamation mark punctuation (e31fd3b)
  • ✨ opts.dumpLinkHrefsNearby and algorithm improvements (777407e)
  • ✨ Add opts.onlyStripTags (7bb49c8)
  • ✨ Add opts.trimOnlySpaces (b8c6f29)

#3.2.0 (2018-07-22)

  • ✨ Fixed opts.returnRangesOnly - when there are no HTML tags in the input and the option is on, an empty array is returned (as opposed to the input string, incorrectly returned previously). Sorry about that.

#3.1.0 (2018-07-17)

  • ✨ Added opts.onlyStripTags

#3.0.0 (2018-07-03)

Breaking changes: opts.dumpLinkHrefsNearby was previously Boolean. Now it's a plain object and its key enabled (opts.dumpLinkHrefsNearby.enabled) does the same thing that opts.dumpLinkHrefsNearby did before v3.

This makes it easier for us to contain all new opts.dumpLinkHrefsNearby settings in one place:

{
  ignoreTags: [],
  stripTogetherWithTheirContents: stripTogetherWithTheirContentsDefaults,
  skipHtmlDecoding: false,
  returnRangesOnly: false,
  trimOnlySpaces: false,
  dumpLinkHrefsNearby: { // <------ CHANGED!
    enabled: false, // <-------- 💥 NEW!
    putOnNewLine: false, // <--- 💥 NEW!
    wrapHeads: "", // <--------- 💥 NEW!
    wrapTails: "" // <---------- 💥 NEW!
  }
}
  • ✨ Now, input string is returned trimmed of whitespace in the beginning and in the end.

#2.4.0 (2018-06-20)

#2.3.0 (2018-06-08)

  • ✨ Improvements to dirty code recognition algorithm

#2.2.0 (2018-06-02)

  • ✨ opts.dumpLinkHrefsNearby - handy when producing Email Text versions
  • ✨ Improved algorithm to understand HTML code that has been abruptly chopped off. If you select bunch of HTML where beginning is valid, but ending is somewhere in the middle of the tags, styles or whatnot, now that tag will be removed.
  • ✨ Improved algorithm to detect and clean tags without closing bracket, if a new tag follows, with or without whitespace in between.

64 unit tests, 451 assertions, 2226 lines of unit tests at 90% line coverage.

#2.1.0 (2018-05-31)

  • ✨ opts.trimOnlySpaces - up until now, by default, the outsides of the string was trimmed using String.trim() which erased:

    • non-breaking spaces (in combination with recursive entity decoding this means &nbsp; will also be erased)
    • tabs
    • line breaks (\n), carriage returns (\r) and combination thereof (\r\n)
    • some other less common but space-like characters.

    This becomes a challenge in automated environments where data is considered to be clean and multiple datum can be parts of another. For example, we might be cleaning JSON fields where value is "sandwitched" out of three fields: "Hi ", "%%-firstname-%%", ", welcome to special club!". To improve formatting, some outer spaces like after "Hi" can be replaced with a non-breaking space. This way, words would never wrap there. However, if all fields were cleaned by a tool which used this HTML stripping function, outer non-breaking spaces would get deleted and result would end up: "HiJohn, welcome to special club!". This option makes trimming more strict - only spaces deleted during string trimming.

#2.0.0 (2018-05-30)

One day I noticed that my Nunjucks code (just a greater-than comparison against a number) gets falsely interpreted as HTML by this library and went on to rewrite the whole thing from scratch. Now it's leaner, cleaner and with the same and double extra more unit tests.

#Added

  • ✨ An even smarter algorithm, now being able to detect missing opening bracket on a tag, for example. Even latest Chrome v.66 can't do that.
  • ✨ Increased unit test assertion count from 148 to 370. Covering even more legit and stinky code cases.
  • ✨ opts.returnRangesOnly

#1.4.0 (2018-05-11)

  • ✨ Set up Prettier
  • ✨ Removed package.lock and .editorconfig
  • ✨ Wired Rollup to remove comments from non-dev builds. It means, we can now leave the console.logs in the source code — Rollup will remove from production code.
  • ✨ Unit tests are pointing at ES modules build, which means that code coverage is correct now, without Babel functions being missed

#1.3.0 (2018-02-19)

  • ✨ Now strips HTML comments too.

#1.2.0 (2017-12-31)

  • ✨ Improvements to opts.stripTogetherWithTheirContents and done a lot of rebasing.

#1.1.0 (2017-12-07)

  • ✨ Add opts.stripTogetherWithTheirContents

#1.0.0 (2017-11-27)

  • ✨ First public release