Mirrors/CyberChef
2
0
Fork 0
mirror of https://github.com/gchq/CyberChef synced 2025-01-07 18:18:47 +00:00
Code Issues Projects Releases Packages Wiki Activity

prefer exact matches in help function

Browse source
This commit is contained in:
d98762625 2019-03-20 10:23:03 +00:00
parent f61e33aa71
commit 8f5f3e56cb
1 changed files with 13 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/node/api.mjs
View file

@ -232,6 +232,8 @@ export function help(input) {
return null; return null;
} }
let exactMatchExists = false;
// Look for matches in operation name and description, listing name // Look for matches in operation name and description, listing name
// matches first. // matches first.
const matches = Object.keys(OperationConfig) const matches = Object.keys(OperationConfig)
@ -240,15 +242,23 @@ export function help(input) {
const hydrated = OperationConfig[m]; const hydrated = OperationConfig[m];
hydrated.name = m; hydrated.name = m;
// flag up an exact name match. Only first exact match counts.
if (!exactMatchExists) {
exactMatchExists = sanitise(hydrated.name) === sanitise(searchTerm);
}
// Return hydrated along with what type of match it was // Return hydrated along with what type of match it was
return { return {
hydrated, hydrated,
nameExactMatch: sanitise(hydrated.name) === sanitise(searchTerm),
nameMatch: sanitise(hydrated.name).includes(sanitise(searchTerm)), nameMatch: sanitise(hydrated.name).includes(sanitise(searchTerm)),
descMatch: sanitise(hydrated.description).includes(sanitise(searchTerm)) descMatch: sanitise(hydrated.description).includes(sanitise(searchTerm))
}; };
}) })
// Filter out non-matches // Filter out non-matches. If exact match exists, filter out all others.
.filter((result) => { .filter((result) => {
if (exactMatchExists) {
return !!result.nameExactMatch;
}
return result.nameMatch || result.descMatch; return result.nameMatch || result.descMatch;
}) })
// sort results with name match first // sort results with name match first
@ -260,9 +270,8 @@ export function help(input) {
// extract just the hydrated config // extract just the hydrated config
.map(result => result.hydrated); .map(result => result.hydrated);
// Concatenate matches but remove duplicates
if (matches && matches.length) { if (matches && matches.length) {
console.log(`${matches.length} results found.`); console.log(`${matches.length} result${matches.length > 1 ? "s" : ""} found.`);
return matches; return matches;
} }
@ -273,10 +282,9 @@ export function help(input) {
/** /**
* bake [Wrapped] - Perform an array of operations on some input. * bake [Wrapped] - Perform an array of operations on some input.
* @param operations array of chef's operations (used in wrapping stage)
* @returns {Function} * @returns {Function}
*/ */
export function bake(operations){ export function bake(){
/** /**
* bake * bake