├── .gitignore
├── README.md
├── index.js
├── modhelp1.gif
└── package.json


/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # modhelp
 2 | 
 3 | <img src="modhelp1.gif"/>
 4 | 
 5 | Uses `marked-terminal` to render a README.md for any `npm` module in the terminal.
 6 | 
 7 | Now with built-in pager!  Page up/down, arrow keys to scroll line-by-line, q to quit.  I added this because piping to `less`, even with -r, doesn't work right with ANSI escape codes.
 8 | 
 9 | ## Install
10 | 
11 | ```sh
12 | npm install -g modhelp
13 | ```
14 | 
15 | ## Usage
16 | 
17 | ```sh
18 | modhelp themodule
19 | ```
20 | 
21 | [Tiny Villages: Horizontally Scaling Society](http://runvnc.github.io/tinyvillage)
22 | 


--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env node
  2 | function dt() { process.stdout.write('.'); }
  3 | 
  4 | dt();
  5 | 
  6 | get = require('http-get-shim');
  7 | dt();
  8 | 
  9 | var marked = require('marked');
 10 | dt();
 11 | 
 12 | term = require('terminal-kit').terminal;
 13 | dt();
 14 | 
 15 | TerminalRenderer = require('marked-terminal');
 16 | dt();
 17 | 
 18 | marked.setOptions({ 
 19 |   renderer: new TerminalRenderer() 
 20 | }); 
 21 | dt();
 22 | 
 23 | var mod = process.argv[2];
 24 | 
 25 | var lines = [];
 26 | var line = 0;
 27 | 
 28 | var rows = term.height - 1;
 29 | var pageNum = 1;
 30 | var lastShown = 0;
 31 | 
 32 | var nextStatus = '';
 33 | 
 34 | function statusLine(str) {
 35 |   term.moveTo(1,term.height);
 36 |   if (!str) str = "q: quit, n/p/pgup/pgdown, up/down arrow|j/k: scroll, /: search" +
 37 |       "  Line " + (line+1) + " of " + lines.length;
 38 |   term.eraseLine();
 39 |   term.dim.bgBlack.white(str);
 40 |   term.column(1);               
 41 | }
 42 | 
 43 | var searched = '';
 44 | function search(text) {
 45 |   searched = text;
 46 |   statusLine('Searching for "'+text+'"');
 47 |   setTimeout(function() {
 48 |     var found = false;
 49 |     var l = line;
 50 |     do {
 51 |       l++;
 52 |       found = l<lines.length &&lines[l].indexOf(text)>=0;
 53 |     } while (!found && l < lines.length);
 54 |    if (found) {
 55 |      line = l;
 56 |      nextStatus = 'Found ' + text;
 57 |      showPage(l);
 58 |    } else {
 59 |      statusLine('Not found.');
 60 |    }
 61 |  }, 1);
 62 | }
 63 | 
 64 | function showPage(startLine) {
 65 |   term.clear();
 66 |   var endLine = startLine + rows;
 67 |   var i = startLine;
 68 | 
 69 |   function inner() {
 70 |     if (i < lines.length -1) {
 71 |       console.log(lines[i]);
 72 |     }
 73 |     if (i-startLine < (rows-3)) {
 74 |       i+=1;
 75 |       inner();
 76 |     } else {
 77 |       term.getCursorLocation(function(err, x, y) {
 78 |         if (y < rows-1 && i < endLine && i<lines.length-1) {
 79 |           i += 1;
 80 |           inner();
 81 |         } else {
 82 |           statusLine(nextStatus);
 83 |           if (nextStatus) nextStatus = '';
 84 |           lastShown = i;
 85 |         }
 86 |       });
 87 |     }
 88 |   }
 89 |   inner();
 90 | }
 91 | 
 92 | function showLine(line) {
 93 |   if (line < lines.length-1) {
 94 |     term.moveTo(1, term.height);
 95 |     term.eraseLine();
 96 |     console.log(lines[line]);
 97 |   }
 98 |   statusLine();
 99 | }
100 | 
101 | var tries = 0;
102 | var inp = true;
103 | 
104 | function load(readme) {
105 |   dt();
106 |   var rendered = marked(readme);
107 |   lines = rendered.split('\n');
108 |   dt();
109 |   console.log();
110 | 
111 |   term.grabInput(true);
112 | 
113 |   term.on('key', function(name, matches, data) {
114 |     if (!inp) return false;
115 |     switch (name) {
116 |       case 'q':
117 |         term.grabInput(false);
118 |         process.exit(0);
119 |         break;
120 |       case 'j':
121 |       case 'DOWN':
122 |         if (line < lines.length-1) line += 1;
123 |         if (lastShown < line+rows-1) {
124 |           lastShown += 1;
125 |           showLine(lastShown);
126 |         } else {
127 |           showLine(line+rows-1);
128 |         }
129 |         break;
130 |       case 'k':
131 |       case 'UP':
132 |         if (line > 0) {
133 |           line -= 1;
134 |           term.moveTo(1,1);
135 |           term.insertLine(1);
136 |           term.moveTo(1,1);
137 |           console.log(lines[line]);
138 |           statusLine();
139 |         }
140 |         break;
141 |       case 'p':
142 |       case 'PAGE_UP':
143 |         if (line > 0) line -= Math.round(rows/2);
144 |         if (line < 0) line = 0;
145 |         showPage(line); 
146 |         break;
147 |       case 'n':
148 |       case 'PAGE_DOWN':
149 |         if (line < lines.length-1) line += Math.round(rows/2);
150 |         if (line > lines.length-1) line = lines.length-rows-1;
151 |         if (lastShown+1<line) {
152 |           lastShown +=1;
153 |           line = lastShown;
154 |         }
155 |         showPage(line);
156 |         break;
157 |       case '/':
158 |         //term.grabInput(false);
159 |         inp = false;
160 |         term.moveTo(1,term.height);
161 |         term.eraseLine();
162 |         term.dim.bgBlack.white("Enter search text (or enter to repeat last): "); 
163 |         term.inputField({echo:true},function(er,text) {
164 |           if (!text || text.length==0) text = searched;
165 |           inp = true;
166 |           term.grabInput(true);
167 |           search(text);
168 |         });        
169 |         break;
170 |     }
171 |   });
172 |   if (lines.length < rows) {
173 |     console.log(rendered);
174 |     term.grabInput(false);
175 |     process.exit();
176 |   } else {
177 |     showPage(0);
178 |   }
179 | }
180 | 
181 | get('http://registry.npmjs.com/'+mod, function(e,r,pkg) {
182 |   pkg = JSON.parse(pkg);
183 |   load(pkg.readme);
184 | });
185 | 
186 | 


--------------------------------------------------------------------------------
/modhelp1.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/runvnc/modhelp/fea752095b67a7d0f5cf0550785f8b4e2edd4d9e/modhelp1.gif


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "modhelp",
 3 |   "version": "5.2.0",
 4 |   "description": "Show ANSI-colored module READMEs in terminal.",
 5 |   "bin": {
 6 |     "modhelp": "./index.js"
 7 |   },
 8 |   "dependencies": {
 9 |     "http-get-shim": "^0.1.1",
10 |     "marked": "^0.3.2",
11 |     "marked-terminal": "^1.1.2",
12 |     "terminal-kit": "^0.9.8"
13 |   },
14 |   "repository": {
15 |     "type": "git",
16 |     "url": "git@github.com:runvnc/modhelp"
17 |   },
18 |   "keywords": [
19 |     "readme",
20 |     "manpm",
21 |     "man-n",
22 |     "man",
23 |     "npm",
24 |     "cli",
25 |     "utility",
26 |     "module",
27 |     "help",
28 |     "markdown",
29 |     "npm-man",
30 |     "terminal",
31 |     "usage"
32 |   ],
33 |   "devDependencies": {},
34 |   "scripts": {
35 |     "test": "echo \"Error: no test specified\" && exit 1"
36 |   },
37 |   "author": "Jason Livesay",
38 |   "license": "ISC"
39 | }
40 | 


--------------------------------------------------------------------------------