chore: normalize file doc intros and clean-up language

Author: johnleider

packages/@vuetify/presets/generator/templates/base/src/plugins/app.js

@@ -6,7 +6,10 @@
  */
 
 export function registerComponents (app) {
-  // Get all .vue files within `src/components/app`
+  // Automatically get all .vue files within
+  // `src/components` and register them to
+  // the current app.
+  // https://webpack.js.org/guides/dependency-management/#requirecontext
   const requireComponent = require.context('@/components', true, /\.vue$/)
 
   for (const file of requireComponent.keys()) {

packages/@vuetify/presets/generator/templates/base/src/plugins/index.js

@@ -4,5 +4,6 @@
  * Automatically included in `./src/main.js`
  */
 
+ // Imports
 import './app'
 import './webfontloader'

packages/@vuetify/presets/generator/templates/base/src/plugins/vuetify.js

@@ -12,6 +12,7 @@ import colors from 'vuetify/lib/util/colors'
 Vue.use(Vuetify)
 
 export default new Vuetify({
+  // https://vuetifyjs.com/en/features/theme/#theme-generator
   theme: {
     themes: {
       light: {

packages/@vuetify/presets/generator/templates/base/src/plugins/vuex-pathify.js

@@ -1,8 +1,14 @@
-// https://davestewart.github.io/vuex-pathify/#/setup/config
+/**
+ * plugins/vuex-pathify.js
+ *
+ * vuex-pathify documentation: https://davestewart.github.io/vuex-pathify/#/setup/config
+ */
 
+// Imports
 import pathify from 'vuex-pathify'
 
-// options
+// Custom mapping style
+// https://davestewart.github.io/vuex-pathify/#/setup/mapping
 pathify.options.mapping = 'simple'
 pathify.options.strict = true
 

packages/@vuetify/presets/generator/templates/base/src/router/index.js

@@ -1,4 +1,6 @@
 /**
+ * Vuetify Vue CLI Preset
+ *
  * router/index.js
  *
  * vue-router documentation: https://router.vuejs.org/
@@ -13,7 +15,7 @@ Vue.use(Router)
 export default new Router({
   mode: 'history',
   base: process.env.BASE_URL,
-  scrollBehavior: (to, from, savedPosition) => {
+  scrollBehavior: (to, _, savedPosition) => {
     if (to.hash) return { selector: to.hash }
     if (savedPosition) return savedPosition
 
@@ -24,13 +26,21 @@ export default new Router({
       path: '/',
       // Layouts allow you to define different
       // structures for different view
+      // https://router.vuejs.org/guide/essentials/nested-routes.html#nested-routes
       component: () => import('@/layouts/default'),
       children: [
         {
           path: '',
           name: 'Home',
           component: () => import('@/views/Home')
-        }
+        },
+        // Create a new Vue template for an About page
+        // and uncomment this entry to enable the route
+        // {
+        //   path: 'about',
+        //   name: 'About',
+        //   component: () => import('@/views/About')
+        // },
       ]
     }
   ]

packages/@vuetify/presets/generator/templates/base/src/store/index.js

@@ -1,11 +1,21 @@
+/**
+ * Vuetify Vue CLI Preset
+ *
+ * store/index.js
+ *
+ * vuex documentation: https://vuex.vuejs.org/
+ */
+
 // Vue
 import Vue from 'vue'
 import Vuex from 'vuex'
 
 // Utilities
+// https://davestewart.github.io/vuex-pathify/#/
 import pathify from '@/plugins/vuex-pathify'
 
 // Modules
+// https://vuex.vuejs.org/guide/modules.html
 import * as modules from './modules'
 
 Vue.use(Vuex)
@@ -15,4 +25,6 @@ export default new Vuex.Store({
   plugins: [pathify.plugin]
 })
 
+// A reusable const for making root commits and dispatches
+// https://vuex.vuejs.org/guide/modules.html#accessing-global-assets-in-namespaced-modules
 export const ROOT_DISPATCH = Object.freeze({ root: true })