Skip to content

--doctor option logs advice to help with project configuration #1203

Description

@cspotcode

Desired Behavior

When invoked with new --doctor / "doctor" / TS_NODE_DOCTOR option, will eagerly log verbose advice about project configuration.

For example, if using a "target" option that is (partially) incompatible with your node version, will log a block of text warning about the incompatibilities.

Can also register an error handler that augments recognized errors with additional help text. For example, can detect when errors may be fixed by --files

Can propose moving options into tsconfig file.

Can detect unrecognized tsconfig.ts-node options.

Can detect unrecognized CLI flags.

Can point out when files are being loaded as ESM and you're not using the ESM loader.

Is this request related to a problem?

User confusion. I wonder if something like this can help.

Alternatives

More docs

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions