Setting noErrorTruncation to false truncates inferred type of variables/functions; which are not errors

TypeScript Version: 3.0.1

Search Terms: noErrorTruncation

In TS 2.9, if noErrorTruncation is unset, or set to false, hovering the cursor over an identifier for type inference in VS code would bring up a tooltip with the inferred type.

In TS 3.0, if noErrorTruncation is unset, or set to false, the tooltip with the inferred type will be truncated with ellipsis.

Code

TS 2.9, with noErrorTruncation : false

    /*snip*/
    __canAccept: {
        page?: string | number | null | undefined;
        itemsPerPage?: string | number | null | undefined;
    };
}

TS 3.0 with noErrorTruncation : false

    /*snip*/
    __canAccept: {
        ...;
    };
}

Expected behavior:

noErrorTruncation is about truncating errors.

The tooltips displaying inferred types aren't errors, and should not be affected by this flag.

Actual behavior:

noErrorTruncation affects tooltips displaying inferred types.

If anyone else is having this problem, just go to your tsconfig.json, add the following line,

"noErrorTruncation": true,

and restart VS code (or your editor of choice)

Weird. I thought I finally "fixed" it but, even with noErrorTruncation turned on, some long and complicated types still show up with ellipsis.

Is there a noInferredTypeTruncation thing I'm missing?

Turning on noErrorTruncation certainly stops some truncations, but it still doesn't prevent others.

Weird. I thought I finally "fixed" it but, even with noErrorTruncation turned on, some long and complicated types still show up with ellipsis.

The same for me. TypeScript 3.2.2

I'm pretty sure it has something to do with createElidedInformationPlaceholder

one solution (that are not fast on the project that i works, because needs to load a bunch of things, but works very well) is the extension ts type expand.

https://github.com/d-kimuson/ts-type-expand

Thanks again for the hack!

I just wanted to call out that if your VSCode config specifies the "typescript.tsdk" option, you'll need to update the tsserver.ts in whatever location that option specifies. It would have saved me a bit of debugging time 🙃

Thank you!

A little more context that I think is worth sharing... setting noErrorTruncation to true can cause some significant performance implications with errors.

I just spent 20 minutes trying to figure out why an error was popping up in my console but not inline where the error was... went over to GitHub to comment on a few things and let it sit and the error finally popped up and it clicked 🙃

I'm definitely keeping it set to true for usability but now have to remember that it can cause debugging issues with really complicated types ☹️

Ivens Joris (@vensauro)

I just wanted to call out that if your VSCode config specifies the "typescript.tsdk" option, you'll need to update the tsserver.ts in whatever location that option specifies. It would have saved me a bit of debugging time 🙃

Thank you for saying this because you saved me a lot of time! Slight correction, though: it's named tsserver.js

If for nothing else, I thought this was worth reporting for the irony: in my case, the ... was truncating a three character number.

Ivens Joris (@vensauro) That extension doesn't seem to work anymore. Shame, because it looks really useful.

There is one awesome extension that is just enormously cool. It allows to explore "compiled" versions of very complex types

It allows to explore not only types and interfaces, but literally anything: vars, functions, classes, promises, generics

Name: TypeScript Explorer
Id: mxsdev.typescript-explorer
Description: Full type information for variables, components, functions, and more in TypeScript projects!
Version: 0.4.0
Publisher: mxs
VS Marketplace Link: https://marketplace.visualstudio.com/items?itemName=mxsdev.typescript-explorer

function UsePromiseAllMappedTrace<
  TInputArrayElement,
  TReturnArrayElement,
>(
  arrayToMap: TInputArrayElement[],
  elementGetter: (
    currentTraceNode: IPublicActionTraceNode,
    arrayElement: TInputArrayElement,
    index: number,
  ) => Promise<TReturnArrayElement>,
): (parentTraceNode: IPublicActionTraceNode) => Promise<TReturnArrayElement[]> {}

Hati (@Hati-)

Thanks for the hack Hati (@Hati-),
Another gotcha I found is that if you're using VSCode on the WSL2, your tsserver.js is located here:

~/.vscode-server/bin/*SOME_HASH_HERE*/extensions/node_modules/typescript/lib/tsserver.js

Here's a quick bash script I use to quickly switch back and forth to avoid any performance issues with high values on the truncation:

