1 | ![Logo of the project](./images/logo.sample.png)
|
2 |
|
3 | # Frack Build Config Factory
|
4 |
|
5 | > Utility scripts to create opinionated webpack and rollup configuration.
|
6 | >
|
7 | > ## Versioning
|
8 |
|
9 | We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [link to tags on this repository](/tags).
|
10 |
|
11 | ## Tests
|
12 |
|
13 | @TODO
|
14 |
|
15 | ## API
|
16 |
|
17 |
|
18 |
|
19 | #### Table of Contents
|
20 |
|
21 | - [configFactory](#configfactory)
|
22 | - [configFactory](#configfactory-1)
|
23 | - [CSSLoaderFactoryOptions](#cssloaderfactoryoptions)
|
24 | - [isNode](#isnode)
|
25 | - [isWeb](#isweb)
|
26 | - [isProd](#isprod)
|
27 | - [enableModules](#enablemodules)
|
28 | - [getCssLoaders](#getcssloaders)
|
29 |
|
30 | ### configFactory
|
31 |
|
32 | ### configFactory
|
33 |
|
34 | Function which generates webpack config from passed options
|
35 |
|
36 | **Parameters**
|
37 |
|
38 | - `options` **Config** Build settings, target and stuff
|
39 |
|
40 | Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
41 |
|
42 | ### CSSLoaderFactoryOptions
|
43 |
|
44 | ### isNode
|
45 |
|
46 | Is build target NodeJS
|
47 |
|
48 | ### isWeb
|
49 |
|
50 | Is build target web
|
51 |
|
52 | ### isProd
|
53 |
|
54 | Is production build
|
55 |
|
56 | ### enableModules
|
57 |
|
58 | Enable CSS modules
|
59 |
|
60 | ### getCssLoaders
|
61 |
|
62 | CSS Loader factory
|
63 |
|
64 | **Parameters**
|
65 |
|
66 | - `options` **[CSSLoaderFactoryOptions](#cssloaderfactoryoptions)** Configuration toggles
|
67 |
|
68 | Returns **any**
|
69 |
|
70 | ###
|
71 |
|
72 | Get Javascript Loader for passed config
|
73 |
|
74 | **Parameters**
|
75 |
|
76 | - `config` {isProd: boolean, isDev: boolean, babelConfig: Object, root: string} Configuration object
|
77 |
|
78 | Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Webpack loader config
|
79 |
|
80 | ## Api Reference
|
81 |
|
82 | If the api is external, link to api documentation. If not describe your api including authentication methods as well as explaining all the endpoints with their required parameters.
|
83 |
|
84 | ## Database
|
85 |
|
86 | Explaining what database (and version) has been used. Provide download links.
|
87 | Documents your database design and schemas, relations etc...
|
88 |
|
89 | ## Licensing
|
90 |
|
91 | State what the license is and how to find the text version of the license.
|