scapegoat

A small library providing utility methods to escape and unescape HTML entities

Usage no npm install needed!

<script type="module">
  import scapegoat from 'https://cdn.skypack.dev/scapegoat';
</script>

README

Scapegoat

A minimal node module providing utility methods to escape and unescape HTML entities

See the associated blog post, "Creating and publishing a node.js module."

Installation

  npm install scapegoat --save

Usage

  var scapegoat = require('scapegoat')
      escape = scapegoat.escape,
      unescape = scapegoat.unescape;

  var html = '<h1>Hello World</h1>',
      escaped = escape(html),
      unescaped = unescape(escaped);

  console.log('html', html, 'escaped', escaped, 'unescaped', unescaped);

Tests

   npm test

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

Release History

  • 1.0.0 Refactor to avoid double unescape and to use npm scripts instead of makefile. Also add link to associated blog post.
  • 0.1.0 Initial release