Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't recommend installing gulp-cli globally in the README and on the website #18247

Merged
merged 1 commit into from
Jun 14, 2024

Conversation

timvandermeij
Copy link
Contributor

@timvandermeij timvandermeij commented Jun 14, 2024

It's recommended to always install dependencies locally in the project folder because global dependencies can easily conflict with other projects and, because they are not managed by the project, diverge from versions defined in e.g. package.json. Previously we installed gulp-cli globally because at the time we lacked a convenient mechanism to use Gulp otherwise, but nowadays NPM provides the npx command for that purpose and recommends using it over global installations (see https://docs.npmjs.com/downloading-and-installing-packages-globally and PR #17489 that provided the ground work for using it).

This commit therefore updates our README and website to no longer recommend installing gulp-cli globally but instead installing it locally from the already existing entries in package.json like all other dependencies we use. Not only does this remove the special-casing for gulp-cli which simplifies the installation procedure, it also ensures that the version ranges provided in package.json are respected.

This change is similar to the change in commit 92de2b7.

Fixes #18232.
Fixes 98ef8a1.

This should be final patch in the npx usage series, after the previous patches and updating all wiki pages. I somehow missed these occurrences before, but a new search didn't yield other occurrences anymore.

…he website

It's recommended to always install dependencies locally in the project
folder because global dependencies can easily conflict with other
projects and, because they are not managed by the project, diverge from
versions defined in e.g. `package.json`. Previously we installed
`gulp-cli` globally because at the time we lacked a convenient mechanism
to use Gulp otherwise, but nowadays NPM provides the `npx` command for
that purpose and recommends using it over global installations (see
https://docs.npmjs.com/downloading-and-installing-packages-globally
and PR mozilla#17489 that provided the ground work for using it).

This commit therefore updates our README and website to no longer recommend
installing `gulp-cli` globally but instead installing it locally from the
already existing entries in `package.json` like all other dependencies
we use. Not only does this remove the special-casing for `gulp-cli`
which simplifies the installation procedure, it also ensures that the
version ranges provided in `package.json` are respected.

This change is similar to the change in commit 92de2b7.

Fixes mozilla#18232.
Fixes 98ef8a1.
@timvandermeij timvandermeij changed the title Don't recommend installing gulp-cli globally in the README Don't recommend installing gulp-cli globally in the README and on the website Jun 14, 2024
Copy link
Contributor

@calixteman calixteman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unsupported gulp version
2 participants