aws-cli-util-logger

!npm packagenpm-imgnpm-url !Build Statusbuild-imgbuild-url !Downloadsdownloads-imgdownloads-url !Issuesissues-imgissues-url !Code Coveragecodecov-imgcodecov-url !Commitizen Friendlycommitizen-imgcommitizen-url !Semantic Releasesemantic-release-imgsemantic-release-url

Lightweight logger for use in CLI utilities for AWS

This is the logger I use in my AWS related command line utils (i.e. aws-sso-creds-helpersso-creds-helper-url).

Install

npm install aws-cli-util-logger

Usage

import { AwsCliUtilLogger } from 'aws-cli-util-logger';

const logger = new AwsCliUtilLogger({
  packageName: 'aws-sso-creds-helper',
});

logger.logSystemInfo('sso');
/*










      ----                    -----             ----    --------
   profile                      sso           manual    --profile
access_key     ****************ZABC              sso
secret_key     ****************5ABC              sso
    region                us-east-1      config-file    ~/.aws/config
*/

API

AwsCliUtilLogger(options)

options

Type: object

packageName

Type: string
Name of the npm package.

binCommand

Type: string
Name of the bin command.

verbose

Type: boolean
Enables verbose logging.

disabled

Type: boolean
When true, disables ALL logging output

debugFlag

Type: string
Default: '--debug'
Debug flag for your CLI.

instanceof AwsCliUtilLogger

handleError(error, debug?)

error

Type: Error
Error to log and generate a stack trace for.

debug

Type: boolean
When false, a log message instructing the user to run the binCommand with your debugFlag set for additional info.

logSystemInfo(profile)

Logs various system information including the AWS CLI version and the AWS CLI profile configuration.

profile

Type: string
Default: 'default'
The name of the AWS profile to get system info for.

success(...messages)

info(...messages)

warn(...messages)

error(...messages)

debug(...messages)

log(...messages)

messages

Type: string
Log messages passed to console log methods.