Updated comments

Author: presidenten

README.md

@@ -7,9 +7,6 @@ Vuex+ is an opinionated library that handles instances in Vuex and makes it easy
 ```
 ![piri](./docs/instances.gif)
 
-### Heads up!!
-Still prerelease, but the library should reach 1.0.0 and get a proper release by mid may. Very close now.
-
 ### Enhancements over Vuex instance handling (2.3.0)+
 From Vuex 2.3.0 onward vuex supports the same notation as vue `data` property to [handle instantiation](https://vuex.vuejs.org/en/modules.html).
 
@@ -33,9 +30,6 @@ Check out the extensive tutorial bundled with the example:
   - Vuex module filename
   - Vuex module variable names
 
-### Todo
-- Clean up comments
-
 ### Coauthor
 - [Zyrica](https://github.com/zyrica)
 

src/api/api.js

@@ -4,10 +4,14 @@ import { getTagName, getInstances } from '../common/helpers.js';
  * The api for all stores
  * The api is autogenerated once the module importer has been set
  * ```
- *   api.aStore.get.something => vuex magic string for vuex getter
+ *   api.someStore.get.something => vuex magic string for vuex getter
  * ```
  */
 export const api = {};
+/**
+ * Set api
+ * @param {Object} newApi The new api
+ */
 export const setApi = (newApi) => {
   Object.keys(newApi).forEach((key) => {
     api[key] = newApi[key];
@@ -17,6 +21,12 @@ export const setApi = (newApi) => {
 /**
  * Match array of results strings and return the ones matching parent instances
  */
+/**
+ * Match array of results strings and return the ones matching parent instances
+ * @param  {array} allResults    All unmatched results
+ * @param  {array} pathInstances All the instances found in the instance branch
+ * @return {array}               An array with results matched the the instance branch
+ */
 export const matchToInstances = (allResults, pathInstances) => {
   const results = [];
   allResults
@@ -45,9 +55,9 @@ export const matchToInstances = (allResults, pathInstances) => {
 
 /**
  * Input subpath and figure out full path
- * @param (string) subpath
- * @param (Object) self - vuex module `this`
- * @returns (string) full path
+ * @param  {string} subpath The subpath to start from
+ * @param  {Object} self    Vue component `.this`
+ * @return {string}         Full path
  */
 export const getFullPath = (subpath, self) => {
   if (!subpath) {
@@ -95,6 +105,10 @@ export const getFullPath = (subpath, self) => {
 
 /**
  * Set instance to all toplevel stores in `storeApi` paths
+ * @param  {Object} storeApi      The store api
+ * @param  {string} baseStoreName Base store name
+ * @param  {string} newStoreName  New store name
+ * @return {Object}               Store api remapped with toplevel instance names
  */
 export function remapBaseStore(storeApi, baseStoreName, newStoreName) {
   newStoreName = newStoreName || baseStoreName;

src/api/global.js

@@ -4,6 +4,10 @@ import { getLocalPath } from '../common/helpers.js';
 import vuexInstance from '../vuexInstance.js';
 
 export default {
+  /**
+   * Get the whole global api
+   * @return {Object} Global api
+   */
   get api() {
     return clone(api);
   },

src/api/map.js

@@ -21,7 +21,7 @@ export default {
 
   /**
    * Map local paths `require('./example-substore.js').api.act.value`
-   * to the corresponding vuex getter.
+   * to the corresponding vuex action.
    * @param {Object} map - Object of all method properties to be mapped to actions
    * @returns {Object} - Object containing the mapped actions
    */

src/common/helpers.js

@@ -1,26 +1,45 @@
+/**
+ * Get store instance name
+ * @param  {string} storeName Store name
+ * @param  {string} instance  Instance name
+ * @return {string}           Store instance name
+ */
 export const getStoreInstanceName = (storeName, instance) => {
   if (instance) {
     return storeName + '$' + instance;
   }
   return storeName;
 };
 
-
+/**
+ * Convert kebab and snake case to camelCase
+ * @param  {string} str The string to Convert
+ * @return {string}     Camel cased string
+ */
 export const toCamelCase = (str) => {
   if (!str || typeof str !== 'string') {
     return '';
   }
   return str.replace(/(-|_)([\w])/g, s => s[1].toUpperCase());
 };
 
-
+/**
+ * Return the local path of the instance branch
+ * @param  {string} path  The global path
+ * @param  {Object} state The vuex context state
+ * @return {string}       The local path with all instances
+ */
 export const getLocalPath = (path, state) => {
   const storeName = state['vuex+'].storeName;
   const instance = state['vuex+'].instance;
   return path.replace(storeName, getStoreInstanceName(storeName, instance));
 };
 
-
+/**
+ * Support method that gets tag name for error logs
+ * @param  {Object} self Vue component `.this`
+ * @return {string}      <tag-name>
+ */
 export const getTagName = (self) => {
   let tag = 'unknown-tag';
   if (self.$parent) {
@@ -33,7 +52,12 @@ export const getTagName = (self) => {
   return '<' + tag + '>';
 };
 
-
+/**
+ * Returns all instances in the current instance branch as an ordered array
+ * @param  {string} subpath The subpath to explore
+ * @param  {Object} self    Vue component `.this`
+ * @return {array}          The instances as array
+ */
 export const getInstances = (subpath, self) => {
   let path = self.instance ? '/$' + self.instance : '';
   let parent = self;
@@ -58,7 +82,11 @@ export const getInstances = (subpath, self) => {
   return instances;
 };
 
-
+/**
+ * Returns subInstances from local path
+ * @param  {string} path Path to explore
+ * @return {array}       Subinstances as ordered array
+ */
 export const getSubInstances = (path) => {
   if (path) {
     const subInstances = path.match(/\$\w*/g);

src/common/hmrHandler.js

@@ -4,11 +4,24 @@ import vuexInstance from '../vuexInstance.js';
 
 let handlers = [];
 
+/**
+ * Returns all current vuex module handlers
+ * @return {array} All current vuex module handlers
+ */
 export const getHandlers = () => handlers.slice();
+/**
+ * Clears the current vuex module handlers
+ */
 export const clearHandlers = () => {
   handlers = [];
 };
 
+/**
+ * Registers module for HMR
+ * @param  {Object} newStore          The store object
+ * @param  {string} baseStoreName     Base store name
+ * @param  {string} storeInstanceName Store instance name
+ */
 export const registerForHMR = (newStore, baseStoreName, storeInstanceName) => {
   handlers.push({
     storeName: baseStoreName + '-store',
@@ -17,10 +30,18 @@ export const registerForHMR = (newStore, baseStoreName, storeInstanceName) => {
   });
 };
 
+/**
+ * Unregisters for HMR
+ * @param  {Object} newStore The store object
+ */
 export const unregisterForHMR = (newStore) => {
   handlers = handlers.filter(h => h.newStore !== newStore);
 };
 
+/**
+ * The hmr handler
+ * @param  {array} updatedModules All the updated modules returned from HMR plugin
+ */
 export const hmrHandler = (updatedModules) => {
   const modules = {};
   Object.keys(updatedModules).forEach((key) => {

src/mixins/addStore.js

@@ -5,6 +5,10 @@ import { registerForHMR, unregisterForHMR } from '../common/hmrHandler.js';
 
 let importer;
 
+/**
+ * Setup module with new importer from webpack-context-vuex-hmr
+ * @param  {Object} newImporter The importer
+ */
 export function setup(newImporter) {
   importer = newImporter;
 }

src/mixins/install.js

@@ -1,4 +1,8 @@
 export default {
+  /**
+   * Use to install as Vue plugin
+   * @param  {Object} Vue The vue instance
+   */
   install(Vue) {
     Vue.mixin({
       props: ['instance'],

src/mixins/setupVuexPlus.js

@@ -3,6 +3,10 @@ import { setup } from './addStore.js';
 import { hmrHandler } from '../common/hmrHandler.js';
 import vuexInstance from '../vuexInstance.js';
 
+/**
+ * Setup vuex plus with the base vuex store
+ * @param  {Object} $store Base vuex store
+ */
 export default function setupVuexPlus($store) {
   vuexInstance.store = $store;
   const importer = contextHmr.getNewInstance();

src/store/newInstance.js

@@ -1,6 +1,12 @@
 import clone from 'clone';
 import { remapBaseStore } from '../api/api.js';
 
+/**
+ * Make new instance with remapped api.
+ * @param  {Object} substore The substore to remap and clone
+ * @param  {string} instance Instance name
+ * @return {Object}          Remapped store
+ */
 export default (substore, instance) => {
   const result = clone(substore);
   result.api = remapBaseStore(result.api, result.name, result.name + '$' + instance);