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

feat(cli): expands the info displayed in --info #959

Merged
merged 3 commits into from
Oct 19, 2024

Conversation

sverweij
Copy link
Owner

@sverweij sverweij commented Oct 19, 2024

Description

  • enriches the --info output with info relevant for troubleshooting environment issues:
  • versions of transpilers found
  • current version of dependency-cruiser
  • supported node versions, found node version
  • found os

Motivation and Context

Makes it easier to debug issues in the setup. E.g. seeing that dependency-cruiser finds typescript@4 is used instead of an expected typescript@5 already gives clues to

How Has This Been Tested?

  • green ci

Screenshots

After

    [email protected]

    node version supported : ^18.17||>=20
    node version found     : v22.8.0
    os version found       : x64 [email protected]

    If you need a supported, but not enabled transpiler ('x' below), just install
    it in the same folder dependency-cruiser is installed. E.g. 'npm i livescript'
    will enable livescript support if it's installed in your project folder.

    ✔ transpiler             versions supported  version found
    - ---------------------- ------------------- ------------------------
    ✔ javascript             *                   [email protected]
    ✔ babel                  >=7.0.0 <8.0.0      @babel/[email protected]
    ✔ coffee-script          >=1.0.0 <2.0.0      [email protected]
    ✔ coffeescript           >=1.0.0 <3.0.0      [email protected]
    x livescript             >=1.0.0 <2.0.0      -
    ✔ svelte                 >=3.0.0 <5.0.0      svelte/[email protected]
    ✔ swc                    >=1.0.0 <2.0.0      @swc/[email protected]
    ✔ typescript             >=2.0.0 <6.0.0      [email protected]
    ✔ vue-template-compiler  >=2.0.0 <3.0.0      vue-template-compiler
    ✔ @vue/compiler-sfc      >=3.0.0 <4.0.0      vue-template-compiler

    ✔ extension
    - ---------
    ✔ .js
    ✔ .cjs
    ✔ .mjs
    ✔ .jsx
    ✔ .ts
    ✔ .tsx
    ✔ .d.ts
    ✔ .cts
    ✔ .d.cts
    ✔ .mts
    ✔ .d.mts
    ✔ .vue
    ✔ .svelte
    x .ls
    ✔ .coffee
    ✔ .litcoffee
    ✔ .coffee.md
    ✔ .csx
    ✔ .cjsx

Before

 Supported:

    If you need a supported, but not enabled transpiler ('x' below), just install
    it in the same folder dependency-cruiser is installed. E.g. 'npm i livescript'
    will enable livescript support if it's installed in your project folder.

  Transpilers:

    ✔ javascript (>es1)
    ✔ babel (>=7.0.0 <8.0.0)
    ✔ coffee-script (>=1.0.0 <2.0.0)
    ✔ coffeescript (>=1.0.0 <3.0.0)
    x livescript (>=1.0.0 <2.0.0)
    ✔ svelte (>=3.0.0 <5.0.0)
    ✔ swc (>=1.0.0 <2.0.0)
    ✔ typescript (>=2.0.0 <6.0.0)
    ✔ vue-template-compiler (>=2.0.0 <3.0.0)
    ✔ @vue/compiler-sfc (>=3.0.0 <4.0.0)

  Extensions:

    ✔ .js
    ✔ .cjs
    ✔ .mjs
    ✔ .jsx
    ✔ .ts
    ✔ .tsx
    ✔ .d.ts
    ✔ .cts
    ✔ .d.cts
    ✔ .mts
    ✔ .d.mts
    ✔ .vue
    ✔ .svelte
    x .ls
    ✔ .coffee
    ✔ .litcoffee
    ✔ .coffee.md
    ✔ .csx
    ✔ .cjsx

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation only change
  • Refactor (non-breaking change which fixes an issue without changing functionality)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • 📖

    • My change doesn't require a documentation update, or ...
    • it does and I have updated it
  • ⚖️

    • The contribution will be subject to The MIT license, and I'm OK with that.
    • The contribution is my own original work.
    • I am ok with the stuff in CONTRIBUTING.md.

Copy link

codeclimate bot commented Oct 19, 2024

Code Climate has analyzed commit f92da8b and detected 0 issues on this pull request.

View more on Code Climate.

@sverweij sverweij merged commit 802ff6f into main Oct 19, 2024
8 checks passed
@sverweij sverweij deleted the feature/expands-info-displayed-in---info branch October 19, 2024 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant