thdk / is-affected

Build optimisation tool to run commands on feature branches only if they affect files matching a given glob.

is-affected

Build optimisation tool to run commands on feature branches only if they affect files matching a given glob.

CLI

Usage: is-affected [options]

runs command only if the git diff since the fork point from master branch contains files matching glob

Options:
  -V, --version           output the version number
  --pattern [pattern...]  provide one or more patterns to check file paths from git diff against
  --repo <repo>           git directory (default: "./")
  --cmd <cmd>             the command to be run if diff matches glob
  --cwd <cwd>             working directory to be used to run command
  --main <mainBranch>     name of the main branch of your repo, used when no --since is provided to find the merge base commit (default: "origin/master")
  --since <since>         commit to diff with
  -h, --help              display help for command

Example

To run npm run build only if the git diff between your current branch head and the base commit on the master branch contains files matching glob app/client/**.

npx is-affected --pattern app/client/** --cmd "npm run build" --cwd "app/client"

Javascript API

const { isAffected, exec } = require("is-affected");

const build = async () => {
	const shouldBuild = await isAffected(
		"app/client/**",
	);

	if (shouldBuild) {
		await exec("npm run build", "app/client");
	}
};

build();

or with options object (using defaults here):

const shouldBuild = await isAffected(
		"app/client/**", // see match patterns below
		{
			repo: "./",
			cmd: "npm run build",
			cwd: process.cwd(),
			mainBranch: "origin/master",
			since: undefined,
		},
	);

Match patterns

A match means that the git diff contains paths that match the pattern and your code is 'affected'.

Negated pattern

You can use a negated pattern: !src/scripts

This will ignore changes in the src/scripts folder. If your diff contains only changes in src/scripts then your code will not be marked as 'affected'.

Multiple patterns

A normal pattern (aka non negated) will add paths to the match list. Negated patterns will remove paths from the list. Your code is 'affected' when the list is not empty after the last pattern has been evaluated.

const shouldBuild = await isAffected([
    	'src/**',
    	'!src/tests/**',
]);

or using cli:

npx is-affected --pattern src/** !src/tests/**

Note that if your shell is automatically expanding glob patterns you should escape the asterix:

npx is-affected --pattern src/\** !src/tests/\**

The above example will monitor all paths in the src folder except for those in the tests subfolder.

is-affected's Issues

When cmd argument is not provided, exit with error code 101

To allow is-affected to be used in different kind of build chains I would return error code 101 when is-affected detects changed files that match the given glob but when no cmd argument is given.

Update docs: js api has no cwd nor cmd options

These options are only for cli usage. Remove them from js api docs.

Always mark as if affected for shallow clones

We can't tell if code has been changed for repos that were cloned with the shallow option.

Return 'true' for these repos.

git rev-parse --is-shallow-repository

Add support for multiple glob patterns

It should be possible to add multiple glob patterns, both to add items to the result list and to remove items from the result list.

Include dot files

When a file starting with a dot exists in the diff, and the file matches the pattern and if this file is the only changed file, then is-affected should return true.