Convert project to TypeScript #52

ComradeVanti · 2023-10-16T15:39:04Z

This is an initial attempt to transition the project to TypeScript.

The tests pass, but obviously there would need to be an additional compile step somewhere when building the project for production.

This conversion has exposed a lot of potential undefined and other errors. I have highlighted these with TODO comments.

Hope to get some feedback on this.

ComradeVanti · 2023-10-16T18:40:46Z

Two more notes on this:

I know, no one asked for this, I just felt kind of inspired. Also I want to maybe add more to this project and I would love to do that with TypeScript.
I attempted to change the actual logic as little as possible. I only introduced types.

favoyang · 2023-10-17T07:16:40Z

Wow, this is really cool. I appreciate TypeScript for its debugging ease. There's a lot of work ahead, and I admire your passion and efforts. Thanks for that. I might have more feedback to share over the weekend.

Currently, our CI is encountering issues due to an incompatible Node version. The project requires Node v14, as specified in the .nvmrc file, while it seems you are using Node v18. I hope we can support v14 to support a smoother upgrade for our existing users. However, if it's necessary to work with the latest LTS, I'm open to that too.

ComradeVanti · 2023-10-17T09:02:54Z

Oops, didn't notice the node change. I might take a look to see if I can rework it for v14 if you thinks that's better. Let me know what you think.

favoyang · 2023-10-17T09:42:02Z

My apologies for the incorrect message. The Node version isn't the problem, the PR works with Node v14. It's actually a compatibility issue due to a recent npm that breaks the CI. Please rebase the master branch.

When attempting to fix eslint rules in file, the following error appeared ```Error: "prettier/vue" has been merged into "prettier" in eslint-config-prettier 8.0.0. See: https://github.com/prettier/eslint-config-prettier/blob/main/CHANGELOG.md#version-800-2021-02-21``` Reading the linked changelog, it seemed the fix was to simply only use the prettier/recommended extension. Simplified eslintrc to reflect this.

ComradeVanti · 2023-10-17T10:21:19Z

Just did a rebase to include 23f43fd. Hope that is what you meant

When attempting to fix eslint rules in file, the following error appeared ```Error: "prettier/vue" has been merged into "prettier" in eslint-config-prettier 8.0.0. See: https://github.com/prettier/eslint-config-prettier/blob/main/CHANGELOG.md#version-800-2021-02-21``` Reading the linked changelog, it seemed the fix was to simply only use the prettier/recommended extension. Simplified eslintrc to reflect this.

favoyang · 2023-10-17T13:28:38Z

Yes, the CI is passed now.

ComradeVanti · 2023-10-17T13:41:38Z

Cool. Do you need any more changes?

favoyang · 2023-10-17T14:20:39Z

No, thanks. Perhaps I will give more feedback on the weekend.

ComradeVanti · 2023-10-17T16:15:26Z

Do you mind if I do a few more refactors on this PR or would you rather wait on that?

favoyang · 2023-10-18T01:12:34Z

Sure you can do more refactors.

ComradeVanti · 2023-10-18T07:27:18Z

Cool, I'll try to keep it at refactors only, or at maximum add more tests. But no new features for now. Ulitmately I'd like to add #49 ;)

