Update comments

cameron93lin · cameron93lin · commit c8d2760b3b42 · 2020-07-05T11:36:10.000-07:00
diff --git a/lib/commands/list.js b/lib/commands/list.js
@@ -75,6 +75,7 @@ cmd.handler = function(argv) {
       }
       problems = problems.filter(x => x.name.toLowerCase().includes(word));
     }
+    //prepare for csvWriter
     const csvWriter = createCsvWriter({
       path: argv.output,
       header: [
@@ -101,6 +102,7 @@ cmd.handler = function(argv) {
       if (problem.locked) ++stat.locked;
       if (problem.starred) ++stat.starred;
 
+      //build data for csvWriter
       if(argv.csv){
         if(problem.companyStats!=null){
           data.push( {id:problem.fid,
@@ -121,9 +123,6 @@ cmd.handler = function(argv) {
             level: problem.level,
             tags: problem.tags,
             companies: problem.companies,
-            // companies06: problem.companyStats["1"].join(','),
-            // companies612: problem.companyStats["1"].join(',')+problem.companyStats["2"].join(','),
-            // companies1224: problem.companyStats["1"].join(',')+problem.companyStats["2"].join(',')+problem.companyStats["3"].join(','),
             percent: problem.percent.toFixed(2),
             category: problem.category
           });
@@ -158,7 +157,7 @@ cmd.handler = function(argv) {
           log.printf('%12s%s', ' ', chalk.gray(buf.join(' | ')));
       }
     }
-
+    //write data to csv
     if(argv.csv){
       csvWriter
       .writeRecords(data)
diff --git a/lib/plugins/leetcode.js b/lib/plugins/leetcode.js
@@ -80,7 +80,7 @@ plugin.getProblems = function(cb) {
 
 plugin.getCategoryProblems = function(category, cb) {
   const user = session.getUser();
-  if (!user.paid){
+  if (!user.paid){ // for non-vip user, use restful api method.
     log.debug('running leetcode.getCategoryProblems: ' + category);
     const opts = plugin.makeOpts(config.sys.urls.problems.replace('$category', category));
   
@@ -120,6 +120,7 @@ plugin.getCategoryProblems = function(category, cb) {
     });
   }
   else{
+    // for vip user, use graphql api method to get company related info.
     log.debug('running leetcode.getCategoryProblems with Paid User: ' + category);
   
     category = category.charAt(0).toUpperCase() + category.slice(1)
@@ -139,6 +140,8 @@ plugin.getCategoryProblems = function(category, cb) {
       if (e) return cb(e);
 
       const json = body;
+      
+      // generate problem list with stared.
       var starList =[]
       for(var favorList in json.data.favoritesLists.privateFavorites){
         for(var question in favorList.questions){
@@ -151,6 +154,7 @@ plugin.getCategoryProblems = function(category, cb) {
           .filter(p => p.categoryTitle==category)
           .map(function(p) {
             var stats = JSON.parse(p.stats)
+            // generate companyStats value.
             var companyStats = JSON.parse(p.companyTagStats)
             for (var val in companyStats){
               companyStats[val] = companyStats[val].map(function(p){
