This repository has been archived by the owner on Aug 17, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(cli): splitting off CLI into a separate tool
BREAKING CHANGE: libcipm is its own library now,
- Loading branch information
Showing
14 changed files
with
642 additions
and
116 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| /node_modules | ||
| /bin/node_modules | ||
| /.nyc_output | ||
| /test/cache |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,37 @@ | ||
| [](https://npm.im/cipm) [](https://npm.im/cipm) [](https://travis-ci.org/zkat/cipm) [](https://ci.appveyor.com/project/zkat/cipm) [](https://coveralls.io/github/zkat/cipm?branch=latest) | ||
| [](https://npm.im/libcipm) [](https://npm.im/libcipm) [](https://travis-ci.org/zkat/cipm) [](https://ci.appveyor.com/project/zkat/cipm) [](https://coveralls.io/github/zkat/cipm?branch=latest) | ||
|
|
||
| ## NOTE: this project is under active development. Please don't use it yet. | ||
| [`libcipm`](https://github.com/zkat/cipm) installs npm projects in a way that's | ||
| optimized for continuous integration/deployment/etc scenarios. It gives up | ||
| the ability to build its own trees or install packages individually, as well | ||
| as other user-oriented features, in exchange for speed, and being more strict | ||
| about project state. | ||
|
|
||
| # cipm(1) -- install npm dependencies from a package lock | ||
| For documentation about the associated command-line tool, see | ||
| [`cipm`](https://npm.im/cipm). | ||
|
|
||
| ## SYNOPSIS | ||
| ## Install | ||
|
|
||
| `cipm [--userconfig <path>] [--ignore-scripts] [--offline] [--loglevel <level>]` | ||
| `$ npm install libcipm` | ||
|
|
||
| ## INSTALL | ||
| ## Table of Contents | ||
|
|
||
| `npm install [-g|-D] cipm` | ||
| * [Features](#features) | ||
| * [Contributing](#contributing) | ||
| * [API](#api) | ||
|
|
||
| ## DESCRIPTION | ||
| ### Features | ||
|
|
||
| When invoked inside an npm project with a `package.json` and `package-lock.json` (or an `npm-shrinkwrap.json`), it will install the specified dependencies and run their install scripts. | ||
| * npm-compatible project installation | ||
| * lifecycle script support | ||
| * blazing fast | ||
| * npm-compatible caching | ||
| * errors if `package.json` and `package-lock.json` are out of sync, instead of fixing it like npm does. Essentially provides a `--frozen` install. | ||
|
|
||
| The main difference between this and `npm install` is that `cipm` is both a small, standalone program, and that it can bypass a lot of the heavier machinery in npm oriented towards interacting with invalid states: `cipm` completely removes `node_modules` before beginning the install, if it exists. | ||
| ### Contributing | ||
|
|
||
| `cipm` also requires that the current project have an existing lockfile, which must first be generated using `npm install` in `npm@5` or later versions (or any other package manager supporting `lockfileVersion@>=1`). | ||
|
|
||
| This tool is ideal for using in CI environments that require regular, full installs of an application, but that are usually able to cache package data in a central cache. | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ## AUTHOR | ||
|
|
||
| Written by [Kat Marchan](https://github.com/zkat). | ||
|
|
||
| ## REPORTING BUGS | ||
|
|
||
| Please file any relevant issues [on Github.](https://github.com/zkat/cipm) | ||
|
|
||
| ## LICENSE | ||
|
|
||
| This work is released under the conditions of the MIT license. See LICENSE.md for more details. | ||
|
|
||
| ## SEE ALSO | ||
|
|
||
| * `npm-install(1)` | ||
| * `npm-package-locks(5)` | ||
| * `package-lock.json(5)` | ||
| The libcipm team enthusiastically welcomes contributions and project | ||
| participation! There's a bunch of things you can do if you want to contribute! | ||
| The [Contributor Guide](CONTRIBUTING.md) has all the information you need for | ||
| everything from reporting bugs to contributing entire new features. Please don't | ||
| hesitate to jump in if you'd like to, or even ask us questions if something | ||
| isn't clear. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| /node_modules | ||
| /.nyc_output | ||
| /test/cache |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| Copyright 2017 Kat Marchán and Contributors | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| [](https://npm.im/cipm) [](https://npm.im/cipm) [](https://travis-ci.org/zkat/cipm) [](https://ci.appveyor.com/project/zkat/cipm) [](https://coveralls.io/github/zkat/cipm?branch=latest) | ||
|
|
||
| ## NOTE: this project is under active development. Please don't use it yet. | ||
|
|
||
| # cipm(1) -- install npm dependencies from a package lock | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| `cipm [--userconfig <path>] [--ignore-scripts] [--offline] [--loglevel <level>]` | ||
|
|
||
| ## INSTALL | ||
|
|
||
| `npm install [-g|-D] cipm` | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| When invoked inside an npm project with a `package.json` and `package-lock.json` (or an `npm-shrinkwrap.json`), it will install the specified dependencies and run their install scripts. | ||
|
|
||
| The main difference between this and `npm install` is that `cipm` is both a small, standalone program, and that it can bypass a lot of the heavier machinery in npm oriented towards interacting with invalid states: `cipm` completely removes `node_modules` before beginning the install, if it exists. | ||
|
|
||
| `cipm` also requires that the current project have an existing lockfile, which must first be generated using `npm install` in `npm@5` or later versions (or any other package manager supporting `lockfileVersion@>=1`). | ||
|
|
||
| This tool is ideal for using in CI environments that require regular, full installs of an application, but that are usually able to cache package data in a central cache. | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ## AUTHOR | ||
|
|
||
| Written by [Kat Marchan](https://github.com/zkat). | ||
|
|
||
| ## REPORTING BUGS | ||
|
|
||
| Please file any relevant issues [on Github.](https://github.com/zkat/cipm) | ||
|
|
||
| ## LICENSE | ||
|
|
||
| This work is released under the conditions of the MIT license. See LICENSE.md for more details. | ||
|
|
||
| ## SEE ALSO | ||
|
|
||
| * `npm-install(1)` | ||
| * `npm-package-locks(5)` | ||
| * `package-lock.json(5)` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.