micro-analytics/micro-analytics-cli

Add debugging information output

Open

#18 opened on Jan 12, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (738 stars) (52 forks)batch import
enhancementhelp wanted

Description

Lots of useful information can be logged out to the user but that should only be provided in the debugging context. So, allow for a --debug option that will allow writes out. Have the services modules point to a reusable logging component. On init, we will tell that logging component if it should echo out the proceeding logs to the console.

Contributor guide

Tech stack
javascriptnodejs
Domain
cli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Node.js knowledgeunderstanding of command line flags
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Look at main entry point (likely index.js or bin/cli.js) to understand how options are parsed. Implement a debug flag using a library like yargs or commander. Create a reusable logging module that conditionally outputs to console based on debug flag. Integrate into existing service modules to replace direct console.log calls.