| 1 | # packmule core
|
| 2 |
|
| 3 | > Stubborn configuration generator for Webpack.
|
| 4 |
|
| 5 | ## Installation
|
| 6 |
|
| 7 | ```sh
|
| 8 | npm install --save-dev @packmule/core
|
| 9 | ```
|
| 10 |
|
| 11 | ## API
|
| 12 |
|
| 13 | ```ts
|
| 14 | Packmule(mode?: 'development' | 'production' | 'none', options?: Options)
|
| 15 | .register(pack: Pack)
|
| 16 | .generate();
|
| 17 | ```
|
| 18 |
|
| 19 | ### Options
|
| 20 |
|
| 21 | | Option | Type | Default | Description |
|
| 22 | | --------- | --------- | -------- | -------------------------------- |
|
| 23 | | **mode** | `string` | `'none'` | Sets the mode for webpack. |
|
| 24 | | **root** | `string` | `cwd` | Sets the project root directory. |
|
| 25 | | **debug** | `boolean` | `false` | Enables debugging. |
|
| 26 |
|
| 27 | ### Hints
|
| 28 |
|
| 29 | Hints are passed to and used by packs to indicate which internal tasks to run.
|
| 30 | Packs can choose which hints to use i.e. packs often use a small subset of available hints.
|
| 31 |
|
| 32 | | Hint | Type | Default | Description |
|
| 33 | | ------------ | --------- | ------- | ------------------------------ |
|
| 34 | | **optimize** | `boolean` | `false` | Enables optimization steps. |
|
| 35 | | **extract** | `boolean` | `false` | Enables file extraction. |
|
| 36 | | **notify** | `boolean` | `false` | Enables desktop notifications. |
|
| 37 | | **lint** | `boolean` | `false` | Enables code linting. |
|
| 38 | | **fix** | `boolean` | `false` | Enables code fixing. |
|
| 39 | | **cache** | `boolean` | `true` | Enables caching. |
|
| 40 | | **hash** | `boolean` | `false` | Enables filename hashing. |
|
| 41 | | **watch** | `boolean` | `false` | Enables file watching. |
|
| 42 |
|
| 43 | ## License
|
| 44 |
|
| 45 | [MIT](https://choosealicense.com/licenses/mit/)
|
| 46 |
|
| 47 | ---
|
| 48 |
|
| 49 | [<img src="https://www.pixelart.at/fileadmin/images/logo-new/logo.svg" width="150">](https://www.pixelart.at/)
|