You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-15Lines changed: 19 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,17 +11,17 @@ It detects any changes to a function by bundling it into a single minified file,
11
11
12
12
## Usage
13
13
14
-
- Create a `.differspec.json` file in the directory containing your Firebase Functions:
14
+
-Create a `.differspec.json` file in the directory containing your Firebase Functions:
15
15
16
16
```shell
17
17
my-firebase-project
18
18
├── firebase.json
19
19
├── functions
20
20
├── src
21
-
└── .differspec.json
21
+
└── .differspec.json
22
22
```
23
23
24
-
- Specify your function names and their paths in `.differspec.json`:
24
+
-Specify your function names and their paths in `.differspec.json`:
25
25
26
26
```json
27
27
{
@@ -32,14 +32,14 @@ my-firebase-project
32
32
}
33
33
```
34
34
35
-
- Run `functions-differ` in the directory containing `.differspec.json`
35
+
-Run `functions-differ` in the directory containing `.differspec.json`
36
36
37
37
```shell
38
38
cd my-firebase-project/functions
39
39
functions-differ
40
40
```
41
41
42
-
-`functions-differ` will then output a list of functions that need to be (re)deployed. This includes any functions that were changed or added since its last invocation.
42
+
-`functions-differ` will then output a list of functions that need to be (re)deployed. This includes any functions that were changed or added since its last invocation.
43
43
44
44
```shell
45
45
> functions-differ
@@ -52,13 +52,17 @@ The default output is suitable for passing to `firebase deploy --only` command.
52
52
53
53
`functions-differ` supports the following options:
| dir | d | The directory containing `.differspec.json` file | (current working directory) |
58
+
| write | w | Write output to `.differspec.json` file or not | true |
59
+
| verbose | v | Output verbose logs | false |
60
+
| prefix || Prefix for each function name output |`functions:`|
61
+
| sep || Separator for each output function |`,`|
62
+
| bundlerConfig || Path to the bundler config file which would be passed to esbuild ||
63
+
| concurrency || Number to control the concurrency of the bundling process. Useful in CI/CD flows with limited memory | Number of functions in .differspec.json |
64
+
| discover || Flag indicating whether to use automatic function path discovery | false |
65
+
| indexFilePath || Location of the index.ts file which exports all the functions. Optional. Only used if used with `--discover`|`src/index.ts`|
62
66
63
67
## .differspec.json
64
68
@@ -70,14 +74,14 @@ The default output is suitable for passing to `firebase deploy --only` command.
70
74
|`hashes`| (**AUTOGENERATED, DO NOT MODIFY**) JSON object containing hashes of all functions in the `functions` property |
71
75
|`lastDiff`| (**AUTOGENERATED, DO NOT MODIFY**) JSON object containing the results of the last successful invocation of `functions-differ`|
72
76
73
-
- The `functions` property serves as an index of all functions present in your repository. `functions-differ` does not support automatic discovery of functions in the project (yet), and therefore this property is required.
74
-
- The `hashes` and `lastDiff` properties are autogenerated by `functions-differ`, and should not be created/edited manually.
77
+
-The `functions` property serves as an index of all functions present in your repository. `functions-differ` does not support automatic discovery of functions in the project (yet), and therefore this property is required.
78
+
-The `hashes` and `lastDiff` properties are autogenerated by `functions-differ`, and should not be created/edited manually.
75
79
76
80
## Contributions
77
81
78
82
Please discuss bugs, feature requests, and help in Github Issues. Pull requests are welcome, but please make sure to open an issue for your changes first.
0 commit comments