Convert some code to TypeScript #655

unional · 2024-01-11T06:46:05Z

The conversion will be done in many small PRs,
so that the changes can be merged quickly,
minimizing merge conflicts for the team.

The Error component is converted to a functional component, and show that the error prop is not being used.

alexpargon · 2024-01-17T11:18:25Z

Hey there @unional ! I'm converting everything to Typescript on the newFocusArch and newPreferences branches that contain the 2.0 version of Bazecor, which entails:

migrating to Typescript
migrating to tailwind and abandoning styled-components & bootstrap completely
full rewriting of Focus.API to make it work with USB HID interfaces and better integrate the other functions like virtual keyboards.

so if you want to help out with this tell me and I will incorporate the changes with development to atomize the migration in different PRs so you and others can contribute!

unional · 2024-01-17T19:59:48Z

Sounds good.

I'm also thinking about virtual keyboard.
But I'm thinking more as a tool to test and develop. i.e. a mocking keyboard.

For that, the way the code is written needs to change. e.g. define a proper interface of the keyboards and the business logic (high-level policies) only consume interfaces.

Another approach is to use inheritance, with abstract class etc (similar to just interface, but more liberate and more OO-like)

alexpargon · 2024-01-18T13:14:20Z

That's a very good approach to further leverage the virtual keyboard's concept! in fact, one of the reasons to develop that feature was to test out the interface without requiring access to a physical version of the keyboard.

it would be very nice to be able to write tests against the same endpoints that are used for regular functionality. I will explore this concept and probably will create a discussion around it, so we can polish the concept 💎

unional · 2024-01-27T07:12:18Z

@alexpargon how would you like to organize the tests?

I typically does not do *.test.ts(x).
I use that name to further categorize the kind of tests they are:

*.spec.ts: specification test that shows how the code are being used and its behavior. Basically they are unit tests that are short-range (typical unit tests) or long-range (more like integration test, but does not cross physical boundary)
*.unit.ts: unit test that are uninteresting to read. e.g. tests for internal functions.
*.system.ts: tests that cross physical boundary. e.g. tests that rely on fixtures, using file system, etc. These tests are more involving to write and also more costly to run. So they can be run selectively during full test runs, in CI, etc., and can be skipped during active development (i.e. in watch mode, yarn t)

There are other kind of tests, e.g. accept, integrate, load, stress, etc., you get the idea.

Also, I can introduce storybook, visual snapshot testing, interactive tests, etc.
Need to see if that is possible with electron app, or is there other alternatives.
These will be in separate PRs, of course.

unional · 2024-01-27T09:56:26Z

src/api/flash/raiseFlasher/arduino-flasher.js

