frontend/build-scripts
Simon Lamon 89dc1a7ebc
ESLint Flat Config (#22221)
* Flat config file

* Plugin

* prettier

* Set eslint to latest version (non dev)

* yarn dedupe

* push changes from eslint type pr

* dedupe
2024-11-18 15:49:59 +01:00
..
babel-plugins Inject element polyfills where used using Babel (#20689) 2024-05-29 14:02:40 +02:00
gulp Only download verified translations (#22844) 2024-11-16 13:20:06 +01:00
README.md Remove rollup build configuration (#22181) 2024-11-08 10:19:52 +02:00
bundle.cjs Remove rollup build configuration (#22181) 2024-11-08 10:19:52 +02:00
env.cjs Remove rollup build configuration (#22181) 2024-11-08 10:19:52 +02:00
eslint.config.mjs ESLint Flat Config (#22221) 2024-11-18 15:49:59 +01:00
list-plugins-and-polyfills.js Enable shipped proposals in Babel (#17909) 2023-09-19 13:56:55 +02:00
paths.cjs Make module types explicit and convert some to ESM (#15964) 2023-03-30 11:23:43 +02:00
removedIcons.json Remove deprecated and removed icons (#15762) 2023-03-08 12:28:34 +01:00
webpack.cjs Fix 2fa login validation, add autofocus to login (#22856) 2024-11-18 15:25:51 +02:00

README.md

Bundling Home Assistant Frontend

The Home Assistant build pipeline contains various steps to prepare a build.

  • Generating icon files to be included
  • Generating translation files to be included
  • Converting TypeScript, CSS and JSON files to JavaScript
  • Bundling
  • Minifying the files
  • Generating the HTML entrypoint files
  • Generating the service worker
  • Compressing the files

Converting files

Currently in Home Assistant we use a bundler to convert TypeScript, CSS and JSON files to JavaScript files that the browser understands.

We currently rely on Webpack. Both of these programs bundle the converted files in both production and development.

For development, bundling is optional. We just want to get the right files in the browser.

Responsibilities of the converter during development:

  • Convert TypeScript to JavaScript
  • Convert CSS to JavaScript that sets the content as the default export
  • Convert JSON to JavaScript that sets the content as the default export
  • Make sure import, dynamic import and web worker references work
    • Add extensions where missing
    • Resolve absolute package imports
  • Filter out specific imports/packages
  • Replace constants with values

In production, the following responsibilities are added:

  • Minify HTML
  • Bundle multiple imports so that the browser can fetch less files
  • Generate a second version that is ES5 compatible

Configuration for all these steps are specified in bundle.js.