feat(typescript): convert to typescript #51
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
Matthew-Mallimo
requested changes
Nov 8, 2024
Member
Matthew-Mallimo
left a comment
Matthew-Mallimo
left a comment
There was a problem hiding this comment.
Can the tests not rely on the build output?
Also, since we now have a build step, its best not to include the build in the repo (add to .gitignore), and update the release workflow to have a build step.
zacowan
suggested changes
Nov 8, 2024
xAndreiLi
force-pushed
the
feat/typescript
branch
4 times, most recently
from
00aec0e to
6e48b3e
Compare
zacowan
reviewed
Nov 8, 2024
xAndreiLi
force-pushed
the
feat/typescript
branch
2 times, most recently
from
e661365 to
6b834c8
Compare
zacowan
reviewed
Nov 14, 2024
xAndreiLi
force-pushed
the
feat/typescript
branch
from
6b834c8 to
f132a90
Compare
zacowan
previously approved these changes
Dec 3, 2024
code-forger
requested changes
Dec 10, 2024
xAndreiLi
force-pushed
the
feat/typescript
branch
3 times, most recently
from
017e34a to
febd8ef
Compare
nachovz
approved these changes
Dec 11, 2024
alnaranjo
previously approved these changes
Dec 12, 2024
code-forger
reviewed
Dec 12, 2024
code-forger
reviewed
Dec 12, 2024
code-forger
reviewed
Dec 12, 2024
code-forger
reviewed
Dec 12, 2024
zacowan
reviewed
Dec 12, 2024
xAndreiLi
force-pushed
the
feat/typescript
branch
from
febd8ef to
3f80d4e
Compare
zacowan
reviewed
Dec 12, 2024
zacowan
reviewed
Dec 12, 2024
xAndreiLi
force-pushed
the
feat/typescript
branch
2 times, most recently
from
2bd381f to
b8b1a31
Compare
zacowan
previously approved these changes
Dec 13, 2024
code-forger
previously approved these changes
Jan 7, 2025
xAndreiLi
force-pushed
the
feat/typescript
branch
from
b8b1a31 to
e82c5cb
Compare
code-forger
requested changes
Jan 8, 2025
src/index.ts
Outdated
|
|
||
| var contexts = {}; | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Allow any type for contexts | ||
| const contexts: { [key: string]: Context<any> | undefined } = {}; |
Member
There was a problem hiding this comment.
Can we try to use unknown here instead, which is more true
src/index.ts
Outdated
| } | ||
| if (contexts[key]) { | ||
| return contexts[key]; | ||
| return contexts[key] as Context<T>; |
Member
There was a problem hiding this comment.
If the provider part of the application uses
createSharedReactContext<{isModalOpen: boolean}>(...)
and the consumer uses
createSharedReactContext<{modalState: 'open' | 'closed'}>(...)
Then the Context produced will be lying to the consumer about the type of the context provided.
To make this code completely 'safe' it would need to always return Context<unknown> to force the consumer to validate the context shape explicitly.
update tests to tsx match types version with dep versions generic type change to main/types to exports change build to dist change target to es6 update types/react to 18 to provide modern context type switched to vitest and react-testing-library updated to stricter eslint update to react@17 install and enforce prettier during testing fixed snapshot removed timezone from setup change return type to Context<unknown>
xAndreiLi
force-pushed
the
feat/typescript
branch
from
e82c5cb to
3721d02
Compare
zacowan
approved these changes
Jan 9, 2025
code-forger
approved these changes
Jan 10, 2025
Matthew-Mallimo
approved these changes
Jan 10, 2025
nachovz
approved these changes
Jan 13, 2025
Contributor
|
🎉 This PR is included in version 1.1.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to convert this package to Typescript, allowing for both Javascript and Typescript projects to use it with added types for type-checking and IntelliSense.
Typescript was added as a dev dependency
File structure was changed to include src and build directories
tsc is used to transpile ts to js because of the package's simple output
ESLint was updated
Tests now use tsx and test index.ts in src
dist directory is gitignored and release runs build script
@types now matches installed dep versions (except for react)
types/react is installed @^18
react updated to 17
uses "exports" in package.json instead of main to supply built js and types
changed build dir to dist dir
changed target to es6 from 5 to remain at a version supporting all modern browsers
uses generic type for createReactSharedContext
enzyme testing replaced by vitest to upgrade react version
applied strict eslint rules
enforce prettier alongside eslint