tleunen/babel-plugin-module-resolver

Document in README.md how to debug/print search path

Open

#187 opened on May 25, 2017

View on GitHub
 (1 comment) (3 reactions) (0 assignees)JavaScript (3,417 stars) (217 forks)batch import
enhancementhelp wanted

Description

The readme describes basic usage, but when the basic setup doesn't work, it's hard to know what to do.

There should be some command to run in order to test a simple import and get the search path printed, next steps in order to debug and/or similar.

Contributor guide

Tech stack
javascriptnodejs
Domain
documentationdeveloper experience
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Review the current README.md in the repository to understand the existing basic usage section. Look at the plugin's source code (e.g., src/index.js) to identify how the search path is resolved and printed. Consider adding a dedicated debugging section with commands like `node e "require('babel plugin module resolver')"` or using an environment variable to log search path. Check if any existing issues or pull requests discuss debugging (e.g., issue #187 itself has a comment with suggestions). Write clear steps for common debugging scenarios.