Nuclear Planning Manual

    @halokit/reporter
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0 • Public • Published

    @halokit/reporter

    A terminal reporting utility with logging capabilities.

    Contents

    Getting started

    To install @halokit/reporter in your project, you will need to run the following command using npm:

    npm install -S @halokit/reporter

    If you prefer yarn, use the following command instead:

    yarn add @halokit/reporter

    Usage

    Importing

    This module can be imported and used by doing the following in your code:

    // ES6 Module
    import { reporter, emojiReporter } from '@halokit/reporter';
    
    // CommonJS Module
    const { reporter, emojiReporter } = require('@halokit/reporter');

    All the modules have TypeScript type definitions built in. There is no need to install additional packages.

    Creating a logging item

    HaloKit's reporter relies on a specific object format that should have at least the following properties:

    var item = {
      content: 'Hello world!',
      level: 1 // 0 - 6
    }

    If you are using typescript, you can use the interface LogItem to build objects, as defined here:

    interface LogItem {
      content: string;
      level: LogLevel;
      print?: boolean;
    }

    The print property will determine whether the built log entry should be redirected to standard output aswell, and defaults to false.

    Where the available log levels are:

    export enum LogLevel {
      Log = 0,
      Debug = 1,
      Info = 2,
      Warn = 3,
      Error = 4,
      Fatal = 5,
      Success = 6
    }

    You can use the enum name or it's integer representation.

    Logging the item

    Once you have your loggable item created, you can generate a log/reporting entry out of it by using the reporter of your choice.

    This package exports both a reporter and an emojiReporter. If you decide to use the emoji reporter, an emoji, representative of each level, with be added at the beginning of each logging entry.

    A working example would be as follows:

    import { reporter, emojiReporter } from '@halokit/reporter';
    
    const item = {
      content: 'Hello world!',
      level: 1
    }
    
    const plainLog = reporter.report(item); // debug: Hello world!
    const emojiLog = emojiReporter.report(item); // 🛠  debug: Hello world!

    Once you've called the report() method, another object will be returned with the following properties:

    {
      content: string; // Built log .
      technical: string; // Plain log, without any emojis or coloring.
      raw: string; // Plain log with emojis, but no coloring.
      timestamp: string; // Time of creation of the log.
    }

    Contributing

    We're always looking for contributors to help us fix bugs, build new features, or help us improve the project documentation.

    License

    This module is licensed under the Apache 2.0 License.

    Install

    npm i @halokit/reporter

    DownloadsWeekly Downloads

    4

    Version

    1.0.0

    License

    Apache-2.0

    Unpacked Size

    16.7 kB

    Total Files

    10

    Last publish

    Collaborators

    • azaeldragon