docs: Add explanations for option values

RSeidelsohn · Apr 10, 2023 · 766f105 · 766f105
1 parent 7923b06
commit 766f105
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -416,15 +416,15 @@ exports.init = function init(args, callback) {
 
     debugLog.log('scanning %s', args.start);
 
-    if (args.customPath) {
+    if (args.customPath) { // customPath is a path to a JSON file that defined a custom format
         args.customFormat = this.parseJson(args.customPath);
     }
 
     const optionsForReadingInstalledPackages = {
-        depth: args.direct,
-        nopeer: args.nopeer,
-        dev: true,
-        log: debugLog,
+        depth: args.direct, // How deep to traverse the dependency tree
+        nopeer: args.nopeer, // Whether or not to skip peerDependencies in output
+        dev: true, // Whether or not to include devDependencies
+        log: debugLog, // A function to log debug info
     };
 
     if (args.production || args.development) {