VS Code does not automatically 'play nicely' with tsdx
See original GitHub issueCurrent Behavior
VS Code does not detect or use Eslint and Prettier in the workspace (out of the box).
Expected behavior
The first paragraph of the README seems to suggest VSCode will automatically work nicely with TSDX’s environment. Leading me to believe it was plug-and-play.
Suggested solution(s)
Maybe create an (opinionated) settings file in the .vscode
folder of the workspace? Or at least dedicate a section in the README to the required configurations in VS Code.
Additional context
This “bug” might be out of the intended scope of the project, but the README led me to believe it would work this way.
Your environment
Software | Version(s) |
---|---|
TSDX | 0.11.0 |
TypeScript | 3.7.2 |
Browser | - |
npm/Yarn | 6.13.0 |
Node | v12.13.0 |
Operating System | Linux 4.19.85-1-MANJARO x86_64 |
Issue Analytics
- State:
- Created 4 years ago
- Reactions:16
- Comments:19 (1 by maintainers)
Top Results From Across the Web
TypeScript Programming with Visual Studio Code
TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. It offers classes, modules, and interfaces to help you build robust...
Read more >How to make VSCode play nice with React syntax?
VS Code has built-in support for JSX and TSX. You do not need to install any extensions unless you want additional functionality.
Read more >TSDX: Introduction
Between Rollup, Jest, tsconfig, Yarn resolutions, TSLint, and getting VSCode to play nicely....there is just a whole lot of stuff to do (and...
Read more >TSdx - Best of JS
The prepare script will run the equivalent of npm run build or yarn build . ... After TSDX compiles your code with TypeScript,...
Read more >awesome-vscode | A curated list of delightful VS Code ...
And it doesn't require you to select what to be aligned, the extension will figure it out by itself. Better Align. Auto Rename...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
BEWARE – you might be over complicating/overthinking things with your vscode setup!
I certainly did. I wasted MANY hours messing around with config files, plugins, npm packages, etc., before coming to realize that everything I wanted was pretty much provided by tsdx from the start. Before I go on, let me make clear the two goals that I wanted to achieve with my tsdx-vscode setup:
That’s it. I don’t need super-fancy configuration, I just want the ability to set basic things like single vs double quotes, tab size, etc. I also don’t mind being subject to “opinionated” rules sets, I mainly want consistency across my code base.
With that said, I eventually realized that tsdx (very nearly) gives me those two goals right out of the box via the “prettier” section in
package.json
, which looks like this:Note: I added the last two rules here.
In order to fulfill the first goal above, all you need is to do is the following:
settings.json
file ("editor.defaultFormatter": "esbenp.prettier-vscode"
)In order to fulfill the second goal, you just need to make the linting script called by husky “fix” your code by adding “–fix” within
package.json
:And, voila, my two goals are met. If I now change e.g. “tabWidth”: 3 in my prettier block, then my files will readjust automatically upon formatOnSave, etc.
tl;dr
The reason I wasted so much time previously is because in my hasty read of the tsdx readme I inferred that in order to tweak your formatting rules you needed to create an eslint config file and then make that the single source of truth for your formatting rules. However, I was unable to get vscode to recognize such an eslint config file as the source of truth for my formatting rules (despite, as I said, many hours of trying different combinations of extensions, plugins, packages and configurations). Once I realized that you don’t need to use this eslint config file to set rules (i.e. all I needed was already there in the “prettier” block in
package.json
), I was able to strip away all the excess extensions, plugins, packages and was very pleased to end up with something so lean as, essentially, what tsdx gave me out of the box.In summary: to avoid the sort of rabbit holes I went down, I would suggest making the following alteration to the tsdx readme (my suggested edits in bold):
This is broken for all ESLint extensions, not just for VSCode, as the config is missing. The solution is to do what
create-react-app
does and generate an ESLint config by default (as with--write-file
). Thetsdx lint
command would still be useful as it uses some CLI flags that aren’t present in ESLint configs).