Skip to content

Latest commit

 

History

History
32 lines (27 loc) · 1.38 KB

README.md

File metadata and controls

32 lines (27 loc) · 1.38 KB

rustc-perf site frontend

This directory contains code for the rustc-perf website frontend.

Build instructions

  • Install dependencies 
    $ npm install
  • Development build - dynamically reloads after each change. 
    $ npm run watch

    If you want to develop locally, it's recommended to use npm run watch + cargo run --bin site (without the --release flag). This setup enables hot reloading of your code on the website.

  • Production build - build optimized and minimized files. 
    $ npm run build

The files are packaged into the dist directory, from which they are embedded into the rustc-perf binary.

Build system

The frontend is built using the Parcel bundler. It generates several JavaScript files (one for each page in the perf.RLO website) into the dist directory.

It uses a custom backend for transpiling TypeScript, which transpiles for browsers defined in the browserslist attribute in package.json. It does not perform type-checking, that is why there is a dedicated npm run check action that uses tsc. It is performed on CI to find typ errors. The tsconfig.json file is only used by the type-checking action.

The buffer alias in package.json is used to deter Parcel from providing buffer module polyfill. This polyfill breaks the minidifed JS Parcel output (at least in Parcel 2.8.3).