TypeScript #28

aminya · 2020-03-14T21:31:29Z

Ready to get merged - Tested and is working

Description of the Change - Release Notes

Converting codebase source to typescript while being completely backward-compatible
Adding type definitions + documentation for API
Optimizing the code wherever possible

Verification Process

I verify the changes against other packages that use atom-select-list: for example, atom-indent-detective uses atom-select-list.
The tests are untouched to show backward compatibility

Possible Drawbacks

Nothing (backward compatible - zero change in the API and JavaScript code)

Alternate Designs

using @types/atom-select-list. But this doesn't allow us to use the power of typescript for optimizing and catching the bugs.

aminya · 2020-03-29T15:49:09Z

@maxbrunsfeld Could you review this?

aminya · 2020-04-11T10:04:56Z

Is there anyone to check this?

@nshikov @maxbrunsfeld @t9md @50Wliu

up scripts

Update select-list-view.ts Update select-list-view.ts Update select-list-view.ts Update select-list-view.ts Update select-list-view.ts Update select-list-view.ts object | string object | string Update select-list-view.ts

Allows TypeScript to infer the types

aminya · 2021-01-05T05:40:51Z

Disclaimer: I'm no longer an Atom maintainer and my knowledge of the ecosystem is now 1.5 years old.
That said, still happy to give reviews that pop up on my notifications feed when I have the time.

Glad to hear from you!

This looks like a fairly straightforward port to Typescript. Have the current maintainers indicated that they're open to switching to Typescript? (I think there were some conversations about this...too fuzzy for me to recall for sure though)

There are only 2-3 people officially working part-time on Atom. They rarely get time to address the PRs. We are considering forking the whole organization in @atom-community, so I am not surprised anymore that I did not get any response here.

Most of my comments are related to the configuration of Typescript itself, plus a few questions about the TODO comments you left.

I addressed most of them. I left some comments for the unresolved ones.

winstliu

Mostly minor stuff, but still a few questions

src/select-list-view.ts

tsconfig.json

winstliu · 2021-01-05T22:18:54Z

src/select-list-view.ts

+  props: SelectListProperties
+
+  /** an array containing the objects you want to show in the select list. */
+  items: Array<object | string> // TODO: Added initializer! Either fix this.items or assign it in constructor


I looked through the code to re-familiarize myself with this. It technically is assigned in the constructor, via computeItems. Does Typescript throw an error if it's not explicitly set in the constructor itself? I forget how good it is at following the codeflow.

I'm not positive, but I think it is necessary because of the slices we do on it; this way this.props.items is the original copy and this.items is the filtered & ordered list that's shown.

src/select-list-view.ts

src/select-list-properties.ts

winstliu · 2021-01-05T22:48:35Z

src/select-list-view.ts

+  props: SelectListProperties
+
+  /** an array containing the objects you want to show in the select list. */
+  items: Array<object | string> // TODO: Added initializer! Either fix this.items or assign it in constructor


And: is this meant to be public?

Co-authored-by: Winston Liu <Wliu1402@gmail.com>

aminya · 2021-01-06T06:02:16Z

I looked through the code to re-familiarize myself with this. It technically is assigned in the constructor, via computeItems. Does Typescript throw an error if it's not explicitly set in the constructor itself? I forget how good it is at following the codeflow.

I'm not positive, but I think it is necessary because of the slices we do on it; this way this.props.items is the original copy and this.items is the filtered & ordered list that's shown.

And: is this meant to be public?

Yes, that seems like it. I will change it to private because it is not documented.

This reverts commit 231df2c.

winstliu

Buncha small stuff. Only thing I'm blocking over is the last TODO comment.

(p.s. you'll do reviewers a favor if you elaborate more on what you mean by your TODOs in the future 🙂)

src/select-list-view.ts

Co-authored-by: Winston Liu <Wliu1402@gmail.com>

aminya · 2021-01-07T00:23:12Z

Per atom/etch@18512fc/lib/patch.js#L46, it looks like {} is the default value that's passed in if there's no new props. Which says two things:

The = {} shouldn't even be needed b/c we should never be passed an undefined value, per the source above
Since it's intentional that we can be passed an empty object, I think it's fine that we just handle that normally.
So I don't think this TODO needs to stay.

Which one should I remove? = {} or the TODO?

winstliu · 2021-01-07T01:36:55Z

Both :)

atom#28 (comment)

winstliu

I'm happy with this 👍.

src/select-list-view.ts

Co-authored-by: Winston Liu <Wliu1402@gmail.com>

aminya · 2021-01-09T15:59:10Z

@50Wliu Could you merge this if you have access? I don't want to wait another year for merging 😞

winstliu · 2021-01-11T22:56:18Z

Sorry, I don't merge things anymore :/.
@sadick254 is this something in your area?

aminya force-pushed the TypeScript branch from e27f598 to f014a18 Compare March 14, 2020 21:50

aminya force-pushed the TypeScript branch 8 times, most recently from 2d87e5f to c9d5a9b Compare March 29, 2020 15:47

