# wbb-logger

> A wrapper around basic-logger

Latest version **1.1.0** (published 2020-04-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install wbb-logger
pnpm add wbb-logger
yarn add wbb-logger
bun add wbb-logger
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2020-04-07 |
| First published | 2020-03-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 17.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | webuildbots |

## Links

- npm: https://www.npmjs.com/package/wbb-logger
- npm.io page: https://npm.io/package/wbb-logger

## Dependencies (4)

- [basic-logger](https://npm.io/package/basic-logger.md) ^0.4.4
- [@sentry/types](https://npm.io/package/@sentry/types.md) ^5.15.4
- [@sentry/utils](https://npm.io/package/@sentry/utils.md) ^5.15.4
- [circular-json](https://npm.io/package/circular-json.md) ^0.5.9

## Recent versions

- 1.1.0 (latest) — 2020-04-07
- 1.0.0 — 2020-03-03

## README

#WBB Logger

## Installation

```bash
npm install wbb-logger
```

## Usage

```typescript
import Logger from 'wbb-logger';

const logger = new Logger('example-file.ts');

logger.info('info');
logger.debug('debug');
logger.warn('warning');
logger.error(new Error('example'));
logger.trace('trace');
```

## Sentry Integration Usage

```typescript
import {WBBLoggerSentryIntegration} from 'wbb-logger';
import * as Sentry from '@sentry/node';

Sentry.init({
  dsn: '',
  integrations: [
    new WBBLoggerSentryIntegration(), // <--
  ],
});
```

## How to create a release

### 1. Commit all changes

Run `$ git status` and make sure you have no uncommitted changes

### 2. Run Build

This command builds the source into the folder `dist`

```
$ npm run build
```

### 3. Update version number

update version number using semantic versioning release types (patch, major, or minor)
e.g.

```
$ npm version patch
```

### 4. Login to npm

```
$ npm login
```

### 5. Publish npm

```
$ npm publish
```

### 6. Create a new branch `dist`

```
$ git checkout -b dist
```

### 7. Push dist to origin

```
$ git push origin dist
```

### 8. Create a pull request

Create a pull request to merge `origin/dist` --> `upstream/master`
Use version number as pull request title.

### 9. Push tags to upstream

```
$ git push upstream --tags
```

---
_Source: https://npm.io/package/wbb-logger · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._