embarklabs/embark
2
0
Fork 0
mirror of https://github.com/embarklabs/embark.git synced 2025-02-16 15:47:25 +00:00
Code Issues Projects Releases Wiki Activity

refactor(@embark/console): convert suggestions class into typescript

Browse Source
This commit is contained in:
Iuri Matias 2018-11-13 09:19:38 -05:00
parent f206062919
commit 23f623d750
5 changed files with 108 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.eslintrc.json
View File

@ -98,7 +98,6 @@
"max-depth": "error",
"max-len": "off",
"max-lines": "off",
"max-nested-callbacks": "error",
"max-params": "off",
"max-statements": "off",
"max-statements-per-line": "off",

2
src/lib/modules/console/index.js
View File

@ -5,7 +5,7 @@ const EmbarkJS = require('embarkjs');
const IpfsApi = require('ipfs-api');
const Web3 = require('web3');
const stringify = require('json-stringify-safe');
const Suggestions = require('./suggestions');
import Suggestions from './suggestions';
class Console {
constructor(embark, options) {

80
src/lib/modules/console/suggestions.js
View File

@ -1,80 +0,0 @@
let utils = require('../../utils/utils');
class Suggestions {
constructor(embark, options) {
this.embark = embark;
this.events = embark.events;
this.plugins = options.plugins;
this.registerApi();
this.listenToEvents();
this.contracts = {};
}
registerApi() {
this.embark.registerAPICall('post', '/embark-api/suggestions', (req, res) => {
let cmd = req.body.command;
this.getSuggestions(cmd, (suggestions) => {
res.send({result: this.sortSuggestions(cmd, suggestions)});
});
});
}
listenToEvents() {
this.events.on("deploy:contract:deployed", (contract) => {
this.contracts[contract.className] = contract;
});
}
sortSuggestions(cmd, suggestions) {
// sort first the ones that match the command at the beginning of the string, then prefer smaller commands first
return suggestions.map((x) => x.original).sort((x,y) => {
let diff = x.value.indexOf(cmd) - y.value.indexOf(cmd);
if (diff !== 0) return diff;
return x.value.length - y.value.length;
});
}
getSuggestions(cmd, cb) {
if (!cmd) return cb([]);
cmd = cmd.toLowerCase();
let suggestions = [];
suggestions.push({value: 'web3.eth', command_type: "web3 object", description: "module for interacting with the Ethereum network"});
suggestions.push({value: 'web3.net', command_type: "web3 object", description: "module for interacting with network properties"});
suggestions.push({value: 'web3.shh', command_type: "web3 object", description: "module for interacting with the whisper protocol"});
suggestions.push({value: 'web3.bzz', command_type: "web3 object", description: "module for interacting with the swarm network"});
suggestions.push({value: 'web3.eth.getAccounts()', command_type: "web3 object", description: "get list of accounts"});
for (let contractName in this.contracts) {
let contract = this.contracts[contractName];
suggestions.push({value: contract.className, command_type: "web3 object", description: "contract deployed at " + contract.deployedAddress});
suggestions.push({value: "profile " + contract.className, command_type: "embark command", description: "profile " + contract.className + " contract"});
}
// TODO: make this registered through an API instead
suggestions.push({value: 'help', command_type: "embark command", description: "displays quick list of some of the available embark commands"});
suggestions.push({value: 'versions', command_type: "embark command", description: "display versions in use for libraries and tools like web3 and solc"});
suggestions.push({value: 'ipfs', command_type: "javascript object", description: "instantiated js-ipfs object configured to the current environment (available if ipfs is enabled)"});
suggestions.push({value: 'swarm', command_type: "javascript object", description: "instantiated swarm-api object configured to the current environment (available if swarm is enabled)"});
suggestions.push({value: 'web3', command_type: "javascript object", description: "instantiated web3.js object configured to the current environment"});
suggestions.push({value: 'EmbarkJS', command_type: "javascript object", description: "EmbarkJS static functions for Storage, Messages, Names, etc."});
if (cmd[cmd.length - 1] === '.') {
return this.events.request("runcode:eval", "Object.keys(" + cmd.slice(0, cmd.length - 1) + ")", (err, result) => {
if (Array.isArray(result)) {
for (let match of result) {
suggestions.push({value: cmd + match, command_type: "javascript object", description: ""});
}
}
return cb(utils.fuzzySearch(cmd, suggestions, (result) => { return result.value + " " + result.description; }));
});
}
return cb(utils.fuzzySearch(cmd, suggestions, (result) => { return result.value + " " + result.description; }));
}
}
module.exports = Suggestions;

100
src/lib/modules/console/suggestions.ts Normal file
View File

@ -0,0 +1,100 @@
const fuzzySearch = require("../../utils/utils").fuzzySearch;
interface Events {
on: any;
request: any;
}
interface EmbarkApi {
events: Events;
registerAPICall: any;
}
interface ContractsManager {
[key: string]: any;
}
interface Suggestion {
value: string;
command_type: string;
description: string;
}
type SuggestionsList = Suggestion[];
export default class Suggestions {
private embark: EmbarkApi;
private events: Events;
private contracts: ContractsManager;
constructor(embark: EmbarkApi, options?: object) {
this.embark = embark;
this.events = embark.events;
this.contracts = {};
this.registerApi();
this.listenToEvents();
}
private registerApi() {
this.embark.registerAPICall("post", "/embark-api/suggestions", (req: any, res: any) => {
const cmd: string = req.body.command || "";
this.getSuggestions(cmd, (suggestions: SuggestionsList) => {
res.send({result: this.sortSuggestions(cmd, suggestions)});
});
});
}
private listenToEvents() {
this.events.on("deploy:contract:deployed", (contract: any) => {
this.contracts[contract.className] = contract;
});
}
public sortSuggestions(cmd: string, suggestions: SuggestionsList) {
// sort first the ones that match the command at the beginning of the string, then prefer smaller commands first
return suggestions.sort((x: Suggestion, y: Suggestion) => {
const diff = x.value.indexOf(cmd) - y.value.indexOf(cmd);
if (diff !== 0) { return diff; }
return x.value.length - y.value.length;
});
}
public getSuggestions(cmd: string, cb: (results: SuggestionsList) => any) {
if (cmd === "") { return cb([]); }
cmd = cmd.toLowerCase();
const suggestions: SuggestionsList = [];
suggestions.push({value: "web3.eth", command_type: "web3 object", description: "module for interacting with the Ethereum network"});
suggestions.push({value: "web3.net", command_type: "web3 object", description: "module for interacting with network properties"});
suggestions.push({value: "web3.shh", command_type: "web3 object", description: "module for interacting with the whisper protocol"});
suggestions.push({value: "web3.bzz", command_type: "web3 object", description: "module for interacting with the swarm network"});
suggestions.push({value: "web3.eth.getAccounts()", command_type: "web3 object", description: "get list of accounts"});
Object.values(this.contracts).forEach((contract: any) => {
suggestions.push({value: contract.className, command_type: "web3 object", description: "contract deployed at " + contract.deployedAddress});
suggestions.push({value: "profile " + contract.className, command_type: "embark command", description: "profile " + contract.className + " contract"});
});
suggestions.push({value: "help", command_type: "embark command", description: "displays quick list of some of the available embark commands"});
suggestions.push({value: "versions", command_type: "embark command", description: "display versions in use for libraries and tools like web3 and solc"});
suggestions.push({value: "ipfs", command_type: "javascript object", description: "instantiated js-ipfs object configured to the current environment (available if ipfs is enabled)"});
suggestions.push({value: "swarm", command_type: "javascript object", description: "instantiated swarm-api object configured to the current environment (available if swarm is enabled)"});
suggestions.push({value: "web3", command_type: "javascript object", description: "instantiated web3.js object configured to the current environment"});
suggestions.push({value: "EmbarkJS", command_type: "javascript object", description: "EmbarkJS static functions for Storage, Messages, Names, etc."});
if (cmd[cmd.length - 1] === ".") {
return this.events.request("runcode:eval", "Object.keys(" + cmd.slice(0, cmd.length - 1) + ")", (err: any, result: any) => {
if (Array.isArray(result)) {
result.forEach((match: string) => {
suggestions.push({value: cmd + match, command_type: "javascript object", description: ""});
});
}
return cb(fuzzySearch(cmd, suggestions, (suggestion: Suggestion) => suggestion.value + " " + suggestion.description).map((x: any) => x.original));
});
}
return cb(fuzzySearch(cmd, suggestions, (suggestion: Suggestion) => suggestion.value + " " + suggestion.description).map((x: any) => x.original));
}
}

9
tslint.json
View File

@ -4,6 +4,11 @@
"tslint:recommended"
],
"jsRules": {},
"rules": {},
"rules": {
"max-line-length": [true, 200],
"interface-name": [true, "never-prefix"],
"member-ordering": [false],
"no-var-requires": false
},
"rulesDirectory": []
}
}