@@ -166,7 +141,7 @@ export var arduino = {
    let { address } = dataObjects[0];

    if (address < 2000) {
-      finished(true, `You're attempting to overwrite the bootloader... (0x${padToN(num2hexstr(dataObjects[0].address), 8)})`);


this is simplified as num2hexstr calls padToN already.

unional · 2024-01-27T10:05:39Z

The simple functions are extracted. The *_cb functions are also identical, but the whole Focus and flasher code probably need to take a deep look to see how to invert the dependencies so that it can be testable.

We can do that in another PR.

unional · 2024-01-27T21:15:48Z

I have also updated the tsconfig.json to make sure is has noEmit as the code is built using electron/webpack.

Also added a stricter tsconfig for testing newer code.
It is only used during yarn test:type and not used as the default config at the moment.

We can gradually improve the code quality and switch over in the future.

unional · 2024-01-27T21:17:06Z

src/api/flash/decodeHexLine.ts

@@ -26,7 +26,7 @@ export function decodeHexLine(line: string) {
  const bytes = new ArrayBuffer(byteData.length);
  const bytesView = new Uint8Array(bytes, 0, byteData.length);

-  for (let i = 0; i < byteData.length; i++) bytesView[i] = byteData[i];


This is updated to better infer types.
Test has this covered.

unional · 2024-01-27T21:19:33Z

vite.config.mts

The file extension is changed to .mts as the CJS build for vitest is deprecated.
ESM code needs either type: module or .mts.

unional · 2024-01-27T21:21:57Z

tsconfig.json

-    }
-  },
-  "include": ["src/**/*"],
-  "files": ["src/renderer/theme/styled.d.ts"]


This line is removed because include includes it.
This is likely introduced when the file is drag or renamed on vscode.

unional · 2024-01-27T21:23:45Z

tsconfig.strict.json

+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "strict": true,
+    // "verbatimModuleSyntax": true  // requires TypeScript 5


Currently this cannot be enabled because the project is using TypeScript 4.5.

Maybe we can upgrade it in another PR?

unional · 2024-01-28T19:27:27Z

full rewriting of Focus.API to make it work with USB HID interfaces and better integrate the other functions like virtual keyboards.

Note that I have converted Focus to TypeScript and adding tests in #700.
We can discuss that there.

This allows quick check of typescript error without running `yarn make-dev` which is much slower

The conversion will be done in many small PRs, so that the changes can be merged quickly, minimizing merge conflicts for the team.

The name does not accurately match behavior. Suggest fixing it in the future

`w` is the convention I use as I'm lazy. Feel free to suggest otherwise

the `num2hexstr` usage actually shows that the first param is a string, and the second param is opional based on the commented console log. the value is defaults to 0 to better match its intent and passes type check.

alexpargon · 2024-02-14T10:40:13Z

Great Job @unional ! 😄

really appreciate your help with this 👍🏻

alexpargon changed the base branch from development to newFocusArch January 18, 2024 13:30

unional force-pushed the ts1 branch from 58726eb to bebbb99 Compare January 19, 2024 05:31

unional force-pushed the ts1 branch from 1a3d399 to 46a0f5f Compare January 27, 2024 06:26

unional commented Jan 27, 2024

View reviewed changes

unional mentioned this pull request Jan 28, 2024

convert Focus to TypeScript #700

Merged

unional added 14 commits February 1, 2024 20:13

chore: add test:type script

afe5cc7

This allows quick check of typescript error without running `yarn make-dev` which is much slower

refactor: convert some code to TS

48061e3

The conversion will be done in many small PRs, so that the changes can be merged quickly, minimizing merge conflicts for the team.

refactor: migrate padToN

d6f15a1

The name does not accurately match behavior. Suggest fixing it in the future

chore: add w (watch) script for testing

0f4fbeb

`w` is the convention I use as I'm lazy. Feel free to suggest otherwise

chore: update vitest and add coverage

01fcc03

refactor: extract str2ab

10e5247

chore: simplify test scripts

a2396de

test: zero length

78b7769

chore: exclude test files from coverage

d53bb69

test: convert ascii and trim

ca1fd2b

chore: formatting

c1bb710

refactor: extract constants

36d1d3a

refactor: padToN signature

cfe2ad5

the `num2hexstr` usage actually shows that the first param is a string, and the second param is opional based on the commented console log. the value is defaults to 0 to better match its intent and passes type check.

refactor: extract num2hexstr

62dce59

unional added 6 commits February 1, 2024 20:13

refactor: remove extra usage of padToN

4e34179

refactor: stricter TypeScript config

b6bb07e

chore: rename test files

47d392d

chore: remove extra files field

cbb561e

chore: update forge.config with strictes rules

5214657

chore: include webpack and vite config to strict check

8c992e3

unional force-pushed the ts1 branch from bc5a376 to 8c992e3 Compare February 2, 2024 04:14

alexpargon merged commit 67aed25 into Dygmalab:newFocusArch Feb 14, 2024
6 of 10 checks passed

unional deleted the ts1 branch February 14, 2024 20:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert some code to TypeScript #655

Convert some code to TypeScript #655

unional commented Jan 11, 2024

alexpargon commented Jan 17, 2024

unional commented Jan 17, 2024

alexpargon commented Jan 18, 2024

unional commented Jan 27, 2024 •

edited

unional Jan 27, 2024

unional commented Jan 27, 2024

unional commented Jan 27, 2024

unional Jan 27, 2024

unional Jan 27, 2024

unional Jan 27, 2024 •

edited

unional Jan 27, 2024

unional commented Jan 28, 2024

alexpargon commented Feb 14, 2024

Convert some code to TypeScript #655

Convert some code to TypeScript #655

Conversation

unional commented Jan 11, 2024

alexpargon commented Jan 17, 2024

unional commented Jan 17, 2024

alexpargon commented Jan 18, 2024

unional commented Jan 27, 2024 • edited

unional Jan 27, 2024

Choose a reason for hiding this comment

unional commented Jan 27, 2024

unional commented Jan 27, 2024

unional Jan 27, 2024

Choose a reason for hiding this comment

unional Jan 27, 2024

Choose a reason for hiding this comment

unional Jan 27, 2024 • edited

Choose a reason for hiding this comment

unional Jan 27, 2024

Choose a reason for hiding this comment

unional commented Jan 28, 2024

alexpargon commented Feb 14, 2024

unional commented Jan 27, 2024 •

edited

unional Jan 27, 2024 •

edited