Separate prettier command eg. "tsdx format"

Current Behavior

Prettier is integrated into eslint and runs in one tsdx lint command. This comes with couple of disadvantages described at https://prettier.io/docs/en/integrating-with-linters.html . It is also not possible to run prettier on non JS/TS files eg. json, css/less/scss, md, yml etc…

Desired Behavior / Suggested Solution

tsdx lint runs only lint without prettier. tsdx format runs prettier and it’s possible to configure all file types we want to format. Default can be ts,tsx.. while the user can decide to also format yml, sass etc.

[agilgur5]

This comes with couple of disadvantages described at https://prettier.io/docs/en/integrating-with-linters.html

TSDX does use eslint-config-prettier so the main disadvantage doesn’t apply.

It is also not possible to run prettier on non JS/TS files eg. json, css/less/scss, md, yml etc…

I’m not sure if this is actually correct, I feel like there should be a way of doing this and would also like to use that feature of Prettier.

That being said, it’s important to actually lint (not just format) the other types of files too, which might be outside the scope of TSDX and add bloat. I personally run a variety of linters in my IDE etc (and run Policy-as-Code and SAST in CI).

tsdx lint runs only lint without prettier.

This proposal would be a breaking change in it’s current state.

To give an alternative that works today: Prettier is also very much usable in user-land too. Since it’s already in your dependency tree with TSDX, you can add some package.json#scripts like:

{
   "format": "prettier --write './**/*'",
    "// format:check": "for pre-commit and CI usage",
   "format:check": "prettier --check './**/*'"
}

[agilgur5]

It also adds more dependencies to tsdx

eslint-plugin-prettier is only a single dependency out of the gigantic amount of other deps. It can be impacted by majors, yes, but so will eslint-config-prettier, which is necessary. So not a huge burden in that sense.

I personally believe in single-responsibility principle which means lint does linting and format does formatting.

Well eslint --fix and ESLint style rules existed well before Prettier or really “formatter tools” as a category existed – so it already does both and will continue to do both. I’ve personally been a long-time user of Standard, which is entirely built on ESLint. Also there’s a group of people that believe type-checking is a subset of linting too in #352 – there’s opinions on opposite ends of the spectrum here.

But as I wrote there combining tools typically means for more bugs, nuances, and hacks and is well-evidenced in TSDX issues itself (some mentioned there too), so I’m much more inclined to separate them and am in fact planning to separate each command as a separate package and configs as separate presets (#634 ).