feat: Itroduced an option of having a config for "homepage" and "proxy"

Now it is possible to add a config file elmapp.config.js which could contain some configuration.

Author: halfzebra

config/paths.js

@@ -21,22 +21,42 @@ function ensureSlash(path, needsSlash) {
   return path;
 }
 
-const getPublicUrl = appPackageJson =>
-  envPublicUrl || require(appPackageJson).homepage;
+const getPublicUrl = appConfig => {
+  if (envPublicUrl) {
+    return envPublicUrl;
+  }
+
+  try {
+    return require(appConfig).homepage;
+  } catch (error) {
+    return;
+  }
+};
 
 // We use `PUBLIC_URL` environment variable or "homepage" field to infer
 // "public path" at which the app is served.
 // Webpack needs to know it to put the right <script> hrefs into HTML even in
 // single-page apps that may serve index.html for nested URLs like /todos/42.
 // We can't use a relative path in HTML because we don't want to load something
 // like /todos/42/static/js/bundle.7289d.js. We have to know the root.
-function getServedPath(appPackageJson) {
-  const publicUrl = getPublicUrl(appPackageJson);
+function getServedPath(appConfig) {
+  const publicUrl = getPublicUrl(appConfig);
   const servedUrl =
     envPublicUrl || (publicUrl ? url.parse(publicUrl).pathname : '/');
   return ensureSlash(servedUrl, true);
 }
 
+function getProxySettings(appConfig) {
+  try {
+    return require(appConfig).proxy;
+  } catch (error) {
+    return;
+  }
+}
+
+// This file is used to store the configuration such as "homepage" and "proxy"
+const appConfig = resolveApp('./elmapp.config.js');
+
 module.exports = {
   appPath: resolveApp('.'),
   appPublic: resolveApp('./public'),
@@ -48,6 +68,7 @@ module.exports = {
   appBuild: resolveApp('./build'),
   elmJson: resolveApp('./elm.json'),
   elm: require.resolve('elm/bin/elm'),
-  publicUrl: getPublicUrl(resolveApp('elm.json')),
-  servedPath: getServedPath(resolveApp('elm.json'))
+  publicUrl: getPublicUrl(appConfig),
+  servedPath: getServedPath(appConfig),
+  proxy: getProxySettings(appConfig)
 };

scripts/start.js

@@ -159,8 +159,7 @@ choosePort(HOST, DEFAULT_PORT)
     // Create a webpack compiler that is configured with custom messages.
     const compiler = createCompiler(webpack, config, appName, urls);
     // Load proxy config
-    const proxySetting = require(paths.elmJson).proxy;
-    const proxyConfig = prepareProxy(proxySetting, paths.appPublic);
+    const proxyConfig = prepareProxy(paths.proxy, paths.appPublic);
     // Serve webpack assets generated by the compiler over a web sever.
     const serverConfig = createDevServerConfig(
       proxyConfig,

template/README.md

@@ -47,7 +47,7 @@ You can find the most recent version of this guide [here](https://github.com/hal
 * [Deployment](#deployment)
   * [Building for Relative Paths](#building-for-relative-paths)
   * [Static Server](#static-server)
-  * [Netlify](#netlify)  
+  * [Netlify](#netlify)
   * [GitHub Pages](#github-pages)
 * [IDE setup for Hot Module Replacement](#ide-setup-for-hot-module-replacement)
 
@@ -645,12 +645,12 @@ for a list of files you can use to declare environment variables.
 
 ## Setting up API Proxy
 
-To forward the API ( REST ) calls to backend server, add a proxy to the `elm.json` in the top level json object.
+To forward the API ( REST ) calls to backend server, add a proxy to the `elmapp.config.js` in the top level json object.
 
-```json
-{
+```js
+module.exports = {
     ...
-    "proxy" : "http://localhost:1313",
+    proxy: "http://localhost:1313",
     ...
 }
 ```
@@ -767,10 +767,12 @@ will affect your users' experience.
 
 By default, Create Elm App produces a build assuming your app is hosted at the server root.
 
-To override this, specify the `homepage` in your `elm.json`, for example:
+To override this, specify the `homepage` in your `elmapp.config.js`, for example:
 
 ```js
-  "homepage": "http://mywebsite.com/relativepath",
+module.exports = {
+    homepage: "http://mywebsite.com/relativepath"
+}
 ```
 
 This will let Create Elm App correctly infer the root path to use in the generated HTML file.
@@ -809,16 +811,18 @@ This step is important to make sure netlify uses the correct build command.
 
 ### GitHub Pages
 
-#### Step 1: Add `homepage` to `elm.json`
+#### Step 1: Add `homepage` to `elmapp.config.js`
 
 **The step below is important!**
 
 **If you skip it, your app will not deploy correctly.**
 
-Open your `elm.json` and add a `homepage` field:
+Open your `elmapp.config.js` and add a `homepage` field:
 
 ```js
-  "homepage": "https://myusername.github.io/my-app",
+module.exports = {
+    homepage": "https://myusername.github.io/my-app",
+}
 ```
 
 Create Elm App uses the `homepage` field to determine the root URL in the built HTML file.