@exmg/lit-helpers v2.0.2

Exmg Lit Utils @exmg/lit-helpers

Content

• Links
• Features
• Setup
• Development
• Usage

Links

Repository

NPM Page

Features

The LitHelpers package provides helper functions for diverse purpose to implement throughout CMSs

• Sentry

Setup

git clone the project, then simply run npm i

💡 Your NPM CLI must be connected to an authorized NPM account on @exmg namespace in NPM. To do so, please follow the instructions.

Development

The development process takes place on dedicated feature or fix branches. Each branch is then merged into master branch.

Please refer to the naming conventions for branches in the good practices section.

Usage

Sentry

initSentry function creates an instance of the CMS on Sentry allowing developers and PMs to follow bugs on production environments

See Exmg Sentry Page

Two possible usage, the default one that will report bug on the default project playtwo-cms

initSentry();

The configured usage will create a new "project" on Sentry to repot bug for a specific CMS :

initSentry({
  release: 'custom-cms',
  environment: 'production',
});

The Sentry function can be further configured :

export interface SentryConfig {
  release: string; // Name of the project on Sentry
  environment: string; // Type of the environment
  dsn: string; // Sentry key
  attachStacktrace: boolean; // Wether or not attaching the stack trace to the bug report
}