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

[DOCS] prepare hook not documented for npm ci #7159

Open
2 tasks done
EvanCarroll opened this issue Jan 19, 2024 · 0 comments
Open
2 tasks done

[DOCS] prepare hook not documented for npm ci #7159

EvanCarroll opened this issue Jan 19, 2024 · 0 comments
Labels
Documentation documentation related issue Priority 2 secondary priority issue

Comments

@EvanCarroll
Copy link

Is there an existing issue for this?

  • I have searched the existing issues

This is a CLI Docs Enhancement, not another kind of Docs Enhancement.

  • This is a CLI Docs Enhancement.

Description of Problem

The npm docs for ci state,

This command is similar to npm install, except it's meant to be used in automated environments such as test platforms, continuous integration, and deployment -- or any situation where you want to make sure you're doing a clean install of your dependencies. It can be significantly faster than a regular npm install by skipping certain user-oriented features. It is also more strict than a regular install, which can help catch errors or inconsistencies caused by the incrementally-installed local environments of most npm users.

The enumerated list of differences below do not mention the hooks run.

The documentation for prepare state,

  • Runs BEFORE the package is packed
  • Runs BEFORE the package is published
  • Runs on local npm install without any arguments
  • Run AFTER prepublish, but BEFORE prepublishOnly
  • NOTE: If a package being installed through git contains a prepare script, its dependencies and devDependencies will be installed, and the prepare script will be run, before the package is packaged and installed.

It's not clear from these two passages whether or not npm ci runs the hooks that npm install does (namely prepare in my case). It's also not clear from the docs on prepare whether or not it runs under npm ci

Potential Solution

Document hooks with respect to ci, and document prepare as working under npm ci or not.

Docs URL

No response

@EvanCarroll EvanCarroll added Documentation documentation related issue Needs Triage needs review for next steps labels Jan 19, 2024
@lukekarrys lukekarrys added Priority 2 secondary priority issue and removed Needs Triage needs review for next steps labels May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation documentation related issue Priority 2 secondary priority issue
Projects
None yet
Development

No branches or pull requests

2 participants