--pretty-er output by default #23408

DanielRosenwasser · 2018-04-14T04:08:49Z

This pull request always makes TypeScript's output --pretty when the compiler can detect whether its "output device" is appropriate for more colorful output.

If TypeScript's output is a psuedo-TTY, then it will enable today's prettified output and emit escape characters to the console; however, when piping to another file or program, it will automatically turned off.

Programs that want to specify the behavior can specifically set --pretty, or the new --diagnosticStyle flag.

This PR also affords us the room to give more variation in out emit modes. For example, with --diagnosticStyle, we could have a more colorful simple/terse mode as requested in #10745.

Fixes #10488.

weswigham

Do we... Have a way we can test this? Oh! Maybe We could write a unit test that shells out to the built local tsc and baselines the output!

Locals pretty straightforward; you got any details on what terms/apps this causes pretty by default in now?

…' option.

DanielRosenwasser · 2018-04-14T04:29:33Z

I know the last time I did this (i.e. when I originally wrote --pretty), there were issues with either Cygwin's bash terminal or MinGW. I forgot which, but I'll have to peek at that again.

Tests are Monday-Daniel-and-Wesley's problem. 😄

alfaproject · 2018-04-14T08:17:16Z

src/compiler/tsc.ts

+    function shouldBePretty(options: CompilerOptions) {
+        if ((typeof options.pretty === "undefined" && typeof options.diagnosticStyle === "undefined") || options.diagnosticStyle === DiagnosticStyle.Auto) {
+            return !!sys.writeOutputIsTty && sys.writeOutputIsTty();
+    }


alfaproject · 2018-04-14T08:17:23Z

src/compiler/commandLineParser.ts

+            pretty: DiagnosticStyle.Pretty,
+            simple: DiagnosticStyle.Simple,
+        }),
+    },


JoshuaKGoldberg · 2018-04-16T07:20:19Z

src/compiler/tsc.ts

            reportDiagnostic = createDiagnosticReporter(sys, /*pretty*/ true);
        }
    }

+    function shouldBePretty(options: CompilerOptions) {


So now there are two CLI flags that can tell tsc it's pretty. What if the user provides tsc --pretty false --diagnosticStyle pretty or tsc --pretty true --diagnosticStyle simple? Should there be a warning for providing both?

mhegazy · 2018-04-17T00:07:56Z

src/compiler/commandLineParser.ts

@@ -56,6 +56,14 @@ namespace ts {
            category: Diagnostics.Command_line_Options,
            description: Diagnostics.Stylize_errors_and_messages_using_color_and_context_experimental
        },
+        {


I would rather we do not add a new flag if we can. i think auto is just pretty === undefined.

if we really need a new value i would make pretty take boolean | "auto"

boolean | "auto" | "simple" | "styled"? (Where boolean toggles between auto and styled).

mhegazy · 2018-04-17T00:09:00Z

src/compiler/tsc.ts

+        if ((typeof options.pretty === "undefined" && typeof options.diagnosticStyle === "undefined") || options.diagnosticStyle === DiagnosticStyle.Auto) {
+            return !!sys.writeOutputIsTty && sys.writeOutputIsTty();
+        }
+        return options.diagnosticStyle === DiagnosticStyle.Pretty || options.pretty;


!! options.pretty

mhegazy

Please 1. remove the extra flag, and 2. test on chakra

DanielRosenwasser · 2018-04-18T00:03:39Z

src/compiler/sys.ts

@@ -428,6 +428,7 @@ namespace ts {
        newLine: string;
        useCaseSensitiveFileNames: boolean;
        write(s: string): void;
+        writeOutputIsTty?(): boolean;


Is this a reasonable name @weswigham?

TTY, not Tty.

mhegazy · 2018-04-18T00:12:36Z

src/compiler/tsc.ts

            reportDiagnostic = createDiagnosticReporter(sys, /*pretty*/ true);
        }
    }

+    function shouldBePretty(options: CompilerOptions) {
+        if ((typeof options.pretty === "undefined")) {


extra parens.

DanielRosenwasser · 2018-04-19T06:09:38Z

Tried it out. tsc.exe (the Chakra host-wrapped tsc) reverts to the old behavior. Like before, --pretty on tsc.exe produces garbled text when explicitly specified, but that's always been the behavior. I'm going to pull this in so we can get it in tonight's nightly release.

mhegazy · 2018-04-19T16:42:17Z

@DanielRosenwasser please update https://github.com/Microsoft/TypeScript-Handbook/blob/master/pages/Compiler%20Options.md as well.

kpreisser · 2018-04-23T08:23:52Z

Hi @DanielRosenwasser,

Like before, --pretty on tsc.exe produces garbled text when explicitly specified, but that's always been the behavior.

I guess this is because tsc.exe doesn't set the console mode on Windows to enable processing of Virtual Terminal Sequences (ENABLE_VIRTUAL_TERMINAL_PROCESSING).
Starting with Windows 10 Version 1511, this mode can be set to enable the parsing of terminal sequences, so that --pretty should work with tsc.exe on Windows 10.

(I think Node.js parses these sequences itself and then calls the corresponding APIs like SetConsoleTextAttribute, so that it works also with older Windows versions.)

Can tsc.exe be updated to set this console mode?

Thanks!

DanielRosenwasser · 2018-04-24T00:55:48Z

Thanks for the pointers, I might look into it @kpreisser!

DanielRosenwasser requested review from weswigham and mhegazy April 14, 2018 04:08

DanielRosenwasser changed the title ~~Automatically enable --pretty~~ Apr 14, 2018

DanielRosenwasser changed the title ~~Enable --pretty automatically~~ Apr 14, 2018

weswigham approved these changes Apr 14, 2018

View reviewed changes

DanielRosenwasser added 2 commits April 13, 2018 21:19

Automatically configure tsc output and provide a new 'diagnosticStyle…

bd3e854

…' option.

Accepted baselines

7fd1dda

DanielRosenwasser force-pushed the autoPretty branch from 8c5b163 to 7fd1dda Compare April 14, 2018 04:19

alfaproject reviewed Apr 14, 2018

View reviewed changes

src/compiler/commandLineParser.ts Outdated

pretty: DiagnosticStyle.Pretty,

simple: DiagnosticStyle.Simple,

}),

},

