# pull-lock

> Automate tasks that happen when you pull in new code.

Latest version **1.0.0** (published 2019-02-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install pull-lock
pnpm add pull-lock
yarn add pull-lock
bun add pull-lock
```

Provides the command `pull-lock`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-02-25 |
| First published | 2019-01-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 12.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Orta Therox & Xtina-starr |
| Maintainers | orta |

## Links

- npm: https://www.npmjs.com/package/pull-lock
- npm.io page: https://npm.io/package/pull-lock

## Dependencies (3)

- [debug](https://npm.io/package/debug.md) ^4.1.1
- [execa](https://npm.io/package/execa.md) ^1.0.0
- [cosmiconfig](https://npm.io/package/cosmiconfig.md) ^5.1.0

## Recent versions

- 1.0.0 (latest) — 2019-02-25
- 0.0.1 — 2019-01-25

## README

# Pull Lock

Automate tasks that happen when you pull in new code.

```json
{
  "husky": {
    "hooks": {
      "post-merge": "pull-lock"
    }
  },
  "pull-lock": {
    "yarn.lock": "yarn install",
    "Example/Podfile.lock": ["cd Example", "bundle exec pod install"]
  }
}
```

Like [lint-staged](https://github.com/okonet/lint-staged) for when you've `git pull`ed. You set up a 
[husky](https://github.com/typicode/husky) `"post-merge"` hook which runs the CLI tool `pull-lock`. 

`pull-lock` will then compare the changed files to the config and execute commands for you automatically. 

Pull Lock only uses dependencies which Husky also uses, and so it adds no new dependencies to your tree.

## Installation and setup

1. `yarn add --dev pull-lock husky`
1. Update your `package.json` like this:

```diff json
{
  "husky": {
    "hooks": {
+     "post-merge": "pull-lock"
    }
  },
+ "pull-lock": {
+   "yarn.lock": "yarn install",
+ }
}
```

Then when you run a `git pull` or `git merge`, `pull-lock` will check to see if `yarn.lock` has changed the 
diffed files and run the scripts inside your config files.

In the case above, if someone has made dependency changes which edit the `yarn.lock` then `yarn install` will
be called automatically for you.

## Advanced config

As pull-lock uses [cosmic-config](https://github.com/davidtheclark/cosmiconfig) you can leave your app
settings in either:

* a `pull-lock` object in your `package.json`
* a `.pulllockrc` file in JSON or YML format
* a `pull-lock.config.js` file in JS format

 
## Working on Pull Lock

```sh
# clone it
git clone https://github.com/orta/pull-lock.git
cd pull-lock

# set up deps
yarn
# verify tests
yarn jest
# Run the integration scripts to see it on a merge and on a pull
yarn integrate:pull
# or
yarn integrate:merge
```

---
_Source: https://npm.io/package/pull-lock · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._