aminya marked this pull request as ready for review March 29, 2020 15:48

Create tsconfig.json

b5e3aa3

aminya force-pushed the TypeScript branch 2 times, most recently from 0e78c95 to 5dd7136 Compare April 11, 2020 10:02

aminya force-pushed the TypeScript branch 3 times, most recently from be16a04 to bda0c3d Compare April 11, 2020 10:19

aminya force-pushed the TypeScript branch from 51c57bb to ab1bcfa Compare May 8, 2020 11:50

aminya added 11 commits May 8, 2020 07:11

Add dev deps + Add Eslint/TsLint + prettier config

c9e3006

Add scripts

06f8a4e

up scripts

js-to-ts-converter .

361cbb9

import instead of require for atom/fuzzaldrin

9642dda

global not needed for atom

ef4bba6

SelectListView members + SelectListProperties interface

db55db1

Update select-list-view.ts Update select-list-view.ts Update select-list-view.ts Update select-list-view.ts Update select-list-view.ts Update select-list-view.ts object | string object | string Update select-list-view.ts

etch type temporarily

c3bf30e

TODO: fix redundant returns in methods

7a6850a

this.items = props.items + TODO

89a593a

CommandEvent

fc980cd

itemIndex: number

84471b7

aminya added 9 commits January 4, 2021 22:42

Remove unused locals

72f9d01

Move strict tsconfig

43b1d75

noImplicitAny and strict

cf1cac7

Fix fuzzaldrin types

d5d3736

Use in instead of hasOwnProperty

cc81360

Allows TypeScript to infer the types

Replace the deprecated scrollIntoViewIfNeeded

231df2c

Downgrade sinon

fd8902f

Bump typescript deps

c021cc9

Use ES5 export style (to prevent exports.default)

cdf3129

winstliu reviewed Jan 5, 2021

View reviewed changes

aminya and others added 3 commits January 5, 2021 23:55

Depend on strict for noImplicitAny and noImplicitThis

8818ab0

Make skipCommandsRegistration optional

e2bff3a

remove space

f43e920

Co-authored-by: Winston Liu <Wliu1402@gmail.com>

aminya added 3 commits January 6, 2021 00:03

Make items private

246ff18

Revert "Replace the deprecated scrollIntoViewIfNeeded"

0e9dc1f

This reverts commit 231df2c.

Add ts-ignore for scrollIntoViewIfNeeded

80c3e14

winstliu suggested changes Jan 7, 2021

View reviewed changes

src/select-list-view.ts Outdated Show resolved Hide resolved

src/select-list-view.ts Outdated Show resolved Hide resolved

src/select-list-view.ts Outdated Show resolved Hide resolved

src/select-list-view.ts Outdated Show resolved Hide resolved

src/select-list-view.ts Show resolved Hide resolved

aminya and others added 2 commits January 6, 2021 18:14

Remove initial assignment to this.items

180f224

update the docstring for items

414607f

Co-authored-by: Winston Liu <Wliu1402@gmail.com>

Fix the type for this.refs.items.children

3c11348

Remove {} from the default value for props

b4a58f7

atom#28 (comment)

winstliu approved these changes Jan 8, 2021

View reviewed changes

src/select-list-view.ts Outdated Show resolved Hide resolved

remove space

b07cbec

Co-authored-by: Winston Liu <Wliu1402@gmail.com>

sadick254 merged commit 4952038 into atom:master Jan 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TypeScript #28

TypeScript #28

aminya commented Mar 14, 2020 •

edited

Loading

aminya commented Mar 29, 2020

aminya commented Apr 11, 2020

aminya commented Jan 5, 2021 •

edited

Loading

winstliu left a comment

winstliu Jan 5, 2021

winstliu Jan 5, 2021

aminya commented Jan 6, 2021

winstliu left a comment

aminya commented Jan 7, 2021

winstliu commented Jan 7, 2021

winstliu left a comment

aminya commented Jan 9, 2021

winstliu commented Jan 11, 2021

TypeScript #28

TypeScript #28

Conversation

aminya commented Mar 14, 2020 • edited Loading

Ready to get merged - Tested and is working

Description of the Change - Release Notes

Verification Process

Possible Drawbacks

Alternate Designs

aminya commented Mar 29, 2020

aminya commented Apr 11, 2020

aminya commented Jan 5, 2021 • edited Loading

winstliu left a comment

Choose a reason for hiding this comment

winstliu Jan 5, 2021

Choose a reason for hiding this comment

winstliu Jan 5, 2021

Choose a reason for hiding this comment

aminya commented Jan 6, 2021

winstliu left a comment

Choose a reason for hiding this comment

aminya commented Jan 7, 2021

winstliu commented Jan 7, 2021

winstliu left a comment

Choose a reason for hiding this comment

aminya commented Jan 9, 2021

winstliu commented Jan 11, 2021

aminya commented Mar 14, 2020 •

edited

Loading

aminya commented Jan 5, 2021 •

edited

Loading