solace-connector

Purpose

This project is used by the message-bridge as a library and allows the message bridge to send and consume messages from Solace.

Environment vars

This project uses the following environment variables:

| Name | Description | Required |Default Value | Accepted Values | --- | --- | --- | --- | --- |NODE_ENV | Environment | Yes | DEV | DEV, TEST, PROD

Pre-requisites

• Install Node.js version 16 or greater

Getting started

Initialize and start application

This project is used as a library in the message-bridge so once you build a new npm version of this project you must go into the message-bridge and upgrade the version there and then deploy/run that project.

## Project Structure
The folder structure of this app is explained below:

| Name | Description |
| ------------------------ | --------------------------------------------------------------------------------------------- |
| **\_\_mocks\_\_**        | Contains jest mocks                                                                           |
| **\_\_tests\_\_**        | Contains jest tests                                                                           |
| **config**                | Application configuration including environment-specific configs                                 |
| **src**                  | Contains source code                                                                          |
| **helpers**              | Contains code to do a test publish                                                                          |
| **src**/index.js         | Entry point to the application                                                                    |
| .gitignore               | List of files and directories for Git to ignore                                                |
| jest.config.js            | Configuration options for Jest                                                                 |
| .eslintrc                | Configuration options for ES Lint
| .prettierrc              | Configuration options for prettier                                                             |
| package.json             | Contains npm dependencies as well as build scripts                                            |
| .prettierignore          | List of files and directories for prettier to ignore                                           |
| cx.config                 | File needed for common pipeline to pass                                                       |
| yarn.lock                | Yarn state snapshot                                                                           |
| .gitlab-ci.yml           | CI pipeline configuration                                                                      |
| **node_modules**         | Contains package dependencies                                                                |

## Testing

### Running tests using yarn Scripts

yarn test

# ESLint
ESLint is a code linter that helps catch minor code quality and style issues.

## ESLint rules
All rules are configured through `.eslintrc`.

## Running ESLint
To run ESLint you can call the ESLint task.
```
yarn lint  // runs only ES lint
```