## :notebook_with_decorative_cover: Table of Contents
- [Package Details](#star2-package-details)
- [Usage](#eyes-usage)
- [Run Locally](#running-run-locally)
- [Roadmap](#dart-roadmap)
- [Contributing](#wave-contributing)
- [License](#warning-license)
- [Support](#sos-support)
## :star2: Package Details
A basic logger utility for Figmarine packages. Currently does nothing special. It's only used to ensure logging is centralised for future journaling needs.
## :eyes: Usage
Install the package with the following command:
```bash
pnpm i @figmarine/logger
```
Then, import the logging utility you want to use:
```javascript
import { log } from '@figmarine/logger';
log('My message');
```
## :running: Run Locally
Clone the project
```bash
git clone https://github.com/Sidnioulz/figmarine.git
```
Go to the project directory
```bash
cd packages/logger
```
Install dependencies
```bash
pnpm install
```
Build the code as you make changes
```bash
pnpm dev
```
Check that tests run as you make changes
```bash
pnpm test:dev
```
## :dart: Roadmap
- [ ] Add log levels (error, warn, info, debug)
- [ ] Automate caller identification
- [ ] Switch to template literal format and auto-colour params with chalk
- [ ] Add unit tests for log levels
## :wave: Contributing
See [how to contribute](https://github.com/Sidnioulz/figmarine/tree/main?tab=readme-ov-file#package-contributing).
## :warning: License
Distributed under the [MIT License](https://github.com/Sidnioulz/figmarine/tree/main?tab=MIT-1-ov-file).
## :sos: Support
Please open a conversation in the [discussion space](https://github.com/Sidnioulz/figmarine/discussions) to ask a question.
Please [open an issue](https://github.com/Sidnioulz/figmarine/issues/new?labels=pkg-logger) for bug reports or code suggestions.
