Skip to content

Latest commit

 

History

History
75 lines (46 loc) · 2.9 KB

kytConfig.md

File metadata and controls

75 lines (46 loc) · 2.9 KB
Raw

kyt.config.js

kyt uses a simple file in the root of your repo for configuration.

To set up your config, create a kyt.config.js file in the root of your project, and export an object with the following options.

NOTE kyt.config.js is not transpiled by babel. Any syntax within it must be parseable by the version of Node you are running.

Options

  • serverURL - url for the backend node server.

    Default: http://localhost:3000. if hasServer is set to false, then this value is ignored

  • clientURL - in development, the url for the client assets server

    Default:: http://localhost:3001

  • debug - when true, the CLI returns all verbose output

    Default:: false

  • productionPublicPath - the public path for assets in the production build. Useful for configuring CDN usage.
    Default:: /

  • hasClient - Use a client client server for dev (useful if you are using Node to generate HTML pages which are not isomorphic)

    Default: true

  • hasServer - Use a backend node server for build and dev (useful to false this out if you already have a backend)

    Default: true

  • modifyWebpackConfig - Callback function for editing kyt's Webpack configs.

    See more details below.

modifyWebpackConfig

In an attempt to gather feedback to set future priorities, we're running a brief user survey asking: what are you using modifyWebpackConfig for?

modifyWebpackConfig is an optional callback you can define to edit the Webpack config for each part of development. This allows you to add new babel-plugins, modify Webpack loaders, etc.

The function is called with two parameters:

  1. baseConfig The base Webpack config used in the process.
  2. options an object of useful options including the webpackConfig type, ports, and paths. The options object includes an environment and type so you can make changes based on a particular development task.

Define the function in your kyt.config.js and it will be called on each Webpack compilation:

module.exports = {
  modifyWebpackConfig: (baseConfig, options) => {
    // modify baseConfig based on the options
    return baseConfig;
  };
};

NOTE: Polyfills are included in the Webpack configs' entry.main[] array by default. If you use modifyWebpackConfig() to modify entry.main[] and you wish to keep using the provided polyfills, be sure to add the new main entries after the polyfill.

Dev Tip: webpack-merge is a helpful tool for changing and combining Webpack configs.

Creating env-specific kyt configs

kyt allows developers to specify a different kyt config in dev and build commands for the purpose of creating environment specific configurations.

kyt build -C kyt.stage.js

option -C or --config takes a configuration path from the root of your project.