idyll-lang/idyll

Issue with global version reporting

Open

#617 opened on Feb 26, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (1,977 stars) (97 forks)batch import
CLIRough Edgesbughelp wanted

Description

Describe the bug When running idyll --version in a directory outside of an idyll project, I see this:

$ idyll --version

  Using version undefined (installed globally).

  To install local dependencies in an Idyll project that
  you've cloned from GitHub, run `npm install`.

To Reproduce Steps to reproduce the behavior:

  1. Install the latest idyll globally (npm i -g idyll@latest)
  2. Navigate to a folder that does not contain an idyll project
  3. Run idyll --version
  4. See error

Expected behavior The correct version should be printed.

Contributor guide

Tech stack
javascriptnodejs
Domain
cli
Issue type
bug
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.
under 1 hour
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
The issue is that `idyll version` prints 'undefined' when run outside an Idyll project. The version is likely read from a local package.json, but falls back to global. Look at the CLI entry point file, e.g., bin/cli.js or similar, and see how it resolves the version. Possibly the global install's package.json path is not correctly resolved. A fix could use require('../package.json') or process.env.npm package version.