Remove the Suggestion class.

Author: vlad-shatskyi

src/Autocompletion.ts

@@ -1,7 +1,10 @@
 import {leafNodeAt, ASTNode} from "./shell/Parser";
 import * as _ from "lodash";
 import {History} from "./shell/History";
-import {Suggestion, styles, replaceAllPromptSerializer} from "./plugins/autocompletion_utils/Common";
+import {
+    styles, replaceAllPromptSerializer, Suggestion,
+    SuggestionWithDefaults, addDefaultAttributeValues,
+} from "./plugins/autocompletion_utils/Common";
 import {Environment} from "./shell/Environment";
 import {OrderedSet} from "./utils/OrderedSet";
 import {Aliases} from "./shell/Aliases";
@@ -24,9 +27,9 @@ export const getSuggestions = async({
     environment,
     historicalPresentDirectoriesStack,
     aliases,
-}: GetSuggestionsOptions): Promise<Suggestion[]> => {
+}: GetSuggestionsOptions): Promise<SuggestionWithDefaults[]> => {
     const prefixMatchesInHistory = History.all.filter(line => line.startsWith(currentText));
-    const suggestionsFromHistory = prefixMatchesInHistory.map(match => new Suggestion({
+    const suggestionsFromHistory = prefixMatchesInHistory.map(match => ({
         value: match,
         promptSerializer: replaceAllPromptSerializer,
         isFiltered: true,
@@ -44,7 +47,7 @@ export const getSuggestions = async({
     });
 
     const uniqueSuggestions = _.uniqBy([...firstThreeFromHistory, ...suggestions, ...remainderFromHistory], suggestion => suggestion.value);
-    const applicableSuggestions = uniqueSuggestions.filter(suggestion => suggestion.isFiltered || suggestion.value.toLowerCase().startsWith(node.value.toLowerCase()));
+    const applicableSuggestions: Suggestion[] = uniqueSuggestions.filter(suggestion => suggestion.isFiltered || suggestion.value.toLowerCase().startsWith(node.value.toLowerCase()));
 
     if (applicableSuggestions.length === 1) {
         const suggestion = applicableSuggestions[0];
@@ -53,10 +56,10 @@ export const getSuggestions = async({
          * The suggestion would simply duplicate the prompt value without providing no
          * additional information. Skipping it for clarity.
          */
-        if (node.value === suggestion.value && suggestion.description.length === 0 && suggestion.synopsis.length === 0) {
+        if (node.value === suggestion.value && (suggestion.description && suggestion.description.length === 0) && (suggestion.synopsis && suggestion.synopsis.length === 0)) {
             return [];
         }
     }
 
-    return applicableSuggestions.slice(0, suggestionsLimit);
+    return applicableSuggestions.slice(0, suggestionsLimit).map(addDefaultAttributeValues);
 };

src/Interfaces.ts

@@ -3,7 +3,7 @@ import {Stats} from "fs";
 import {ReactElement} from "react";
 import {Job} from "./shell/Job";
 import {Session} from "./shell/Session";
-import {PartialSuggestion} from "./plugins/autocompletion_utils/Common";
+import {Suggestion} from "./plugins/autocompletion_utils/Common";
 import {ScreenBuffer} from "./ScreenBuffer";
 import {Environment} from "./shell/Environment";
 import {OrderedSet} from "./utils/OrderedSet";
@@ -34,7 +34,7 @@ export interface AutocompletionContext extends PreliminaryAutocompletionContext
     readonly argument: Argument;
 }
 
-export type AutocompletionProvider = (context: AutocompletionContext) => Promise<PartialSuggestion[]>;
+export type AutocompletionProvider = (context: AutocompletionContext) => Promise<Suggestion[]>;
 
 export interface FileInfo {
     name: string;

src/plugins/autocompletion_providers/Brew.ts

@@ -1,6 +1,6 @@
 import {
-    styles, Suggestion, longFlag, contextIndependent,
-    emptyProvider, shortFlag, provide,
+    styles, longFlag, contextIndependent,
+    emptyProvider, shortFlag, provide, Suggestion,
 } from "../autocompletion_utils/Common";
 import combine from "../autocompletion_utils/Combine";
 import {PluginManager} from "../../PluginManager";
@@ -44,7 +44,7 @@ const formulaSuggestions = async(formulae: FormulaAttributes[],
         .filter(formula =>  !query ||
         formula.name.startsWith(query) ||
         formula.path.startsWith(query))
-        .map(formula => new Suggestion({
+        .map(formula => ({
             value: formula.name,
             displayValue: formula.name,
             synopsis: formula.path,
@@ -310,7 +310,7 @@ const brewCommands: BrewCommandData[] = [
 const fromData = (commandsData: BrewCommandData[]) =>
     contextIndependent(async() => {
         const suggestions = commandsData
-            .map(command => new Suggestion({
+            .map(command => ({
                 value: command.name,
                 description: command.description || "",
                 style: styles.command,

src/plugins/autocompletion_providers/Cd.ts

@@ -1,5 +1,5 @@
 import {expandHistoricalDirectory} from "../../shell/Command";
-import {styles, Suggestion, directoriesSuggestionsProvider} from "../autocompletion_utils/Common";
+import {styles, directoriesSuggestionsProvider, Suggestion} from "../autocompletion_utils/Common";
 import * as _ from "lodash";
 import {PluginManager} from "../../PluginManager";
 
@@ -12,7 +12,7 @@ PluginManager.registerAutocompletionProvider("cd", async(context) => {
     if (context.argument.value.startsWith("-")) {
         const historicalDirectoryAliases = ["-", "-2", "-3", "-4", "-5", "-6", "-7", "-8", "-9"]
             .slice(0, context.historicalPresentDirectoriesStack.size)
-            .map(alias => new Suggestion({
+            .map(alias => ({
                 value: alias,
                 description: expandHistoricalDirectory(alias, context.historicalPresentDirectoriesStack),
                 style: styles.directory,
@@ -26,7 +26,7 @@ PluginManager.registerAutocompletionProvider("cd", async(context) => {
     if (context.argument.value.length > 0) {
         const cdpathDirectories = _.flatten(await Promise.all(context.environment.cdpath
             .filter(directory => directory !== context.environment.pwd)
-            .map(async(directory) => (await directoriesSuggestionsProvider(context, directory)).map(suggestion => suggestion.withDescription(`In ${directory}`)))));
+            .map(async(directory) => (await directoriesSuggestionsProvider(context, directory)).map(suggestion => ({...suggestion, description: `In ${directory}`})))));
 
         suggestions.push(...cdpathDirectories);
     }

src/plugins/autocompletion_providers/Git.ts

@@ -1,6 +1,6 @@
 import * as Git from "../../utils/Git";
 import {
-    styles, Suggestion, longAndShortFlag, longFlag, mapSuggestions, unique,
+    styles, longAndShortFlag, longFlag, mapSuggestions, unique,
     emptyProvider, SubcommandConfig, commandWithSubcommands, provide,
 } from "../autocompletion_utils/Common";
 import * as Common from "../autocompletion_utils/Common";
@@ -10,14 +10,14 @@ import {linedOutputOf, executeCommand} from "../../PTY";
 import {find, sortBy, once} from "lodash";
 
 const addOptions = combine([
-    mapSuggestions(longAndShortFlag("patch"), suggestion => suggestion.withDescription(
+    mapSuggestions(longAndShortFlag("patch"), suggestion => ({...suggestion, description:
         `Interactively choose hunks of patch between the index and the work tree and add them to the index. This gives the user a chance to review the
          difference before adding modified contents to the index.
          This effectively runs add --interactive, but bypasses the initial command menu and directly jumps to the patch subcommand. See "Interactive
-         mode" for details.`)),
-    mapSuggestions(longFlag("interactive"), suggestion => suggestion.withDescription(`
+         mode" for details.`})),
+    mapSuggestions(longFlag("interactive"), suggestion => ({...suggestion, description: `
         Add modified contents in the working tree interactively to the index. Optional path arguments may be supplied to limit operation to a subset
-        of the working tree. See "Interactive mode" for details.`)),
+        of the working tree. See "Interactive mode" for details.`})),
 ]);
 
 function doesLookLikeBranchAlias(word: string) {
@@ -187,7 +187,7 @@ const commitOptionsData: OptionData[] = [
 
 const commitOptions = combine(commitOptionsData.map(({ longFlag, shortFlag, noShortFlag, description }) => {
     const provider = noShortFlag ? Common.longFlag(longFlag) : longAndShortFlag(longFlag, shortFlag);
-    return mapSuggestions(provider, suggestion => suggestion.withDescription(description));
+    return mapSuggestions(provider, suggestion => ({...suggestion, description}));
 }));
 
 const pushOptions = combine([
@@ -248,7 +248,7 @@ const commonMergeOptions = combine([
 const remotes = provide(async context => {
     if (Git.isGitDirectory(context.environment.pwd)) {
         const names = await Git.remotes(context.environment.pwd);
-        return names.map(name => new Suggestion({value: name, style: styles.branch}));
+        return names.map(name => ({value: name, style: styles.branch}));
     }
 
     return [];
@@ -257,7 +257,7 @@ const remotes = provide(async context => {
 const configVariables = unique(provide(async context => {
     const variables = await Git.configVariables(context.environment.pwd);
 
-    return variables.map(variable => new Suggestion({value: variable.name, description: variable.value, style: styles.option}));
+    return variables.map(variable => ({value: variable.name, description: variable.value, style: styles.option}));
 }));
 
 const branchesExceptCurrent = provide(async context => {
@@ -268,7 +268,7 @@ const branchesExceptCurrent = provide(async context => {
             tags: false,
         }));
         const nonCurrentBranches = allBranches.filter(branch => !branch.isCurrent());
-        return nonCurrentBranches.map(branch => new Suggestion({value: branch.toString(), style: styles.branch}));
+        return nonCurrentBranches.map(branch => ({value: branch.toString(), style: styles.branch}));
     } else {
         return [];
     }
@@ -278,7 +278,7 @@ const branchAlias = provide(async context => {
     if (doesLookLikeBranchAlias(context.argument.value)) {
         let nameOfAlias = (await linedOutputOf("git", ["name-rev", "--name-only", canonizeBranchAlias(context.argument.value)], context.environment.pwd))[0];
         if (nameOfAlias && !nameOfAlias.startsWith("Could not get")) {
-            return [new Suggestion({value: context.argument.value, synopsis: nameOfAlias, style: styles.branch})];
+            return [{value: context.argument.value, synopsis: nameOfAlias, style: styles.branch}];
         }
     }
 
@@ -288,7 +288,7 @@ const branchAlias = provide(async context => {
 const notStagedFiles = unique(provide(async context => {
     if (Git.isGitDirectory(context.environment.pwd)) {
         const fileStatuses = await Git.status(context.environment.pwd);
-        return fileStatuses.map(fileStatus => new Suggestion({value: fileStatus.value, style: styles.gitFileStatus(fileStatus.code)}));
+        return fileStatuses.map(fileStatus => ({value: fileStatus.value, style: styles.gitFileStatus(fileStatus.code)}));
     } else {
         return [];
     }

src/plugins/autocompletion_providers/Grep.ts

@@ -1,7 +1,7 @@
 import {PluginManager} from "../../PluginManager";
 import {
     longFlag, longAndShortFlag, mapSuggestions, anyFilesSuggestionsProvider,
-    Suggestion, styles, anyFilesSuggestions, directoriesSuggestions, provide,
+    styles, anyFilesSuggestions, directoriesSuggestions, provide,
 } from "../autocompletion_utils/Common";
 import combine from "../autocompletion_utils/Combine";
 import {io, mapObject} from "../../utils/Common";
@@ -207,24 +207,29 @@ const baseOptions = combine(mapObject(
     },
     (option, info) => {
         if (info.short) {
-            return mapSuggestions(longAndShortFlag(option, info.short),
-                                  suggestion => suggestion.withDescription(info.description));
+            return mapSuggestions(
+                longAndShortFlag(option, info.short),
+                suggestion => ({...suggestion, description: info.description}),
+            );
         } else {
-            return mapSuggestions(longFlag(option),
-                                  suggestion => suggestion.withDescription(info.description));
+            return mapSuggestions(
+                longFlag(option),
+                suggestion => ({...suggestion, description: info.description}),
+            );
         }
     },
 ));
 
 const extendedRegexOption = combine([
-    mapSuggestions(longAndShortFlag("extended-regexp", "E"), suggestion => suggestion.withDescription(`
-        Interpret <pattern> (defined using --regexp=<pattern> as an extended regular expression`)),
+    mapSuggestions(
+        longAndShortFlag("extended-regexp", "E"),
+        suggestion => ({...suggestion, description: `Interpret <pattern> (defined using --regexp=<pattern> as an extended regular expression`})),
 ]);
 
 const fixedStringsOption = combine([
-    mapSuggestions(longAndShortFlag("fixed-strings", "F"), suggestion => suggestion.withDescription(`
-        Interpret <pattern> (defined using --regexp=<pattern>) as a list of fixed strings, separated
-        by new-lines lines, any of which is to be matched`)),
+    mapSuggestions(
+        longAndShortFlag("fixed-strings", "F"),
+        suggestion => ({...suggestion, description: `Interpret <pattern> (defined using --regexp=<pattern>) as a list of fixed strings, separated by new-lines lines, any of which is to be matched`})),
 ]);
 
 const binaryFilesValues = [
@@ -307,9 +312,12 @@ const fixedValueSuggestions = provide(async context => {
     } else {
         return [];
     }
-    return optionValues.map(item =>
-        new Suggestion({value: "--" + item.flag + "=" + item.displayValue, displayValue: item.displayValue,
-                        description: item.description, style: styles.optionValue}));
+    return optionValues.map(item => ({
+        value: "--" + item.flag + "=" + item.displayValue,
+        displayValue: item.displayValue,
+        description: item.description,
+        style: styles.optionValue,
+    }));
 });
 
 const fileValueSuggestions = provide(async context => {
@@ -321,7 +329,7 @@ const fileValueSuggestions = provide(async context => {
         const optionValue = token.slice(tokenValue.length);
         const fileSuggestions = await anyFilesSuggestions(optionValue, workingDirectory);
         return fileSuggestions.map(item =>
-                new Suggestion({value: tokenValue + item.value, displayValue: item.displayValue,
+                ({value: tokenValue + item.value, displayValue: item.displayValue,
                     style: io.directoryExists(workingDirectory + item.value) ? styles.directory : styles.optionValue}));
     } else {
         return [];
@@ -336,9 +344,11 @@ const excludeFromSuggestions = provide(async context => {
         const workingDirectory = context.environment.pwd;
         const optionValue = token.slice(tokenValue.length);
         const fileSuggestions = await anyFilesSuggestions(optionValue, workingDirectory);
-        return fileSuggestions.map(item =>
-                new Suggestion({value: tokenValue + item.value, displayValue: item.displayValue,
-                    style: io.directoryExists(workingDirectory + item.value) ? styles.directory : styles.optionValue}));
+        return fileSuggestions.map(item => ({
+            value: tokenValue + item.value,
+            displayValue: item.displayValue,
+            style: io.directoryExists(workingDirectory + item.value) ? styles.directory : styles.optionValue,
+        }));
     } else {
         return [];
     }
@@ -353,7 +363,7 @@ const excludeDirSuggestions = provide(async context => {
         const optionValue = token.slice(tokenValue.length);
         const directorySuggestions = await directoriesSuggestions(optionValue, workingDirectory);
         return directorySuggestions.map(item =>
-                new Suggestion({value: tokenValue + item.value, displayValue: item.displayValue,
+                ({value: tokenValue + item.value, displayValue: item.displayValue,
                     style: styles.directory}));
     } else {
         return [];

src/plugins/autocompletion_providers/NPM.ts

@@ -1,5 +1,5 @@
 import * as Path from "path";
-import {Suggestion, styles, commandWithSubcommands} from "../autocompletion_utils/Common";
+import {styles, commandWithSubcommands} from "../autocompletion_utils/Common";
 import {io, mapObject} from "../../utils/Common";
 import {PluginManager} from "../../PluginManager";
 import {AutocompletionContext} from "../../Interfaces";
@@ -152,7 +152,7 @@ const npmCommandConfig = [
             const packageFilePath = Path.join(context.environment.pwd, "package.json");
             if (await io.fileExists(packageFilePath)) {
                 const parsed = JSON.parse(await io.readFile(packageFilePath)).scripts || {};
-                return mapObject(parsed, (key: string, value: string) => new Suggestion({
+                return mapObject(parsed, (key: string, value: string) => ({
                     value: key,
                     description: value,
                     style: styles.command,