Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

github: add more environment details to envinfo #353

Merged
merged 1 commit into from
Jun 14, 2022

Conversation

agilgur5
Copy link
Collaborator

Summary

Add global TS version, OS, Node, and package manager details to envinfo command in the issue template

Details

  • add global version of TS as well

    • with some frequency, people report not having the same issue with tsc, and in some cases, that's because they're using their globally installed version of tsc, which is at a different version than their project's tsc (e.g. @ts-nocheck not working on .tsx file -- needs TS 3.7+ #223)
      • this will help guard against that
  • add OS and CPU details

    • OS bc non-POSIX path separator issues with Windows are somewhat common
    • CPU in case certain architecture may have an impact, e.g. new Apple ARM Silicon in Mac M1/M2 etc
      • it really shouldn't as this is mostly a high-level library, but some of the lower level functionality of TS and all the FS details could potentially have an impact
  • add Node, Yarn, and NPM versions

    • since sometimes it is an issue with the Node version or due to the specific package manager
    • that being said, this command won't tell us which of the package managers the user is using, just all the installed ones' versions
    • also wanted to add pnpm but it is not yet supported by envinfo

- add global version of TS as well
  - with some frequency, people report not having the same issue with
    `tsc`, and in some cases, that's because they're using their
    globally installed version of `tsc`, which is at a different version
    than their project's `tsc`
    - this will help guard against that

- add OS and CPU details
  - OS bc non-POSIX path separator issues with Windows are somewhat
    common
  - CPU in case certain architecture may have an impact, e.g. new Apple
    ARM Silicon in Mac M1/M2 etc
    - it really shouldn't as this is mostly a high-level library, but
      some of the lower level functionality of TS and all the FS details
      _could_ potentially have an impact

- add Node, Yarn, and NPM versions
  - since sometimes it is an issue with the Node version or due to the
    specific package manager
    - e.g. Yarn workspaces, Lerna, `pnpm` symlinks etc have caused
      issues before
  - that being said, this command won't tell us _which_ of the package
    managers the user is using, just all the installed ones' versions
  - also wanted to add `pnpm` but it is not yet supported by `envinfo`
    - there has been a PR out for it for a while, but hasn't been merged
      by the creator :/
@agilgur5 agilgur5 added kind: internal Changes only affect the internals, and _not_ the public API or external-facing docs topic: OS separators Path normalization between OSes. Windows = '\', POSIX = '/'. Rollup resolve = native, TS = POSIX topic: monorepo / symlinks Related to monorepos and/or symlinks (Lerna, Yarn, PNPM, Rush, etc) scope: github GH-only changes, e.g. issue and PR templates, releases, etc (not docs or CI) labels Jun 10, 2022
@ezolenko ezolenko merged commit b6233f2 into ezolenko:master Jun 14, 2022
Repository owner locked as resolved and limited conversation to collaborators Sep 3, 2022
@agilgur5 agilgur5 deleted the github-add-more-envinfo branch July 2, 2023 21:27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
kind: internal Changes only affect the internals, and _not_ the public API or external-facing docs scope: github GH-only changes, e.g. issue and PR templates, releases, etc (not docs or CI) topic: monorepo / symlinks Related to monorepos and/or symlinks (Lerna, Yarn, PNPM, Rush, etc) topic: OS separators Path normalization between OSes. Windows = '\', POSIX = '/'. Rollup resolve = native, TS = POSIX
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants