mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

Migrate from ParcelJS to esbuild for UI bundling

Browse Source
This commit is contained in:
checktheroads
2021-07-24 00:00:38 -07:00
parent cb804eb3e1
commit 0572d03003
39 changed files with 459 additions and 6761 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
netbox/project-static/README.md
View File

@@ -17,9 +17,9 @@ TypeScript is a strict static-typed superset of JavaScript. In development, it's
### Tools
#### [ParcelJS](https://parceljs.org/)
#### [esbuild](https://esbuild.github.io/)
Parcel is a bundling tool that takes given input files of most front-end languages (Sass and TypeScript, in our case), follows each of their dependencies (via import statements), and bundles them into a single minified file.
esbuild is a bundling tool that takes given input files of most front-end languages (Sass and TypeScript, in our case), follows each of their dependencies (via import statements), and bundles them into a single minified file.
For JavaScript, every `.ts` file in `netbox/project-static/src` is:
@@ -33,7 +33,7 @@ Likewise, with Sass, every `.scss` file in `netbox/project-static/styles` is:
2. Minified
3. Combined into a single output file at `netbox/project-static/dist/netbox.css` (this includes any dependant libraries imported in file)
For pre v3 releases, this process will be run in development, and the files in `netbox/project-static/dist` checked into change control. This is because running Parcel (and installing dependencies via NPM/Yarn, as described below) requires other system dependencies like NodeJS and Yarn, which aren't part of the current v2 dependency list.
For pre v4 releases, this process will be run in development, and the files in `netbox/project-static/dist` checked into change control. This is because running Parcel (and installing dependencies via NPM/Yarn, as described below) requires other system dependencies like NodeJS and Yarn, which aren't part of the current v2 dependency list.
#### [Yarn](https://yarnpkg.com/)
@@ -65,14 +65,14 @@ To bundle only CSS files, run:
```bash
# netbox/project-static
yarn bundle --styles
yarn bundle:styles
```
To bundle only JS files, run:
```bash
# netbox/project-static
yarn bundle --scripts
yarn bundle:scripts
```
Or, to bundle both, run: