Replacing any keyword instances with relevant data types
#1040
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to the JSON Schema Community. Thanks a lot for creating your first pull request!! 🎉🎉 We are so excited you are here! We hope this is only the first of many! For more details check out README.md file.
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
Asymtode712
changed the title
any keyword instances with relevant data types
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1040 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 10 10
Lines 373 373
Branches 94 94
=========================================
Hits 373 373 ☔ View full report in Codecov by Sentry. |
|
@DhairyaMajmudar @benjagm Please review this PR |
There was a problem hiding this comment.
@Asymtode712 Thank you for the great work done in the PR pls. address the suggestions and some questions also move all the custom data type blocks at the starting of the file after import statements.
|
@DhairyaMajmudar I have carried out all the changes which were requested by you....please have a look at the PR now |
|
@benjagm I've seen at many occurrences we are using almost the same type definitions, what are your views on creating a global types files and moving such common type definitions into it .... furthermore simply importing them on required locations? |
|
@DhairyaMajmudar I am done with the remaining changes as requested by you.....Kindly review them once |
DhairyaMajmudar
added
the
Hacktoberfest-accepted
|
@benjagm Please review this PR and merge it if it is good to go |
What kind of change does this PR introduce?
Issue Number:
anyfrom codebase #1034Screenshots/videos:
If relevant, did you update the documentation?
Summary
This PR addresses the issue regarding use of the any datatype across several places in the codebase. The any type alters the strictness of TypeScript, which is not a good practice. The goal of this PR is to replace instances of any with correct data type definitions to enhance type safety. In some cases, custom data types have been created to ensure clarity and maintainability of the code. This change aims to improve code quality and maintain TypeScript's strict type-checking features.
Does this PR introduce a breaking change?
No, this PR does not introduce any breaking changes. All existing functionalities remain intact; however, the internal implementation has been improved with better type definitions.
Note to Maintainers:
Most of the components and pages are now free from the recurring use of
anykeyword except one component i.e.,JsonEditor. While I aimed to replace all instances of the any keyword in theJsonEditorcomponent, some of the types were difficult to define precisely due to the dynamic nature of JSON data. Since JSON can vary widely in structure and content, there were certain cases where assigning a specific type could lead to potential type mismatches or errors in runtime