stealjs/steal

Improve warning when dependency versions conflict

Open

#1,391 opened on May 4, 2018

View on GitHub
 (0 comments) (1 reaction) (0 assignees)JavaScript (1,367 stars) (574 forks)batch import
error messageshelp wanted

Description

Below is a warning @eben-roux came across when using can-validate-validatejs: https://gitter.im/canjs/canjs?at=5aec8531da323a7c04f8b333

warning

The issue was that he had validate.js 0.12 installed in his project but can-validate-validatejs needed ^0.11.1

From the info provided in the warning, it seems like steal could maybe detect this scenario and offer a better warning. An idea that needs some work:

Multiple versions of the module with address ~/node_modules/validate.js/validate.js are being imported.

Modules:
  validate.js@0.12.0#validate
    - ~/src/main.js
  validate.js@0.11.1#validate
    - can-validate-validatejs

HINT: Check the semver ranges of your project and its dependencies.
Learn more at https://stealjs.com/docs/StealJS.error-messages.html#multiple-versions

Contributor guide

Tech stack
javascript
Domain
toolingbuild system
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-2 days
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.
mostly clear
Prerequisites
JavaScriptnpm semver
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Look at the current warning output in steal's source code, likely in a module that detects multiple versions. Identify where the warning message is generated and modify it to include the module addresses and semver ranges as suggested in the issue. Check the existing error message format and ensure the new warning provides hints for resolving version conflicts.
Improve warning when dependency versions conflict · stealjs/steal#1391 | Good First Issue