#!/bin/bash

if [ $# -lt 1 ]; then
  echo "Usage: $0 <directory_path> <new_length>?"
  exit 1
fi

directory_path="$1"
new_length="$2"

if [ -z "$2" ]
  then
    echo "No length supplied, will use default (160)"
    new_length=160
fi

file_path=$(find "$directory_path" -name "tsserver.js" 2>/dev/null)
if [ -z "$file_path" ]; then
  echo "tsserver.js file not found within directory $file_path after recursive search"
  exit 1
fi

echo "Found tsserver.js at \"$file_path\""

sed -i "s/var defaultMaximumTruncationLength = [0-9]\+;/var defaultMaximumTruncationLength = $new_length;/" "$file_path"

echo "Length updated successfully: "
cat $file_path | grep "defaultMaximumTruncationLength = "

Executing it with just the dir will result in resetting it to the default value of 160:

changeTypescriptHintLength.sh ~/.vscode-server

Executing it with a second argument will change it

changeTypescriptHintLength.sh ~/.vscode-server 800

Note: restarting the TS server is enough for the changes to take effect, no need to restart the entire VSCode.

Zetxus

This is awesome Zetxus - thanks so much!

For me, the path name has spaces in it which was upsetting the sed command (I couldn't work out why), so with the help of chatGPT I managed to refactor it to use awk. Sharing here for others:

#!/bin/bash

if [ $# -lt 1 ]; then
  echo "Usage: $0 <directory_path> <new_length>?"
  exit 1
fi

directory_path="$1"
new_length="$2"

if [ -z "$2" ]
  then
    echo "No length supplied, will use default (160)"
    new_length=160
fi

file_path=$(find "$directory_path" -name "tsserver.js" 2>/dev/null)
if [ -z "$file_path" ]; then
  echo "tsserver.js file not found within directory $directory_path after recursive search"
  exit 1
fi

echo "Found tsserver.js at \"$file_path\""

# Use awk to perform the replacement
awk -v new_length="$new_length" '{sub(/var defaultMaximumTruncationLength = [0-9]+;/, "var defaultMaximumTruncationLength = " new_length ";")}1' "$file_path" > temp_file && mv temp_file "$file_path"

echo "Length updated successfully: "
cat "$file_path" | grep "defaultMaximumTruncationLength = "

Zetxus

This is awesome Zetxus - thanks so much!

For me, the path name has spaces in it which was upsetting the sed command (I couldn't work out why), so with the help of chatGPT I managed to refactor it to use awk. Sharing here for others:

#!/bin/bash

if [ $# -lt 1 ]; then
  echo "Usage: $0 <directory_path> <new_length>?"
  exit 1
fi

directory_path="$1"
new_length="$2"

if [ -z "$2" ]
  then
    echo "No length supplied, will use default (160)"
    new_length=160
fi

file_path=$(find "$directory_path" -name "tsserver.js" 2>/dev/null)
if [ -z "$file_path" ]; then
  echo "tsserver.js file not found within directory $directory_path after recursive search"
  exit 1
fi

echo "Found tsserver.js at \"$file_path\""

# Use awk to perform the replacement
awk -v new_length="$new_length" '{sub(/var defaultMaximumTruncationLength = [0-9]+;/, "var defaultMaximumTruncationLength = " new_length ";")}1' "$file_path" > temp_file && mv temp_file "$file_path"

echo "Length updated successfully: "
cat "$file_path" | grep "defaultMaximumTruncationLength = "

Minor thing on the last line: grep "defaultMaximumTruncationLength = " "$file_path" will also work.

Just to point out, I made this change on my windows install of VS code, I set defaultMaximumTruncationLength=800 and it seem that the change was reverted recently.

What I don't understand is why typeToString is not respecting the noErrorTruncation compiler option.

  function typeToString(type, enclosingDeclaration, flags = 1048576 /* AllowUniqueESSymbolType */ | 16384 /* UseAliasDefinedOutsideCurrentScope */, writer = createTextWriter("")) {
    const noTruncation = compilerOptions.noErrorTruncation || flags & 1 /* NoTruncation */;
    const typeNode = nodeBuilder.typeToTypeNode(type, enclosingDeclaration, toNodeBuilderFlags(flags) | 70221824 /* IgnoreErrors */ | (noTruncation ? 1 /* NoTruncation */ : 0));
    if (typeNode === void 0)
      return Debug.fail("should always get typenode");
    const printer = type !== unresolvedType ? createPrinterWithRemoveComments() : createPrinterWithDefaults();
    const sourceFile = enclosingDeclaration && getSourceFileOfNode(enclosingDeclaration);
    printer.writeNode(
      4 /* Unspecified */,
      typeNode,
      /*sourceFile*/
      sourceFile,
      writer
    );
    const result = writer.getText();
    const maxLength2 = noTruncation ? noTruncationMaximumTruncationLength * 2 : defaultMaximumTruncationLength * 2;
    if (maxLength2 && result && result.length >= maxLength2) {
      return result.substr(0, maxLength2 - "...".length) + "...";
    }
    return result;
  }

something about const noTruncation = compilerOptions.noErrorTruncation || flags & 1 /* NoTruncation */; is causing it to get ignored

noTruncationMaximumTruncationLength is set to 1e6 so this should not be an issue. I have to assume that when vscode is calling the typeToString function, the flag value is causing the compiler option to be ignored.

It seems that in recent versions the "defaultMaximumTruncationLength" option is no longer present in the "tsserver.js" file.

Where is this option currently available, or where can I increase this value?

There is one awesome extension that is just enormously cool. It allows to explore "compiled" versions of very complex types

It allows to explore not only types and interfaces, but literally anything: vars, functions, classes, promises, generics

Name: TypeScript Explorer Id: mxsdev.typescript-explorer Description: Full type information for variables, components, functions, and more in TypeScript projects! Version: 0.4.0 Publisher: mxs VS Marketplace Link: https://marketplace.visualstudio.com/items?itemName=mxsdev.typescript-explorer
function UsePromiseAllMappedTrace<
  TInputArrayElement,
  TReturnArrayElement,
>(
  arrayToMap: TInputArrayElement[],
  elementGetter: (
    currentTraceNode: IPublicActionTraceNode,
    arrayElement: TInputArrayElement,
    index: number,
  ) => Promise<TReturnArrayElement>,
): (parentTraceNode: IPublicActionTraceNode) => Promise<TReturnArrayElement[]> {}

This extension simply doesn't solve the issue. You still need to manually click through this overly complex search tree. I just wanna see the full type, as plain string

It seems that in recent versions the "defaultMaximumTruncationLength" option is no longer present in the "tsserver.js" file.

Where is this option currently available, or where can I increase this value?

Same directory, but now in typescript.js

Also for anyone interested, until we have an inbuilt fix/alternative, I did find another extension you can use on vscode that expands the entire (or set length and depth) of the type when you hover over it (similar to vscode hover functionality)

This is the extension:
https://marketplace.visualstudio.com/items?itemName=MylesMurphy.prettify-ts

I went this route since currently,

auto-updates to vscode
re-installing packages

will occasionally reset the defaultMaximunTruncationLength values in these .js files, which will require you to manually update them again.

Also the most recent version of vscode's appears to sometimes ignore these values, even when set (even after reloading/restarting the server). At least that's what I was experiencing. Using this extension resolved things for me though

Navigation Menu

Repository navigation

Setting noErrorTruncation to false truncates inferred type of variables/functions; which are not errors #26238

17 remaining items

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Setting noErrorTruncation to false truncates inferred type of variables/functions; which are not errors #26238

Description

Activity

AnyhowStep commented on Aug 8, 2018

TomaszWaszczyk commented on Feb 5, 2019

AnyhowStep commented on Feb 7, 2019

17 remaining items

vensauro commented on Dec 22, 2022

JohnGemstone commented on Feb 26, 2023

SpencerKaiser commented on Apr 5, 2023

DanKaplanSES commented on Apr 22, 2023

nikelborm commented on Apr 22, 2023

zetdotdev commented on May 31, 2023

blackhaj commented on Sep 4, 2023

Tatsh commented on Sep 6, 2023

Djones4822 commented on Sep 16, 2023

devcaeg commented on Jul 17, 2024

dbersan commented on Jul 30, 2024

MilesWellsSVT commented on Jul 30, 2024

aasmal97 commented on Jul 31, 2024

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions