Commversion public facing libraries

A set of Commversion's public facing scripts and utilities.

Installation & Configuration

The library is distributed as a public facing npm package.

The recommended way to install this on a website is through JsDelivr.com.

<script src="https://cdn.jsdelivr.net/npm/@commversion/libs@0.0.1-alpha.1/dist/schedule-event.js"></script>

Configuration

Configuration takes place by global window.commversion object, make sure to not overwrite it if it already exists!

<script>
  window.commversion = window.commversion || {};
  window.commversion.someProperty = true;
</script>

Available scripts

All scripts are available under the scripts/ directory.

• schedule-event
• lc-pause-on-url
• lc-kill-chat-persist
• lc-gclid
• lc-powered-by
• lc-ga-initialize-event
• lc-exit-intent
• lc-ga-tags
• lc-input-errors
• lc-show-hide
• lc-kill-chat
• lc-form-abandonment
• lc-form-submission
• lc-experiment
• lc-gtm
• lc-device
• lc-geoblocking
• lc-utm-params

Release new versions

Important This project uses the npm.js public registry. Before trying to do any release, make sure you are logged with npm as Commversion. The quickest way to do that, is to create a .npmrc file in the project directly and insert the following:

//registry.npmjs.org/:_authToken=base64_encoded_npm_token

You can test if the above works by running:

$ npm whoami
commversion       # this is the authenticated npm user

The project follows the semantic versioning convention.

Patch releases for bug fixes. Minor releases for new features. Major releases for breaking changes.

The release is fully automated by executing npm run release. No need to run build scripts beforehand, this is done automatically.

Guideline for contributing

To create a new script, run the following command in a shell.

$ npx hygen scripts new script-name

The command above will create e new script containing the absolute minimum files. It will also amend root README.md and package.json to include required entries.

Start working on a specific script by running npm run package:dev.

Finally, you can run tests by running:

$ npm test