Copy link

alfaproject Apr 14, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

spacing

Fix spacing.

299002d

JoshuaKGoldberg reviewed Apr 16, 2018

View reviewed changes

mhegazy reviewed Apr 17, 2018

View reviewed changes

mhegazy approved these changes Apr 17, 2018

View reviewed changes

DanielRosenwasser commented Apr 18, 2018

View reviewed changes

flags--;

6953fa1

mhegazy reviewed Apr 18, 2018

View reviewed changes

DanielRosenwasser added 2 commits April 18, 2018 12:33

Address CR feedback.

320cb40

Accepted baselines.

25bb581

DanielRosenwasser force-pushed the autoPretty branch from 29ff745 to 25bb581 Compare April 18, 2018 19:43

DanielRosenwasser merged commit 6ee4989 into master Apr 19, 2018

DanielRosenwasser deleted the autoPretty branch April 19, 2018 06:10

DanielRosenwasser mentioned this pull request Apr 28, 2018

--pretty by default in tsc.exe (the ChakraCore tsc host) #23754

Closed

microsoft locked and limited conversation to collaborators Jul 31, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

--pretty-er output by default #23408

--pretty-er output by default #23408

DanielRosenwasser commented Apr 14, 2018 •

edited

Loading

weswigham left a comment

DanielRosenwasser commented Apr 14, 2018 •

edited

Loading

alfaproject Apr 14, 2018

alfaproject Apr 14, 2018

JoshuaKGoldberg Apr 16, 2018

mhegazy Apr 17, 2018

weswigham Apr 17, 2018

mhegazy Apr 17, 2018 •

edited

Loading

mhegazy left a comment

DanielRosenwasser Apr 18, 2018

weswigham Apr 18, 2018

mhegazy Apr 18, 2018

DanielRosenwasser commented Apr 19, 2018 •

edited

Loading

mhegazy commented Apr 19, 2018

kpreisser commented Apr 23, 2018 •

edited

Loading

DanielRosenwasser commented Apr 24, 2018

--pretty-er output by default #23408

--pretty-er output by default #23408

Conversation

DanielRosenwasser commented Apr 14, 2018 • edited Loading

weswigham left a comment

Choose a reason for hiding this comment

DanielRosenwasser commented Apr 14, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mhegazy Apr 17, 2018 • edited Loading

Choose a reason for hiding this comment

mhegazy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DanielRosenwasser commented Apr 19, 2018 • edited Loading

mhegazy commented Apr 19, 2018

kpreisser commented Apr 23, 2018 • edited Loading

DanielRosenwasser commented Apr 24, 2018

DanielRosenwasser commented Apr 14, 2018 •

edited

Loading

DanielRosenwasser commented Apr 14, 2018 •

edited

Loading

mhegazy Apr 17, 2018 •

edited

Loading

DanielRosenwasser commented Apr 19, 2018 •

edited

Loading

kpreisser commented Apr 23, 2018 •

edited

Loading