Skip to content

Commit

Permalink
updates doc
Browse files Browse the repository at this point in the history
  • Loading branch information
sverweij committed Oct 19, 2024
1 parent 0106e7f commit f92da8b
Showing 1 changed file with 46 additions and 31 deletions.
77 changes: 46 additions & 31 deletions doc/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ available in dependency-cruiser configurations.
1. [`--init`](#--init)
1. [`--metrics`: calculate stability metrics](#--metrics)
1. [`--no-metrics`: do not calculate stability metrics](#--no-metrics)
1. [`--info`: show what alt-js are supported](#--info-showing-what-alt-js-are-supported)
1. [`--info`: show what alt-js are supported](#--info-show-what-alt-js-are-supported)
1. [`--ignore-known`: ignore known violations](#--ignore-known-ignore-known-violations)
1. [`--no-ignore-known`: don't ignore known violations](#--no-ignore-known)
1. [`--help`/ no parameters: get help](#--help--no-parameters)
Expand Down Expand Up @@ -749,7 +749,7 @@ Do not calculate metrics. You can use this to override an earlier set `--metrics
command line option or `metrics` option in a .dependency-cruiser.js configuration
file.

### `--info` showing what alt-js are supported
### `--info` show what alt-js are supported

Which alt-js languages dependency-cruiser supports depends on the availability
it has to them. To see how dependency-cruiser perceives its environment use
Expand All @@ -759,35 +759,50 @@ it has to them. To see how dependency-cruiser perceives its environment use
<summary>Typical output</summary>

```
Supported:
If you need a supported, but not enabled transpiler ('✖' below), 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)
✔ coffee-script (>=1.0.0 <2.0.0)
✔ coffeescript (>=1.0.0 <3.0.0)
✖ livescript (>=1.0.0 <2.0.0)
✔ typescript (>=2.0.0 <4.0.0)
Extensions:
✔ .js
✔ .mjs
✔ .jsx
✔ .vue
✔ .ts
✔ .tsx
✔ .d.ts
✖ .ls
✔ .coffee
✔ .litcoffee
✔ .coffee.md
✔ .csx
✔ .cjsx
[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
```

</details>
Expand Down

0 comments on commit f92da8b

Please sign in to comment.