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
+21-1Lines changed: 21 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ npm install --save-dev funpack
21
21
yarn add -D funpack
22
22
```
23
23
24
-
2. Add `funpack` to your package.json like so:
24
+
2. Add `funpack` to your package.json, for example like so:
25
25
26
26
```json
27
27
// package.json
@@ -37,6 +37,26 @@ yarn add -D funpack
37
37
}
38
38
```
39
39
40
+
Settings are described under the [Settings](#settings) section.
41
+
42
+
3. Run the `funpack` cli.
43
+
For example:
44
+
45
+
```json
46
+
{
47
+
...
48
+
"scripts": {
49
+
"prepackage": "tsc --noEmit",
50
+
"package": "funpack"
51
+
},
52
+
...
53
+
}
54
+
```
55
+
56
+
The `funpack` cli accepts `--packageJsonPath` (defaults to directory of script execution so your main `package.json`) that accepts the path of the `package.json` that contains the funpack config.
57
+
58
+
### Settings
59
+
40
60
Each option inside `settings` is optional. Below you can view what exactly is needed in the funpack object as well as which settings are available.
41
61
42
62
[configSchema that represents the funpack config](./src/parts/parseConfig.ts)
0 commit comments