WordPress/gutenberg

Scripts: Enhance check-engines to consider "latest" versions

Open

#14201 opened on Mar 1, 2019

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (9,607 stars) (3,893 forks)batch import
Good First IssueNeeds Dev[Tool] WP Scripts[Type] Enhancement

Description

Previously: #12721 Related: https://github.com/WordPress/gutenberg/pull/14192#issuecomment-468732835

Currently, wp-scripts check-engines is hard-coded to default to Node >=10.0.0 and npm >=6.0.0:

https://github.com/WordPress/gutenberg/blob/62f81e10f92a1ec2bdd71c4fe0e249c1e5cb8ccd/packages/scripts/scripts/check-engines.js#L23-L24

This doesn't faithfully represent the versions Gutenberg expects, which are respectively "latest Node LTS" and "latest npm version"

You should be running a Node version matching the current active LTS release or newer for this plugin to work correctly.

You also should have the latest release of npm installed.

https://github.com/WordPress/gutenberg/blob/master/CONTRIBUTING.md#getting-started

If the check-engines script is intended to adhere to this recommendation, it should ideally do so in a way which doesn't require manual updates.

It does not appear that the underlying check-node-version project supports this, but perhaps part of the script can be to retrieve the latest versions information.

cc @gziolo @ntwb @adamsilverstein

Contributor guide

Tech stack
nodejsjavascript
Domain
developer experiencetooling
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
Node.jsnpm registry API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Modify the 'check engines.js' script (packages/scripts/scripts/check engines.js) to fetch the latest version of npm from the npm registry API (https://registry.npmjs.org/npm) and the current Node.js LTS version from the Node.js dist index (https://nodejs.org/dist/index.json) by filtering for the latest LTS codename. The script should dynamically use these versions instead of the hard coded defaults. The underlying 'check node version' library does not support this, so custom retrieval logic is needed.