update directions on config file

Author: mdxprograms

README.md

@@ -15,6 +15,13 @@ A CLI tool built to automate [vim-plug](https://github.com/junegunn/vim-plug) us
 
 `npm i -g @wallerbuilt/vaq`
 
+### Setting up with vim-plug
+
+_IF_ your vim-plug plugin list is in a separate file from your vim config file, make sure to set the config path to that file instead.
+Basically, vaq needs to have access to your `Plug` list in order to make the updates needed.
+
+When first using the cli tool it will ask you for this path and keep it stored for future use.
+
 ### Use
 
 `vaq`

lib/prompts.js

@@ -1,106 +1,106 @@
-const inquirer = require('inquirer')
-const { emojify } = require('node-emoji')
-const { getConfigPlugins } = require('./files')
-const { getPlugNameFromConfig } = require('./helpers')
+const inquirer = require("inquirer");
+const { emojify } = require("node-emoji");
+const { getConfigPlugins } = require("./files");
+const { getPlugNameFromConfig } = require("./helpers");
 
 const askForVimInfo = () => {
   const questions = [
     {
-      name: 'vimpath',
-      type: 'input',
+      name: "vimpath",
+      type: "input",
       message:
-        'Path to your vim config file using vim-plug relative to user directory. Example: .config/nvim/init.vim)?',
+        "Path to your vim config file using vim-plug relative to user directory. Example: .config/nvim/init.vim)?\nIf your vim-plug block including your plugins is in a separate file, please use the path to that file instead.",
       validate: (val) => {
         if (val.length) {
-          return true
+          return true;
         } else {
-          return 'Please enter a path to your vim config file'
+          return "Please enter a path to your vim config file or the file that holds your vim-plug Plug declarations.";
         }
-      }
+      },
     },
     {
-      name: 'vimtype',
-      type: 'list',
-      message: 'Are you using neovim (nvim) or vim?',
-      choices: ['nvim', 'vim'],
-      default: 'vim'
-    }
-  ]
+      name: "vimtype",
+      type: "list",
+      message: "Are you using neovim (nvim) or vim?",
+      choices: ["nvim", "vim"],
+      default: "vim",
+    },
+  ];
 
-  return inquirer.prompt(questions)
-}
+  return inquirer.prompt(questions);
+};
 
 const askForQuery = () =>
   inquirer.prompt([
     {
-      name: 'query',
-      type: 'input',
-      message: 'query',
+      name: "query",
+      type: "input",
+      message: "query",
       validate: (val) => {
         if (val.length === 0) {
-          return 'Must supply a name'
+          return "Must supply a name";
         } else {
-          return true
+          return true;
         }
-      }
-    }
-  ])
+      },
+    },
+  ]);
 
 const askPluginSelection = (plugins) =>
   inquirer.prompt([
     {
-      name: 'selection',
-      type: 'list',
+      name: "selection",
+      type: "list",
       choices: plugins.map((p) => ({
         name: `${p.name} - ${emojify(p.short_desc)}`,
         value: p,
-        short: `${p.name} - ${emojify(p.short_desc)}`
-      }))
+        short: `${p.name} - ${emojify(p.short_desc)}`,
+      })),
     },
     {
-      name: 'action',
-      type: 'list',
-      choices: ['info', 'install', 'back', 'exit'],
-      default: 'info'
-    }
-  ])
+      name: "action",
+      type: "list",
+      choices: ["info", "install", "back", "exit"],
+      default: "info",
+    },
+  ]);
 
 const installedPluginsList = async () => {
-  const installed = await getConfigPlugins()
+  const installed = await getConfigPlugins();
 
   return inquirer.prompt([
     {
-      name: 'plugin',
-      type: 'list',
+      name: "plugin",
+      type: "list",
       choices: installed.map((p) => {
         return {
           name: getPlugNameFromConfig(p),
-          value: p
-        }
-      })
+          value: p,
+        };
+      }),
     },
     {
-      name: 'action',
-      type: 'list',
-      choices: ['info', 'uninstall', 'back', 'exit']
-    }
-  ])
-}
+      name: "action",
+      type: "list",
+      choices: ["info", "uninstall", "back", "exit"],
+    },
+  ]);
+};
 
 const menuSelection = () =>
   inquirer.prompt([
     {
-      name: 'command',
-      type: 'list',
-      choices: ['query', 'list', 'update', 'exit'],
-      default: 'query'
-    }
-  ])
+      name: "command",
+      type: "list",
+      choices: ["query", "list", "update", "exit"],
+      default: "query",
+    },
+  ]);
 
 module.exports = {
   askForVimInfo,
   askForQuery,
   askPluginSelection,
   installedPluginsList,
-  menuSelection
-}
+  menuSelection,
+};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wallerbuilt/vaq",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A cli for managing vim plugins through vim-plug",
   "main": "index.js",
   "private": false,