Skip to main content

ima.config.js

To additionally customize the build configuration of IMA.js, you can create a ima.config.js file in the root of your project (next to package.json).

ima.config.js is regular JavaScript module that is loaded during the build configuration initialization (in Node.js environment) and it is not included in the final application bundle.

An example of ima.config.js file can look something like this:

./ima.config.js
const postcssUnmq = require('postcss-unmq');
const { AnalyzePlugin } = require('@ima/cli');

/**
* @type import('@ima/cli').ImaConfig
*/
module.exports = {
publicPath: '/public/',
watchOptions: {
ignored: /(node_modules|build|.husky|_templates|.git)\/(?!@ima).*/
},
plugins: [
new AnalyzePlugin()
],
webpack: async (config, ctx) => {
// Enable webpack infrastructure logging
if (ctx.command === 'dev') {
config.infrastructureLogging = {
level: 'info',
};
}

return config;
},
postcss: (config, ctx) => {
config.postcssOptions.plugins.push(postcssUnmq({ width: 540 }));

return config;
},
languages: {
cs: [
'./node_modules/@ima/**/*CS.json',
'./app/**/*CS.json'
],
en: [
'./node_modules/@ima/**/*EN.json',
'./app/**/*EN.json'
]
}
};
tip

Use the @type jsdoc annotation to enable ts-types code completions.

Configuration options

The ima.config.js file should export an object with any combination of the following configuration options.

webpack

async function(config, ctx, imaConfig): config

This is the most advanced and versatile configuration option, allowing you to change the generated webpack configuration directly before it's passed to the compiler. This function is executed last in the whole configuration pipeline, meaning that all default configurations and CLI plugin configurations are already merged into the config value. This allows you to completely customize the final config form.

The function receives 3 arguments and has to always return (mutated) config object:

  • config - webpack configuration object (just like the one you usually define in webpack.config.js).
  • ctx - current configuration context. As we mentioned in the compiler features, the app builds 3 different bundles. Using ctx.name you can find out which configuration you are currently editing. There are many additional values that help you identify current build state. You can use these to further customize the config only in some cases or for certain bundles. For more information take a look at the argument type.
  • imaConfig - loaded ima.config.js file, with defaults.

The following example turns on minification for server bundle for build command:

./ima.config.js
/**
* @type import('@ima/cli').ImaConfig
*/
module.exports = {
webpack: async (config, ctx) => {
if (ctx.command === 'build' && ctx.name === 'server') {
config.optimization.minimize = true;
}

return config;
},
};

swc

async function(swcLoaderOptions, ctx): swcLoaderOptions

Similarly to webpack, this function is executed with the swc-loader default options and it's result is then passed to the loader itself. This allows you to customize the swc compiler options in easier and more direct way than you'd have to do when using the webpack option.

For example, to enable support for the ECMAScript proposals core-js feature, you would do the following:

./ima.config.js
/**
* @type import('@ima/cli').ImaConfig
*/
module.exports = {
swc: async (swcLoaderOptions, ctx) => {
swcLoaderOptions.env.shippedProposals = true;

return swcLoaderOptions;
},
};

swcVendor

async function(swcLoaderOptions, ctx): swcLoaderOptions

Works same as the aforementioned swc options, except this config is applied to vendor files that match regular expressions defined in the transformVendorPaths settings.

postcss

async function(postCssLoaderOptions, ctx): postCssLoaderOptions

Lastly, this function is used to customize the postcss-loader options. Among the rest you can easily define custom PostCSS plugins or completely overwrite the default set:

./ima.config.js
const postcssUnmq = require('postcss-unmq');

/**
* @type import('@ima/cli').ImaConfig
*/
module.exports = {
swc: async (postCssLoaderOptions, ctx) => {
postCssLoaderOptions.postcssOptions.plugins.push(
postcssUnmq({ width: 540 })
);

return postCssLoaderOptions;
},
};
info

The webpack configuration intentionally ignores any .postcssrc configuration files to prevent potential conflicts with multiple config files.

languages

object

i18n language files configuration. The language option expects an object with key/value pairs, where key represents the language and value an array of messageformat compliant JSON files. For more information about localization, see the dictionary section.

note

Globs are fully supported and resolved through globby npm package.

./ima.config.js
/**
* @type import('@ima/cli').ImaConfig
*/
module.exports = {
languages: {
cs: [
'./node_modules/@ima/**/*CS.json',
'./node_modules/@cns/**/*CS.json',
'./app/**/*CS.json'
],
en: [
'./node_modules/@ima/**/*EN.json',
'./node_modules/@cns/**/*EN.json',
'./app/**/*EN.json'
]
}
}

jsxRuntime

'classic' | 'automatic' = 'automatic'

