summaryrefslogtreecommitdiff
path: root/tools/eslint/node_modules/shelljs/scripts/generate-docs.js
blob: f777c8ad2636129856e86e3d205fe3469c17abbf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
#!/usr/bin/env node
/* globals cat, cd, echo, grep, sed, ShellString */
require('../global');

echo('Appending docs to README.md');

cd(__dirname + '/..');

// Extract docs from shell.js
var docs = grep('^//@', 'shell.js');

// Now extract docs from the appropriate src/*.js files
docs = docs.replace(/\/\/@include (.+)/g, function (match, path) {
  var file = path.match('.js$') ? path : path + '.js';
  return grep('^//@', file);
});

// Remove '//@'
docs = docs.replace(/\/\/@ ?/g, '');

// Wipe out the old docs
ShellString(cat('README.md').replace(/## Command reference(.|\n)*\n## Team/, '## Command reference\n## Team')).to('README.md');

// Append new docs to README
sed('-i', /## Command reference/, '## Command reference\n\n' + docs, 'README.md');

echo('All done.');