Simple email application for Android. Original source code: https://framagit.org/dystopia-project/simple-email
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

77 lines
1.9 KiB

  1. .TH "NPM\-CI" "1" "August 2018" "" ""
  2. .SH "NAME"
  3. \fBnpm-ci\fR \- Install a project with a clean slate
  4. .SH SYNOPSIS
  5. .P
  6. .RS 2
  7. .nf
  8. npm ci
  9. .fi
  10. .RE
  11. .SH EXAMPLE
  12. .P
  13. Make sure you have a package\-lock and an up\-to\-date install:
  14. .P
  15. .RS 2
  16. .nf
  17. $ cd \./my/npm/project
  18. $ npm install
  19. added 154 packages in 10s
  20. $ ls | grep package\-lock
  21. .fi
  22. .RE
  23. .P
  24. Run \fBnpm ci\fP in that project
  25. .P
  26. .RS 2
  27. .nf
  28. $ npm ci
  29. added 154 packages in 5s
  30. .fi
  31. .RE
  32. .P
  33. Configure Travis to build using \fBnpm ci\fP instead of \fBnpm install\fP:
  34. .P
  35. .RS 2
  36. .nf
  37. # \.travis\.yml
  38. install:
  39. \- npm ci
  40. # keep the npm cache around to speed up installs
  41. cache:
  42. directories:
  43. \- "$HOME/\.npm"
  44. .fi
  45. .RE
  46. .SH DESCRIPTION
  47. .P
  48. This command is similar to npm help \fBnpm\-install\fP, except it's meant to be used in
  49. automated environments such as test platforms, continuous integration, and
  50. deployment\. It can be significantly faster than a regular npm install by
  51. skipping certain user\-oriented features\. It is also more strict than a regular
  52. install, which can help catch errors or inconsistencies caused by the
  53. incrementally\-installed local environments of most npm users\.
  54. .P
  55. In short, the main differences between using \fBnpm install\fP and \fBnpm ci\fP are:
  56. .RS 0
  57. .IP \(bu 2
  58. The project \fBmust\fR have an existing \fBpackage\-lock\.json\fP or \fBnpm\-shrinkwrap\.json\fP\|\.
  59. .IP \(bu 2
  60. If dependencies in the package lock do not match those in \fBpackage\.json\fP, \fBnpm ci\fP will exit with an error, instead of updating the package lock\.
  61. .IP \(bu 2
  62. \fBnpm ci\fP can only install entire projects at a time: individual dependencies cannot be added with this command\.
  63. .IP \(bu 2
  64. If a \fBnode_modules\fP is already present, it will be automatically removed before \fBnpm ci\fP begins its install\.
  65. .IP \(bu 2
  66. It will never write to \fBpackage\.json\fP or any of the package\-locks: installs are essentially frozen\.
  67. .RE
  68. .SH SEE ALSO
  69. .RS 0
  70. .IP \(bu 2
  71. npm help install
  72. .IP \(bu 2
  73. npm help 5 package\-locks
  74. .RE