aboutsummaryrefslogtreecommitdiff
path: root/node_modules/jest-changed-files/README.md
diff options
context:
space:
mode:
authorJoel Kronqvist <joel.h.kronqvist@gmail.com>2022-03-05 19:02:27 +0200
committerJoel Kronqvist <joel.h.kronqvist@gmail.com>2022-03-05 19:02:27 +0200
commit5d309ff52cd399a6b71968a6b9a70c8ac0b98981 (patch)
tree360f7eb50f956e2367ef38fa1fc6ac7ac5258042 /node_modules/jest-changed-files/README.md
parentb500a50f1b97d93c98b36ed9a980f8188d648147 (diff)
downloadLYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.tar.gz
LYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.zip
Added node_modules for the updating to work properly.
Diffstat (limited to 'node_modules/jest-changed-files/README.md')
-rw-r--r--node_modules/jest-changed-files/README.md63
1 files changed, 63 insertions, 0 deletions
diff --git a/node_modules/jest-changed-files/README.md b/node_modules/jest-changed-files/README.md
new file mode 100644
index 0000000..d0c8539
--- /dev/null
+++ b/node_modules/jest-changed-files/README.md
@@ -0,0 +1,63 @@
+# jest-changed-files
+
+A module used internally by Jest to check which files have changed since you last committed in git or hg.
+
+## Install
+
+```sh
+$ npm install --save jest-changed-files
+```
+
+## API
+
+### `getChangedFilesForRoots(roots: <Array<string>>, options: ?object): Promise<?object>`
+
+Get the list of files and repos that have changed since the last commit.
+
+#### Parameters
+
+roots: Array of string paths gathered from [jest roots](https://jestjs.io/docs/configuration#roots-arraystring).
+
+options: Object literal with keys
+
+- lastCommit: boolean
+- withAncestor: boolean
+
+### findRepos(roots: <Array<string>>): Promise<?object>
+
+Get a set of git and hg repositories.
+
+#### Parameters
+
+roots: Array of string paths gathered from [jest roots](https://jestjs.io/docs/configuration#roots-arraystring).
+
+## Usage
+
+```javascript
+import {getChangedFilesForRoots} from 'jest-changed-files';
+
+getChangedFilesForRoots(['/path/to/test'], {
+ lastCommit: true,
+ withAncestor: true,
+}).then(files => {
+ /*
+ {
+ repos: [],
+ changedFiles: []
+ }
+ */
+});
+```
+
+```javascript
+import {findRepos} from 'jest-changed-files';
+
+findRepos(['/path/to/test']).then(repos => {
+ /*
+ {
+ git: Set<Path>,
+ hg: Set<Path>
+ }
+ */
+});
+```