Slight refactor

Author: J-Fields

src/cmd_line/commands/let.ts

@@ -227,7 +227,7 @@ export class LetCommand extends ExCommand {
               'vim_did_enter',
             ]
         ) {
-          throw VimError.fromCode(ErrorCode.CannotChangeReadOnlyVariable);
+          throw VimError.fromCode(ErrorCode.CannotChangeReadOnlyVariable); // TODO: Include variable name
         }
         context.setVariable(variable, newValue(variable, value), this.args.lock);
       } else if (variable.type === 'register') {

src/error.ts

@@ -1,7 +1,3 @@
-interface IErrorMessage {
-  [index: number]: string;
-}
-
 export enum ErrorCode {
   InvalidAddress = 14,
   InvalidExpression = 15,
@@ -97,99 +93,103 @@ export enum ErrorCode {
   ListRequiredForArgument = 1211,
 }
 
-export const ErrorMessage: IErrorMessage = {
-  14: 'Invalid address',
-  15: 'Invalid expression',
-  16: 'Invalid range',
-  20: 'Mark not set',
-  23: 'No alternate file',
-  29: 'No inserted text yet',
-  32: 'No file name',
-  33: 'No previous substitute regular expression',
-  34: 'No previous command',
-  35: 'No previous regular expression',
-  37: 'No write since last change (add ! to override)',
-  46: 'Cannot change read-only variable',
-  93: 'More than one match',
-  94: 'No matching buffer',
-  108: 'No such variable',
-  114: 'Missing quote',
-  117: 'Unknown function',
-  118: 'Too many arguments for function',
-  119: 'Not enough arguments for function',
-  121: 'Undefined variable',
-  208: 'Error writing to file',
-  211: 'File no longer available', // TODO: Should be `File "[file_name]" no longer available`
-  223: 'Recursive mapping',
-  348: 'No string under cursor',
-  353: 'Nothing in register',
-  354: 'Invalid register name',
-  384: 'Search hit TOP without match for',
-  385: 'Search hit BOTTOM without match for',
-  444: 'Cannot close last window',
-  447: 'Can\'t find file "{FILE_NAME}" in path',
-  471: 'Argument required',
-  474: 'Invalid argument',
-  475: 'Invalid argument',
-  481: 'No range allowed',
-  486: 'Pattern not found',
-  488: 'Trailing characters',
-  492: 'Not an editor command',
-  516: 'No buffers were deleted',
-  518: 'Unknown option',
-  521: 'Number required after =',
-  662: 'At start of changelist',
-  663: 'At end of changelist',
-  664: 'changelist is empty',
-  684: 'list index out of range',
-  686: 'Argument of sort() must be a List',
-  687: 'Less targets than List items',
-  688: 'More targets than List items',
-  689: 'Can only index a List, Dictionary or Blob',
-  691: 'Can only compare List with List',
-  692: 'Invalid operation for List',
-  694: 'Invalid operation for Funcrefs',
-  695: 'Cannot index a Funcref',
-  700: 'Unknown function',
-  701: 'Invalid type for len()',
-  703: 'Using a Funcref as a Number',
-  704: 'Funcref variable name must start with a capital',
-  709: '[:] requires a List or Blob value',
-  710: 'List value has more items than target',
-  711: 'List value has not enough items',
-  712: 'Argument of max() must be a List or Dictionary',
-  714: 'List required',
-  715: 'Dictionary required',
-  716: 'Key not present in Dictionary',
-  719: 'Cannot use [:] with a Dictionary',
-  721: 'Duplicate key in Dictionary',
-  726: 'Stride is zero',
-  727: 'Start past end',
-  728: 'Using a Dictionary as a Number',
-  729: 'using Funcref as a String',
-  730: 'Using List as a String',
-  731: 'Using Dictionary as a String',
-  735: 'Can only compare Dictionary with Dictionary',
-  736: 'Invalid operation for Dictionary',
-  741: 'Value is locked',
-  745: 'Using a List as a Number',
-  748: 'No previously used register',
-  804: "Cannot use '%' with Float",
-  805: 'Using a Float as a Number',
-  806: 'Using Float as a String',
-  808: 'Number or Float required',
-  896: 'Argument of map() must be a List, Dictionary or Blob',
-  897: 'List or Blob required',
-  900: 'maxdepth must be a non-negative number',
-  922: 'expected a dict',
-  923: 'Second argument of function() must be a list or a dict',
-  973: 'Blob literal should have an even number of hex characters',
-  974: 'Using a Blob as a Number',
-  977: 'Can only compare Blob with Blob',
-  978: 'Invalid operation for Blob',
-  995: 'Cannot modify existing variable',
-  996: 'Cannot lock a register',
-  1211: 'List required for argument {IDX}',
+export const ErrorMessage: Record<ErrorCode, string> = {
+  [ErrorCode.InvalidAddress]: 'Invalid address',
+  [ErrorCode.InvalidExpression]: 'Invalid expression',
+  [ErrorCode.InvalidRange]: 'Invalid range',
+  [ErrorCode.MarkNotSet]: 'Mark not set',
+  [ErrorCode.NoAlternateFile]: 'No alternate file',
+  [ErrorCode.NoInsertedTextYet]: 'No inserted text yet',
+  [ErrorCode.NoFileName]: 'No file name',
+  [ErrorCode.NoPreviousSubstituteRegularExpression]: 'No previous substitute regular expression',
+  [ErrorCode.NoPreviousCommand]: 'No previous command',
+  [ErrorCode.NoPreviousRegularExpression]: 'No previous regular expression',
+  [ErrorCode.NoWriteSinceLastChange]: 'No write since last change (add ! to override)',
+  [ErrorCode.CannotChangeReadOnlyVariable]: 'Cannot change read-only variable',
+  [ErrorCode.MultipleMatches]: 'More than one match',
+  [ErrorCode.NoMatchingBuffer]: 'No matching buffer',
+  [ErrorCode.NoSuchVariable]: 'No such variable',
+  [ErrorCode.MissingQuote]: 'Missing quote',
+  [ErrorCode.UnknownFunction_call]: 'Unknown function',
+  [ErrorCode.TooManyArgs]: 'Too many arguments for function',
+  [ErrorCode.NotEnoughArgs]: 'Not enough arguments for function',
+  [ErrorCode.UndefinedVariable]: 'Undefined variable',
+  [ErrorCode.ErrorWritingToFile]: 'Error writing to file',
+  [ErrorCode.FileNoLongerAvailable]: 'File no longer available', // TODO: Should be `File "[file_name]" no longer available`
+  [ErrorCode.RecursiveMapping]: 'Recursive mapping',
+  [ErrorCode.NoStringUnderCursor]: 'No string under cursor',
+  [ErrorCode.NothingInRegister]: 'Nothing in register',
+  [ErrorCode.InvalidRegisterName]: 'Invalid register name',
+  [ErrorCode.SearchHitTop]: 'Search hit TOP without match for',
+  [ErrorCode.SearchHitBottom]: 'Search hit BOTTOM without match for',
+  [ErrorCode.CannotCloseLastWindow]: 'Cannot close last window',
+  [ErrorCode.CantFindFileInPath]: 'Can\'t find file "{FILE_NAME}" in path',
+  [ErrorCode.ArgumentRequired]: 'Argument required',
+  [ErrorCode.InvalidArgument474]: 'Invalid argument',
+  [ErrorCode.InvalidArgument475]: 'Invalid argument',
+  [ErrorCode.NoRangeAllowed]: 'No range allowed',
+  [ErrorCode.PatternNotFound]: 'Pattern not found',
+  [ErrorCode.TrailingCharacters]: 'Trailing characters',
+  [ErrorCode.NotAnEditorCommand]: 'Not an editor command',
+  [ErrorCode.NoBuffersDeleted]: 'No buffers were deleted',
+  [ErrorCode.UnknownOption]: 'Unknown option',
+  [ErrorCode.NumberRequiredAfterEqual]: 'Number required after =',
+  [ErrorCode.AtStartOfChangeList]: 'At start of changelist',
+  [ErrorCode.AtEndOfChangeList]: 'At end of changelist',
+  [ErrorCode.ChangeListIsEmpty]: 'changelist is empty',
+  [ErrorCode.ListIndexOutOfRange]: 'list index out of range',
+  [ErrorCode.ArgumentOfSortMustBeAList]: 'Argument of sort() must be a List',
+  [ErrorCode.LessTargetsThanListItems]: 'Less targets than List items',
+  [ErrorCode.MoreTargetsThanListItems]: 'More targets than List items',
+  [ErrorCode.CanOnlyIndexAListDictionaryOrBlob]: 'Can only index a List, Dictionary or Blob',
+  [ErrorCode.CanOnlyCompareListWithList]: 'Can only compare List with List',
+  [ErrorCode.InvalidOperationForList]: 'Invalid operation for List',
+  [ErrorCode.InvalidOperationForFuncrefs]: 'Invalid operation for Funcrefs',
+  [ErrorCode.CannotIndexAFuncref]: 'Cannot index a Funcref',
+  [ErrorCode.UnknownFunction_funcref]: 'Unknown function',
+  [ErrorCode.InvalidTypeForLen]: 'Invalid type for len()',
+  [ErrorCode.UsingAFuncrefAsANumber]: 'Using a Funcref as a Number',
+  [ErrorCode.FuncrefVariableNameMustStartWithACapital]:
+    'Funcref variable name must start with a capital',
+  [ErrorCode.SliceRequiresAListOrBlobValue]: '[:] requires a List or Blob value',
+  [ErrorCode.ListValueHasMoreItemsThanTarget]: 'List value has more items than target',
+  [ErrorCode.ListValueHasNotEnoughItems]: 'List value has not enough items',
+  [ErrorCode.ArgumentOfMaxMustBeAListOrDictionary]:
+    'Argument of max() must be a List or Dictionary',
+  [ErrorCode.ListRequired]: 'List required',
+  [ErrorCode.DictionaryRequired]: 'Dictionary required',
+  [ErrorCode.KeyNotPresentInDictionary]: 'Key not present in Dictionary',
+  [ErrorCode.CannotUseSliceWithADictionary]: 'Cannot use [:] with a Dictionary',
+  [ErrorCode.DuplicateKeyInDictionary]: 'Duplicate key in Dictionary',
+  [ErrorCode.StrideIsZero]: 'Stride is zero',
+  [ErrorCode.StartPastEnd]: 'Start past end',
+  [ErrorCode.UsingADictionaryAsANumber]: 'Using a Dictionary as a Number',
+  [ErrorCode.UsingFuncrefAsAString]: 'using Funcref as a String',
+  [ErrorCode.UsingListAsAString]: 'Using List as a String',
+  [ErrorCode.UsingDictionaryAsAString]: 'Using Dictionary as a String',
+  [ErrorCode.CanOnlyCompareDictionaryWithDictionary]: 'Can only compare Dictionary with Dictionary',
+  [ErrorCode.InvalidOperationForDictionary]: 'Invalid operation for Dictionary',
+  [ErrorCode.ValueIsLocked]: 'Value is locked',
+  [ErrorCode.UsingAListAsANumber]: 'Using a List as a Number',
+  [ErrorCode.NoPreviouslyUsedRegister]: 'No previously used register',
+  [ErrorCode.CannotUseModuloWithFloat]: "Cannot use '%' with Float",
+  [ErrorCode.UsingAFloatAsANumber]: 'Using a Float as a Number',
+  [ErrorCode.UsingFloatAsAString]: 'Using Float as a String',
+  [ErrorCode.NumberOrFloatRequired]: 'Number or Float required',
+  [ErrorCode.ArgumentOfMapMustBeAListDictionaryOrBlob]:
+    'Argument of map() must be a List, Dictionary or Blob',
+  [ErrorCode.ListOrBlobRequired]: 'List or Blob required',
+  [ErrorCode.MaxDepthMustBeANonNegativeNumber]: 'maxdepth must be a non-negative number',
+  [ErrorCode.ExpectedADict]: 'expected a dict',
+  [ErrorCode.SecondArgumentOfFunction]: 'Second argument of function() must be a list or a dict',
+  [ErrorCode.BlobLiteralShouldHaveAnEvenNumberOfHexCharacters]:
+    'Blob literal should have an even number of hex characters',
+  [ErrorCode.UsingABlobAsANumber]: 'Using a Blob as a Number',
+  [ErrorCode.CanOnlyCompareBlobWithBlob]: 'Can only compare Blob with Blob',
+  [ErrorCode.InvalidOperationForBlob]: 'Invalid operation for Blob',
+  [ErrorCode.CannotModifyExistingVariable]: 'Cannot modify existing variable',
+  [ErrorCode.CannotLockARegister]: 'Cannot lock a register',
+  [ErrorCode.ListRequiredForArgument]: 'List required for argument {IDX}',
 };
 
 export class VimError extends Error {

test/error.test.ts

@@ -6,7 +6,7 @@ suite('Error', () => {
   test('error code has message', () => {
     // eslint-disable-next-line guard-for-in
     for (const errorCodeString in ErrorCode) {
-      const errorCode = Number(errorCodeString);
+      const errorCode = Number(errorCodeString) as ErrorCode;
       if (!isNaN(errorCode)) {
         assert.notStrictEqual(ErrorMessage[errorCode], undefined, errorCodeString);
       }