improve styles and documentation

netbox/project-static/bundle.js

@@ -1,25 +1,38 @@
+/**
+ * ParcelJS Bundle Configuration.
+ *
+ * @see https://parceljs.org/api.html
+ */
+
 const Bundler = require('parcel-bundler');
 
+// Bundler options common to all bundle jobs.
 const options = {
+  logLevel: 2,
+  cache: true,
   watch: false,
   minify: true,
   outDir: './dist',
   publicUrl: '/static',
-  logLevel: 2,
-  cache: true,
 };
 
+// Get CLI arguments for optional overrides.
 const args = process.argv.slice(2);
 
+// Allow cache disabling.
 if (args.includes('--no-cache')) {
   options.cache = false;
 }
 
+// Style (SCSS) bundle jobs. Generally, everything should be bundled into netbox.css from main.scss
+// unless there is a specific reason to do otherwise.
 const styles = [
   ['main.scss', 'netbox.css'],
   ['rack_elevation.scss', 'rack_elevation.css'],
 ];
 
+// Script (JavaScript) bundle jobs. Generally, everything should be bundled into netbox.js from
+// index.ts unless there is a specific reason to do otherwise.
 const scripts = [
   ['src/index.ts', 'netbox.js'],
   ['src/jobs.ts', 'jobs.js'],
@@ -28,6 +41,9 @@ const scripts = [
   ['src/device/status.ts', 'status.js'],
 ];
 
+/**
+ * Run style bundle jobs.
+ */
 async function bundleStyles() {
   for (const [input, outFile] of styles) {
     const instance = new Bundler(input, { outFile, ...options });
@@ -35,6 +51,9 @@ async function bundleStyles() {
   }
 }
 
+/**
+ * Run script bundle jobs.
+ */
 async function bundleScripts() {
   for (const [input, outFile] of scripts) {
     const instance = new Bundler(input, { outFile, ...options });
@@ -42,10 +61,15 @@ async function bundleScripts() {
   }
 }
 
+/**
+ * Run all bundle jobs.
+ */
 async function bundleAll() {
   if (args.includes('--styles')) {
+    // Only run style jobs.
     return await bundleStyles();
   } else if (args.includes('--scripts')) {
+    // Only run script jobs.
     return await bundleScripts();
   }
   await bundleStyles();