Skip to content

[CLI DX] Improve the output for tsc --init #45714

Closed
#45930
Closed
[CLI DX] Improve the output for tsc --init#45714
#45930
Labels
Effort: CasualGood issue if you're already used to contributing to the codebase. Harder than "good first issue".Experience EnhancementNoncontroversial enhancementsGood First IssueWell scoped, documented and has the green lightHelp WantedYou can do this
@orta

Description

@orta
orta
opened on Sep 3, 2021

Suggestion

As of 4.4, a run of tsc looks like:

$ /Users/ortatherox/dev/typescript/resolve-ts/node_modules/.bin/tsc --init     
message TS6071: Successfully created a tsconfig.json file.

I propose instead we change this message to provide more context about a few key values which have been set:

Example

$ /Users/ortatherox/dev/typescript/resolve-ts/node_modules/.bin/tsc --init           
                                                                                     
Created a new tsconfig.json with:                                                 [    ]
                                                                                  [  TS]
  strict: true                                                                       
  target: es5                                                                        
  module: commonjs 
  esModuleInterop: true
                                                     
                                                                                     
You can learn more at https://aka.ms/tsconfig.json

The qualifiers for whether something should be included in the list is that showInSimplifiedHelpView: true and the value is not the default. In the case about target is es5 but the default is es3 for example.

The cute little right aligned logo is used in tsc --help so you can re-use that code.

It's worth noting that a user can pass in defaults via tsc --init --target es2017, but I think that occurs before the code where you would write this, so it's just context which might be useful for testing.

Exceptions

None that I can think of.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Effort: CasualGood issue if you're already used to contributing to the codebase. Harder than "good first issue".Experience EnhancementNoncontroversial enhancementsGood First IssueWell scoped, documented and has the green lightHelp WantedYou can do this

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions