Refactor(repo): Use sharable typescript-config-spirit in tsconfig files #1787
Conversation
github-actions
bot
added
the
refactoring
✅ Deploy Preview for spirit-design-system ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for spirit-design-system-storybook ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
literat
requested review from
pavelklibani,
curdaj,
a team,
adamkudrna and
crishpeen
as code owners
literat
changed the title
literat
force-pushed
the
refactor/typescript-config-spirit
branch
from
665660b to
23fdaf3
Compare
literat
force-pushed
the
refactor/typescript-config-spirit
branch
from
23fdaf3 to
bc41dfe
Compare
literat
force-pushed
the
refactor/typescript-config-spirit
branch
from
ca1e505 to
599ec3f
Compare
| { | ||
| "compileOnSave": true, | ||
| "compilerOptions": { | ||
| /* Visit https://aka.ms/tsconfig to read more about this file */ |
There was a problem hiding this comment.
Yeah, that is just fine. Associate JSONC with JSON files in your IDE :-)
There was a problem hiding this comment.
I am not kidding. The JSON format is really bad for storing configurations. Especially with the lack of comments. For a better understanding of configs, comments like these are necessary.
| { | ||
| "name": "typescript-config-spirit", | ||
| "description": "TypeScript configuration for Spirit Design System", | ||
| "version": "0.0.0", |
There was a problem hiding this comment.
v0.1.0 (the lowest correct semver version AFAIK) will be released automatically?
There was a problem hiding this comment.
Yeah, will be re-versioned with the next publish. However, we can start even with the 1.0.0.
| > `typescript-config-spirit/dom` | ||
|
|
||
| This configuration extends the base configuration. | ||
| It is fine to use this configuration for the code that is running in the DOM. |
There was a problem hiding this comment.
Nit-picking: can code be "run in DOM"? 🤔 Didn't you mean "in browser"?
There was a problem hiding this comment.
That might imply renaming this config to browser. But I expect you will explain why I'm wrong 🙂.
There was a problem hiding this comment.
/* If your code runs in the DOM: */
"lib": ["es2022", "dom", "dom.iterable"],This configuration is the main reason why. So I name it after this. I was considering a "browser" but it will collide with this configuration and maybe it will be misleading.
It is just: base - not running in DOM, dom - running in DOM.
Description
Quick refactor of the same settings used across the
tsconfig.jsonfiles.I am moving them into the common configuration.
Additional context
https://www.totaltypescript.com/tsconfig-cheat-sheet
Issue reference