@unicorns/quick-dash-framework - npm Package Compare versions

Comparing version 2.0.7-alpha to 2.0.8-alpha

package.json

 {
   "name": "@unicorns/quick-dash-framework",
-  "version": "2.0.7-alpha",
+  "version": "2.0.8-alpha",
   "description": "Quick Dashboard Framework",
@@ -5,0 +5,0 @@ "author": "Unicorn Global et al",

src/store/index.js

@@ -35,44 +35,60 @@ import Vue from 'vue'
 let custom = false
-// let state = {}
-// let mutations = {}
-// let getters = {}
 let external = {}
 
+/**
+ * These filenames are reserved for the time being.
+ *
+ * The future roadmap will allow the host application the ability
+ * to overload the file and have their one loaded instead of the
+ * base framework one.
+ *
+ * It's important to add the filenames of everything in the base
+ * `/store` folder.
+ */
+const reserved = [
+  'admin',
+  'auth',
+  'index',
+  'roles',
+  'routes',
+  'sidebar',
+  'user',
+  'users'
+]
+
 try {
   custom = require.context('~/store', true, /\.js$/)
   custom.keys().forEach(function(key) {
+    const name = /\.\/(\S+)\.js/.exec(key)[1]
+
     /**
-     * Do not load any index.js files that are placed in the host
-     * applications `store` folder
+     * Do not load any files with reserved names from the host
+     * applications `store` folder and leave a warning.
      */
-    if (key === './index.js') {
-      console.warn('Do not place `index.js` files in your `/store` directory, they are ignored.')
+    if (reserved.includes(name)) {
+      console.warn(`Do not place '${name}.js' files in your '/store' directory, the filenames are reserved and ignored.`)
       return
     }
 
-    if (key === './auth.js') {
-      console.warn('Do not place `auth.js` files in your `/store` directory, they are ignored.')
-      return
-    }
+    console.log('Found custom store: ', name)
 
-    if (key === './user.js') {
-      console.warn('Do not place `user.js` files in your `/store` directory, they are ignored.')
-      return
-    }
-
-    if (key === './users.js') {
-      console.warn('Do not place `users.js` files in your `/store` directory, they are ignored.')
-      return
-    }
-
-    if (key === './roles.js') {
-      console.warn('Do not place `roles.js` files in your `/store` directory, they are ignored.')
-      return
-    }
-
-    console.log('Found custom store: ', key)
-
+    /**
+     * Put together an object containing all the external store exports
+     * and collate them into a single object, using their filename as
+     * the key.
+     *
+     * This results in the VueX store being configured with the
+     * trimmed filename as the root namespace.
+     *
+     * As an example, if you have a custom store called `awesome` then
+     * you will have a VueX namespace on the root called `awesome` that
+     * will contain your getters and setters.
+     *
+     * It's best to namespace in the external application, and access
+     * your getters like `store.getters['awesome/thing']` and do your
+     * custom commits like `store.commit('awesome/thing', value)`.
+     */
     external = {
       ...external,
-      key: custom
+      [name]: custom(key).default
     }
@@ -86,3 +102,3 @@ })
   modules: {
-    external,
+    ...external,
     app,
@@ -92,5 +108,2 @@ auth,
   }
-  // state,
-  // mutations,
-  // getters
 })

No alert changes

Improved metrics

Total package byte prevSize

3934449

increased by0.01%

Lines of code

3880

increased by0.39%

Worsened metrics

Number of package files

155

decreased by-0.64%

No dependency changes