Use jsxRuntime option to enable classic or automatic mode for jsx transformations. For more information see Introducing the New JSX Transform.

webpackAliases

object

The webpackAliases options is passed directly to the webpack resolve.alias configuration. You can use this to define additional path aliases to the already existing app/* alias, which points to the ./app directory.

To have the ability to use absolute paths, which are resolved from the ./app/components and ./app/pages directory:

import Home from 'components/home/Home';
import DetailView from 'pages/detail/DetailView';

The webpackAliases option configuration could look something like this:

./ima.config.js
const path = require('path');

/**
* @type import('@ima/cli').ImaConfig
*/
module.exports = {
webpackAliases: {
'components': path.resolve('./app/components'),
'pages': path.resolve('./app/pages'),
};
};

sourceMaps

boolean | string = false

The sourceMaps option enables source maps in the production build. Use true for 'source-map' or any other string value compatible with webpack devtool option.

devServer

object

Similarly to the CLI options, you can use the devServer option to override defaults for our companion dev server.

The only thing that's configurable through the ima.config.js only, is the writeToDiskFilter function. This allows you to force the dev server to write certain files to disk, even if you're serving them from memory in the watch mode.

./ima.config.js
/**
* @type import('@ima/cli').ImaConfig
*/
module.exports = {
devServer: {
port: 3101;
hostname: 'localhost';
publicUrl: 'http://localhost:3101';
writeToDiskFilter: (filePath) => false;
};
};
note

The CLI arguments always take precedence over any other configurations.

publicPath

string = '/'

The publicPath option is used to specify base path for all asses within the application. (see more at webpack public path).

tip

Use this option to change base public path for static served files, for example when uploading static files to CDN.

Additionally, if the CDN url is not known before building the application, you can use IMA_PUBLIC_PATH env variable, when starting the application server. This variable takes preference before the ima config publicPath option.

IMA_PUBLIC_PATH="https://cdn.basePath/cd_F/" node ./server/server.js

If you want to serve your static files on a different route (default is /static), customize the staticPath option in ./server/config/environment.js file and change publicPath option accordingly:

./server/config/environment.js
module.exports = (() => {
return {
prod: {
$Server: {
/**
* The built static files are served on the
* http://localhost:3001/pro/static base url
*/
staticPath: '/pro/static',
}
}
}
});
./ima.config.js
/**
* @type import('@ima/cli').ImaConfig
*/
module.exports = {
publicPath: '/pro/static/',
};

compress

boolean = true

Enables brotli and gzip compression for production assets (in build command). Set to false to disable this feature.

imageInlineSizeLimit

number = 8192

The imageInlineSizeLimit configuration option is already described in the compiler features section. Essentially it's a image size threshold for it's automatic inlining as a base64 string.

disableLegacyBuild

boolean

Set to true to disable building of the client bundle (older ECMAScript target).

Don't forget to remove script sources from the $Source option in app environment config

caution

The application will now only execute the modern version of the client bundle (client.es), meaning that the it will only work on the latest versions of modern browsers.

This can be useful if you're building an app, where you are able to set constrains for the supported browsers (e.g. internal admin page).

transformVendorPaths

{ include?: RegExp[]; exclude?: RegExp[]; }

caution

This is an advanced feature.

Using this option you can include/exclude array of regular expressions that are matched against file paths of processed vendor files (= imported files from node_modules). These files are then processed through swc-loader that makes sure to compile their syntax to currently supported target (ES9). This transformation is executed only for the legacy client bundle.

By default the CLI always matches all files under the @ima namespace, since we release our plugins in latest ECMA syntax and they need to be compiled down to older syntaxes with proper core-js polyfills.

tip

If you use any 3rd party libraries that you are not sure if they support your currently supported browser environments, add their package names as regular expressions to this array and they will be compiled using swc-loader with proper polyfill injections from the core-js package.

watchOptions

object

watchOptions is an object, passed to the webpack watch compiler. You can customize watchOptions.ignored files settings or watchOptions.aggregateTimeout if you have any issues with the default values.

For more information visit the webpack documentation.

tip

If you have any issues with webpack compilation launching multiple times per one file save, try to increase the watchOptions.aggregateTimeout number and see if it helps.

experiments

object

This is a place where you can enable IMA.js configuration experiments. Don't confuse this with the webpack experiments field, this is used only for our potential future configuration updates or changes, which may be enabled by default in the future (much like webpack does).

Currently there's only one running experiment option experiments.css, that uses webpack native CSS support which completely replaces the css-loader and mini-css-extract-plugin libraries.

plugins

ImaCliPlugin[]

Array of IMA.js CLI plugin instances. For more information about CLI plugins, see Plugins API section.