Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Provide more details in dot api #850

Merged
merged 2 commits into from
Oct 3, 2019
Merged

Provide more details in dot api #850

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d0f9aa
Provide more details in dot api
Mark1626 Sep 30, 2019
f7d24a6
Replace newline with os.EOL
Mark1626 Oct 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 59 additions & 5 deletions lib/repl/repl.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ const util = require('util');
const { aEval } = require('./awaitEval');
const { initSearch } = require('./repl-search');
const { removeQuotes, symbols } = require('../util');
const { EOL } = require('os');
const funcs = {};
let commands = [];
const stringColor = util.inspect.styles.string;
Expand Down Expand Up @@ -262,13 +263,27 @@ function displayTaiko() {
function displayUsageFor(name) {
const e = doc.find(e => e.name === name);
if (!e) {
console.log(`Function ${name} doesn't exist.`);
console.log(`Function ${name} doesn't exist.${EOL}`);
return;
}
console.log();
console.log(desc(e.description));
if (e.deprecated) {
console.log(`${EOL}DEPRECATED ${desc(e.deprecated)}${EOL}`);
}
console.log(`${desc(e.description)}${EOL}`);
if (e.params.length > 0) {
console.log(e.params.length > 1 ? 'Parameters:' : 'Parameter:');
console.log(`${EOL}${params(e.params)}${EOL}`);
}
if (e.returns) {
e.returns.map(e => {
console.log(
`Returns: ${type(e.type)} ${
e.description.type ? desc(e.description) : e.description
}${EOL}`,
);
});
}
if (e.examples.length > 0) {
console.log();
console.log(e.examples.length > 1 ? 'Examples:' : 'Example:');
console.log(
e.examples
Expand All @@ -280,7 +295,6 @@ function displayUsageFor(name) {
)
.join('\n'),
);
console.log();
}
}

Expand Down Expand Up @@ -336,4 +350,44 @@ const desc = d =>
)
.join(' ');

const type = t => {
switch (t.type) {
case 'NameExpression':
return t.name;
case 'OptionalType':
return type(t.expression);
case 'RestType':
return '...' + type(t.expression);
case 'TypeApplication':
return `${type(t.expression)}<${t.applications
.map(a => type(a))
.join(',')}>`;
case 'UnionType':
return `${t.elements.map(t => type(t)).join('|')}`;
}
};

const param = p => {
const name = p.name || '';
const t = p.type ? type(p.type) + ' - ' : '';
const d =
(p.description ? desc(p.description) : p.description) || '';
const dft = p.default ? `(optional, default ${p.default})` : '';

return `${name} - ${t}${d} ${dft}${EOL}`;
};

const params = p => {
return p
.map(
p =>
'* ' +
param(p) +
(p.properties
? p.properties.map(p => ` * ${param(p)}`).join('')
: ''),
)
.join('');
};

const isTaikoFunc = keyword => keyword.split('(')[0] in funcs;