Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kagawagao/diff-run
run command after file reversion change, use with post-merge hook
https://github.com/kagawagao/diff-run
diff-run diffrun git git-hooks hooks huksy
Last synced: 11 days ago
JSON representation
run command after file reversion change, use with post-merge hook
- Host: GitHub
- URL: https://github.com/kagawagao/diff-run
- Owner: kagawagao
- License: mit
- Created: 2021-10-18T07:31:45.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-07T16:09:28.000Z (about 1 month ago)
- Last Synced: 2024-10-14T00:08:53.940Z (24 days ago)
- Topics: diff-run, diffrun, git, git-hooks, hooks, huksy
- Language: TypeScript
- Homepage:
- Size: 1.96 MB
- Stars: 10
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Diff Run
> run command after file reversion change, use with `post-merge` hook
[](https://github.com/kagawagao/diff-run/actions/workflows/build.yml)
[](https://www.npmjs.com/package/diff-run)
[](https://www.npmjs.com/package/diff-run)
[](https://www.npmjs.com/package/diff-run)
## Usage
### Install
```bash
npm i diff-run
```
### Use with [husky](https://github.com/typicode/husky)
- create `post-merge` in `husky` config directory
- add script into `post-merge`
```sh
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"
npx diff-run
```
> FYI, add `--no-auto` flag will disable auto-run
## Config
support all configurations which support by [`cosmiconfig`](https://github.com/davidtheclark/cosmiconfig)
- `diffrun` in `package.json`
```json
{
"diffrun": {
"package-lock.json": "npm ci"
}
}
```
- a JSON or YAML, extensionless "rc file", such as `.diffrunrc`
```json
{
"package-lock.json": "npm ci"
}
```
- an "rc file" with the extensions .json, .yaml, .yml, .js, or .cjs, such as `diffrunrc.json`
```json
{
"package-lock.json": "npm ci"
}
```
- a `diffrun.config.js` or `diffrun.config.cjs` CommonJS module
```javascript
module.exports = {
'package-lock.json': ['npm ci'],
}
```
config in `Array` will be executed in order. Otherwise, it will be executed concurrently
- In Order
```javascript
// this will be executed in order
module.exports = [
{
'package.json': ['npm ci'],
},
{
'.eslintrc.js': 'npx eslint .',
},
]
```
- Concurrently
```javascript
// this will be executed concurrently
module.exports = {
'package.json': ['npm ci'],
'.eslintrc.js': 'npx eslint .',
}
```