From d06e72e20ca0df5e7d61375321152dac3467988c Mon Sep 17 00:00:00 2001
From: QWp6t <hi@qwp6t.me>
Date: Mon, 9 Jan 2017 14:15:39 -0800
Subject: [PATCH] Follow standard naming conventions for classes/non-classes in
 assets/scripts

---
 assets/scripts/main.js                        | 32 ++++++++++---------
 assets/scripts/routes/{About.js => about.js}  |  0
 .../scripts/routes/{Common.js => common.js}   |  0
 assets/scripts/routes/{Home.js => home.js}    |  0
 assets/scripts/util/{router.js => Router.js}  |  0
 5 files changed, 17 insertions(+), 15 deletions(-)
 rename assets/scripts/routes/{About.js => about.js} (100%)
 rename assets/scripts/routes/{Common.js => common.js} (100%)
 rename assets/scripts/routes/{Home.js => home.js} (100%)
 rename assets/scripts/util/{router.js => Router.js} (100%)

diff --git a/assets/scripts/main.js b/assets/scripts/main.js
index 343b131..b4f35a5 100644
--- a/assets/scripts/main.js
+++ b/assets/scripts/main.js
@@ -1,23 +1,25 @@
-// import external dependencies
+/** import external dependencies */
 import 'jquery';
 import 'bootstrap/dist/js/bootstrap';
 
-// import local dependencies
-import Router from './util/router';
-import common from './routes/Common';
-import home from './routes/Home';
-import aboutUs from './routes/About';
+/** import local dependencies */
+import Router from './util/Router';
+import common from './routes/common';
+import home from './routes/home';
+import aboutUs from './routes/about';
 
-// Use this variable to set up the common and page specific functions. If you
-// rename this variable, you will also need to rename the namespace below.
-const routes = {
-  // All pages
+/**
+ * Populate Router instance with DOM routes
+ * @type {Router} routes - An instance of our router
+ */
+const routes = new Router({
+  /** All pages */
   common,
-  // Home page
+  /** Home page */
   home,
-  // About us page, note the change from about-us to aboutUs.
+  /** About Us page, note the change from about-us to aboutUs. */
   aboutUs,
-};
+});
 
-// Load Events
-jQuery(document).ready(() => new Router(routes).loadEvents());
+/** Load Events */
+jQuery(document).ready(() => routes.loadEvents());
diff --git a/assets/scripts/routes/About.js b/assets/scripts/routes/about.js
similarity index 100%
rename from assets/scripts/routes/About.js
rename to assets/scripts/routes/about.js
diff --git a/assets/scripts/routes/Common.js b/assets/scripts/routes/common.js
similarity index 100%
rename from assets/scripts/routes/Common.js
rename to assets/scripts/routes/common.js
diff --git a/assets/scripts/routes/Home.js b/assets/scripts/routes/home.js
similarity index 100%
rename from assets/scripts/routes/Home.js
rename to assets/scripts/routes/home.js
diff --git a/assets/scripts/util/router.js b/assets/scripts/util/Router.js
similarity index 100%
rename from assets/scripts/util/router.js
rename to assets/scripts/util/Router.js