stristri^3.1.6

Extracts or deletes HTML, CSS, text and/or templating tags from string

Install via npm

npm i stristri

Consume via a require():

const { stri } = require("stristri");

or as an ES Module:

import { stri } from "stristri";

Install as a script, via CDN

Put this in your HTML:

<script src="https://cdn.jsdelivr.net/npm/stristri/dist/stristri.umd.js"></script>

Then, you’ll get a global variable stristri in your Global object and you consume it like this:

const { stri } = stristri;

Trivia

This program has 3,359 assertions in its unit tests. That's more than all unit test assertions' median (44) and more than geometric mean (72).

§ Quick Take

import { strict as assert } from "assert";
import { stri } from "stristri";

// strips both HTML and Nunjucks, leaves text only:
assert.equal(
  stri(
    `<html><div>The price is{% if data.price > 100 %} high{% endif %}</div>`,
    {
      html: true,
      css: true,
      text: false,
      templatingTags: true,
    }
  ).result,
  "The price is high"
);

⬆ back to top

§ Features

Pick what to strip: HTML and/or CSS and/or text and/or templating tags
Supports well: Nunjucks/Jinja, JSP, Responsys
Should support all other templating languages and ESP templating tags
Runs off our own lexer

PS. We have string-strip-html which also strips HTML. It can't do CSS, text or templating tags but it has more granular control over the whitespace. Also, it's non-parsing so more resilient to really messed up code.

⬆ back to top

§ API - Input

stri(input, [opts])

In other words, it's a function which takes a string and an optional options.

Input argument	Type	Obligatory?	Description
`input`	String	yes	Text you want to strip HTML tags from
`opts`	Plain object	no	The Optional Options Object, see below for its API

If input arguments are supplied have any other types, an error will be thrown.

⬆ back to top

§ API - Output

The stri() function will return a plain object, for example:

{
  log: {
    timeTakenInMilliseconds: 23
  },
  result: "abc click me def",
  applicableOpts: {
    html: true,
    css: false,
    text: true,
    templatingTags: false,
    js: false,
  },
  templatingLang: {
    name: "Nunjucks"
  }
}

Here is its API:

Key's name	Key value's type	Description
`log`	Plain object	Various statistics
`result`	String	The result.
`applicableOpts`	Plain object, only boolean keys from `opts`	Tells which options object keys would have made a difference for this string input, if toggled differently
`templatingLang`	Plain object	Pipes the output of `detect-templating-language`

⬆ back to top

§ Optional Options Object

opts is a plain object. Here are all its keys:

An Optional Options Object's key	Type of its value	Default	Description
`html`	Boolean	`true`	Should we strip HTML, XML tags and their comments
`css`	Boolean	`true`	Should we strip head CSS style tags, CSS rules and ar-rules inside
`text`	Boolean	`false`	Should we strip text
`templatingTags`	Boolean	`false`	Should we strip any templating tags (like Nunjucks)
`js`	Boolean	`true`	Should we strip any JS code
`reportProgressFunc`	`null` or Function	`null`	Pass a function, progress value, `0`-`100` will be passed to it
`reportProgressFuncFrom`	Natural number [0; 100]	`0`	Starting progress percentage
`reportProgressFuncTo`	Natural number [0; 100]	`100`	Ending progress percentage

The Optional Options Object is not validated; please take care of what values and of what type you pass.

Here is the Optional Options Object in one place (in case you ever want to copy it whole):

{
  html: true,
  css: true,
  text: false,
  templatingTags: false,
  js: true,
  reportProgressFunc: null,
  reportProgressFuncFrom: 0,
  reportProgressFuncTo: 100,
}