Eslint was complaining about various keywords being reserved and was unerlining them. Fixed by installing `typescript-eslint` according to [this guide](https://typescript-eslint.io/getting-started)

reformat and clean-up using new eslint config

Bumped because >=2 includes typings and seemingly no other breaking changes

On my Windows machine eslint was constantly complaining about line endings. Fixed using this answer https://stackoverflow.com/a/53769213

Add ambient typings for another-npm-registry-client

Move types file into types folder

Based on usage. Could use some cleanup

Declare types instead of exporting them for easier use

Improve type declarations for another-npm-registry-client by reading it's docs

Bump to ES2020 to match Node 14 after consulting https://github.com/microsoft/TypeScript/wiki/Node-Target-Mapping

Downgrade to match node version

Add some custom type assertions for expected errors

ts-mocha already compiles TS

Instead of building the package using tsc and then running the js file, we can run using ts-node. That way we only need ts files in the project. For this to work a few changes needed to be done: - Removed the initial empty index file - Moved bin-files into lib - Converted bin files to ts and renamed them to index/index-cn - Changed the shebang in the index files to use ts-node. This also requires ts-node is a dependency of the package - Adjust tsconfig in order to work with ts-node Seems like the package still works as intended. It might take a little bit longer to run because of the additional compile step

Seems like mocha requires it

ComradeVanti · 2023-10-30T08:44:47Z

Also, please note that there's a conflict due to the merging of #50.

I hope to have fixed that now.

favoyang · 2023-10-30T15:43:34Z

Also, please note that there's a conflict due to the merging of #50.

I hope to have fixed that now.

Thanks for the rebase. I think my comments have collapsed here: #52 (review), please checkout.

ComradeVanti · 2023-10-31T08:01:17Z

Thanks for the rebase. I think my comments have collapsed here: #52 (review), please checkout.

Yeah sorry, I force pushed and now all the commits are here twice. But I already responded to your feedback.

favoyang · 2023-10-31T14:49:47Z

But I already responded to your feedback.

@ComradeVanti, sorry I didn't see your response for my previous review #52 (review)?

ComradeVanti · 2023-10-31T16:18:34Z

@favoyang That's weird. Here is how it looks on my side:

Maybe something broke because of the force-push or I'm doing something wrong?

favoyang · 2023-10-31T17:00:26Z

It says pending. Perhaps there is a button for submitting.

Refs https://github.com/orgs/community/discussions/10369

After much looking, I found the place to "Submit" my review on the "files changed" tab in the upper right hand corner.

ComradeVanti · 2023-10-31T17:02:52Z

Oh god I feel stupid. Thanks, I hope I did it now.

Bump from 14 to 16. See #52 (comment)

See #52 (comment)

favoyang · 2023-10-31T19:14:44Z

One more thing, please remove ts-node from the dependencies (or move to devDeps if still needed) and regenerate the package-lock.json.

ComradeVanti · 2023-10-31T19:19:32Z

@favoyang Done. 1fae8e1 and a62fb61

favoyang · 2023-10-31T19:25:04Z

Sounds like we're good here. I will give a few more manual tests and merge them tomorrow.

ComradeVanti · 2023-10-31T19:32:16Z

Cool thanks. I'm a big fan of this project an plan to contribute more. Looking forward to some great collaboration.

# [1.16.0](1.15.5...1.16.0) (2023-11-01) ### Features * convert project to TypeScript ([#52](#52)), require node v16 ([8e68b9a](8e68b9a)), closes [/github.com/prettier/eslint-config-prettier/blob/main/CHANGELOG.md#version-800-2021-02-21](https://github.com//github.com/prettier/eslint-config-prettier/blob/main/CHANGELOG.md/issues/version-800-2021-02-21) [/github.com/prettier/eslint-config-prettier/blob/main/CHANGELOG.md#version-800-2021-02-21](https://github.com//github.com/prettier/eslint-config-prettier/blob/main/CHANGELOG.md/issues/version-800-2021-02-21) [/github.com//pull/52#issuecomment-1776779428](https://github.com//github.com/openupm/openupm-cli/pull/52/issues/issuecomment-1776779428) [#50](#50) [/github.com/prettier/eslint-config-prettier/blob/main/CHANGELOG.md#version-800-2021-02-21](https://github.com//github.com/prettier/eslint-config-prettier/blob/main/CHANGELOG.md/issues/version-800-2021-02-21) [/github.com//pull/52#issuecomment-1776779428](https://github.com//github.com/openupm/openupm-cli/pull/52/issues/issuecomment-1776779428) [/github.com//pull/52#discussion_r1375481622](https://github.com//github.com/openupm/openupm-cli/pull/52/issues/discussion_r1375481622) [/github.com//pull/52#discussion_r1378008074](https://github.com//github.com/openupm/openupm-cli/pull/52/issues/discussion_r1378008074)

favoyang · 2023-11-01T05:59:43Z

@ComradeVanti thanks again for all the passion. I have added you to the contributor list.

https://github.com/openupm/openupm-cli#contributors

ComradeVanti added 4 commits October 17, 2023 12:20

deps: install typescript

df4e122

misc: ignore builds

9f49b38

feat: convert to typescript

b981987

ComradeVanti added 14 commits October 18, 2023 18:59

fix: eslint errors in typescript-files

9ca868f

Eslint was complaining about various keywords being reserved and was unerlining them. Fixed by installing `typescript-eslint` according to [this guide](https://typescript-eslint.io/getting-started)

misc: apply eslint rules

2d03393

reformat and clean-up using new eslint config

chore(deps): bump mkdirp

0db8ba7

Bumped because >=2 includes typings and seemingly no other breaking changes

chore: fix eslint end-of-line error

2d34593

On my Windows machine eslint was constantly complaining about line endings. Fixed using this answer https://stackoverflow.com/a/53769213

feat: ambient typings for js module

c326276

Add ambient typings for another-npm-registry-client

refactor: move file

9eb4b9b

Move types file into types folder

refactor: add basic type for NpmClient

7926eac

Based on usage. Could use some cleanup

refactor: declare global types

2038996

Declare types instead of exporting them for easier use

refactor: improve ambient type declarations

4804895

Improve type declarations for another-npm-registry-client by reading it's docs

conf: bump target es version

ddd5c2e

Bump to ES2020 to match Node 14 after consulting https://github.com/microsoft/TypeScript/wiki/Node-Target-Mapping

deps: downgrade node types

d5c6929

Downgrade to match node version

refactor: add correct response type

9947cfa

feat: typecheck errors

3253326

Add some custom type assertions for expected errors

misc: add shared idea files

4e7fe2d

ComradeVanti added 5 commits October 30, 2023 09:39

conf: simplify test script

0e46162

ts-mocha already compiles TS

misc: add missing typescript dependency

a0039c3

Seems like mocha requires it

Merge branch 'ts' of https://github.com/ComradeVanti/openupm-cli into ts

436804d

Merge branch 'ts' into test

74bbd92

ComradeVanti requested a review from favoyang October 30, 2023 08:48

ComradeVanti added 5 commits October 31, 2023 18:39

Bump node version

d53b70b

Bump from 14 to 16. See #52 (comment)

misc: better build structure

3c32160

See #52 (comment)

misc: add CI TS build step

5903497

misc: remove unused dependencies

1fae8e1

misc: regenerate package lock

a62fb61

favoyang approved these changes Oct 31, 2023

View reviewed changes

favoyang added 3 commits November 1, 2023 11:33

chore: update .node-version to 16

1a360dc

chore: update .npmignore

baa87eb

fix: add the npm clean script to run before build

4415ada

favoyang merged commit 8e68b9a into openupm:master Nov 1, 2023
2 checks passed

ComradeVanti mentioned this pull request Nov 1, 2023

Discussion: Split up core module #57

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert project to TypeScript #52

Convert project to TypeScript #52

ComradeVanti commented Oct 16, 2023

ComradeVanti commented Oct 16, 2023

favoyang commented Oct 17, 2023

ComradeVanti commented Oct 17, 2023

favoyang commented Oct 17, 2023

ComradeVanti commented Oct 17, 2023

favoyang commented Oct 17, 2023

ComradeVanti commented Oct 17, 2023

favoyang commented Oct 17, 2023

ComradeVanti commented Oct 17, 2023 •

edited

Loading

favoyang commented Oct 18, 2023

ComradeVanti commented Oct 18, 2023

ComradeVanti commented Oct 30, 2023

favoyang commented Oct 30, 2023

ComradeVanti commented Oct 31, 2023

favoyang commented Oct 31, 2023

ComradeVanti commented Oct 31, 2023 •

edited

Loading

favoyang commented Oct 31, 2023

ComradeVanti commented Oct 31, 2023

favoyang commented Oct 31, 2023

ComradeVanti commented Oct 31, 2023

favoyang commented Oct 31, 2023

ComradeVanti commented Oct 31, 2023

favoyang commented Nov 1, 2023

Convert project to TypeScript #52

Convert project to TypeScript #52

Conversation

ComradeVanti commented Oct 16, 2023

ComradeVanti commented Oct 16, 2023

favoyang commented Oct 17, 2023

ComradeVanti commented Oct 17, 2023

favoyang commented Oct 17, 2023

ComradeVanti commented Oct 17, 2023

favoyang commented Oct 17, 2023

ComradeVanti commented Oct 17, 2023

favoyang commented Oct 17, 2023

ComradeVanti commented Oct 17, 2023 • edited Loading

favoyang commented Oct 18, 2023

ComradeVanti commented Oct 18, 2023

ComradeVanti commented Oct 30, 2023

favoyang commented Oct 30, 2023

ComradeVanti commented Oct 31, 2023

favoyang commented Oct 31, 2023

ComradeVanti commented Oct 31, 2023 • edited Loading

favoyang commented Oct 31, 2023

ComradeVanti commented Oct 31, 2023

favoyang commented Oct 31, 2023

ComradeVanti commented Oct 31, 2023

favoyang commented Oct 31, 2023

ComradeVanti commented Oct 31, 2023

favoyang commented Nov 1, 2023

ComradeVanti commented Oct 17, 2023 •

edited

Loading

ComradeVanti commented Oct 31, 2023 •

edited

Loading