Common utilities for team eureka

@team_eureka/common-utils-plugin Common utilities for team eureka.

Installation

To get started just install the dependencies using Yarn or the npm client.

# always check for updates ^^
npm install eureka-plugins && \
# install the plugin
npm install @team_eureka/common-utils-plugin

Usage and documentation

import CommonUtilsPlugin from '@team_eureka/common-utils-plugin';

subscriber.boot((): void => {
  // Always execute a method plugin after the hydration process ^^.
  const manifiest = CommonUtilsPlugin.getManifiest();
  console.log(manifiest);
});

Notes: Remember that the only class which need to be imported is the manifiest, which have all the available methods.

The code documentation for the plugin is here.

Gulp tasks

We use gulp as a task runner for a bunch of useful process, like for example:

• "validate": Some validation stuff like linting and things like that.
• "docs": Generate the doc's and Readme.md dinamycally.
• "build": Transpile the code from Typescript to Javascript.
• "run": Run the code with nodemon to track the changes for ts files in the mocks folder.
• "publish": Publish the code (bump version and tagged), also build the Readme.md.

An example of running the validate task is easy as running the following command in your terminal:

# validate project
gulp validate

Plugin Manifiest

| package | plugin | version | latest build | | --- | --- | --- | --- | | @team_eureka/common-utils-plugin | CommonUtilsPlugin | 1.0.0 | 2022-05-26T15:34:11.427Z |

Dependencies

| name | description | type | required | default | | --- | --- | --- | --- | --- | | WEBHOOK_REPORT_URL | Webhook URL | string | true | | | WEBHOOK_REPORT_AVATAR | Webhook avatar url (optional) | string | false | |