:notebook_with_decorative_cover: Table of Contents

• Package Details
• Usage
• Run Locally
• Roadmap
• Contributing
• License
• 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:

 pnpm i @figmarine/logger

Then, import the logging utility you want to use:

import { log } from '@figmarine/logger';

log('My message');

:running: Run Locally

Clone the project

  git clone https://github.com/Sidnioulz/figmarine.git

Go to the project directory

  cd packages/logger

Install dependencies

  pnpm install

Build the code as you make changes

  pnpm dev

Check that tests run as you make changes

  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.

:warning: License

Distributed under the MIT License.

:sos: Support

Please open a conversation in the discussion space to ask a question.

Please open an issue for bug reports or code suggestions.