Refactor JavaScript to TypeScript #81

DigiLive · 2023-10-30T11:18:36Z

I've refactored the JavaScript files to TypeScript.

TypeScript is JavaScript with syntax for types and also used by Home Assistant.
It allows developers to precisely define the expected shape of objects and function parameters, resulting in code that's easier to understand and maintain.

Please test this code very carefully, so we're sure it matches the JavaScript version.

src/cards/AbstractCard.ts

punxaphil · 2023-10-31T20:20:50Z

src/types/generic.ts

@@ -0,0 +1,262 @@
+import {HomeAssistant} from "custom-card-helpers";
+
+export namespace generic {


I wonder if there is a risk overusing namespaces?
Will prefixing all these types with generic make the code a little less concise and readable?
My experience says namespaces are used in huge codebases where identical names of types needs to be separated. I am not convinced namespaces are really needed in this codebase though.

Just for now it's name-spaced to avoid such conflicts and for my own recognition.
It's a good comment though. The ones I need to optimize the code.

So it is a definite no on removing namespace? 😄

Nope. I haven't gotten around to it yet and I really like to merge this PR since it disrupts other PRs.

src/Helper.ts

src/cards/FanCard.ts

src/types/cards.ts

src/types/generic.ts

src/chips/AbstractChip.ts

punxaphil · 2023-11-13T13:27:16Z

src/types/generic.ts

@@ -0,0 +1,262 @@
+import {HomeAssistant} from "custom-card-helpers";
+
+export namespace generic {


So it is a definite no on removing namespace? 😄

src/cards/AbstractCard.ts

src/cards/BinarySensorCard.ts

src/views/HomeView.ts

src/cards/LightCard.ts

AalianKhan · 2023-11-17T18:27:42Z

All of the other options use snake case, ex card_options. I would prefer if homeView would be changed to home_view.

DigiLive · 2023-11-20T16:48:32Z

@AalianKhan Since merging this PR into main is too complex, I'll have to alter the branches locally. This will probably change the history of the main branch.

If so, I'll need to force push my local main branch to origin.
Do you have any protection rules set which will prevent me from doing so?

Warning

If I change the history of the main branch, all current PRs must refetch this branch and possibly rebase their feature branch onto main.

AalianKhan · 2023-11-21T03:22:07Z

I don't believe so.
I have squashed and merged before without any issue. Maybe you are a collaborator so something might come up. If so I can go ahead and merge it.

Other changes include: * Add Vacuum Card and View. * Add hiding sections from the Home view by strategy configuration. * Add hiding a view if no device is configured for it. Closes #24. * Add color temperature to light card. * Add icon to HomeView configuration. * Add version output to console. * Add version bumper. * Add .editorconfig settings. * Refactor README, because the information moved to the repository's Wiki. Closes #87.

punxaphil reviewed Oct 31, 2023

View reviewed changes

src/cards/AbstractCard.ts Outdated Show resolved Hide resolved

punxaphil reviewed Oct 31, 2023

View reviewed changes

DigiLive self-assigned this Oct 31, 2023