Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[0.8.x] Moving to Typescript #103

Merged
merged 40 commits into from
Jan 27, 2023
Merged

[0.8.x] Moving to Typescript #103

merged 40 commits into from
Jan 27, 2023

Conversation

Rezrazi
Copy link
Collaborator

@Rezrazi Rezrazi commented Nov 20, 2022

Target version 0.8.x

📣 Summary

This PR introduces a reworked code based which embeds Typescript in every file and component. Vue components have been rewritten to use <script setup lang="ts"> and Pinia store was improved with better static analysis and types.

This PR follows the spirit of building a package that should provide a strongly typed codebase to ensure its resilience to user induced issues due to potential poor type checking. Typescript will give the development team a more robust source code to work with. This should also facilitate new feature development and bug fixes.

🚩 Impact and breaking changes

TL;DR: No major breaking changes as this only affects Vue components, which are only supposed to be used internally

As this PR only modifies the underlying code base to Typescript, no changes should affect the end users of the package. If you are a developer working on the package, please note that no fixes or new features will be accepted if they're not built with Typescript.

We will be thoroughly testing the package before the upcoming release.

And as always, the package is still in its 0.x, and no guarantees are to be made as the core functionality of the package. However, we always aim to avoid BCs, yet sometimes changes are necessary to move forward.

BREAKING CHANGE: This might introduce some breaking changes if you are not using Typescript (Only in development mode, regular end-user usage should not be affected)
@Rezrazi Rezrazi self-assigned this Nov 20, 2022
@Rezrazi Rezrazi marked this pull request as ready for review November 20, 2022 11:47
@codecov
Copy link

codecov bot commented Nov 26, 2022

Codecov Report

Base: 71.64% // Head: 72.00% // Increases project coverage by +0.35% 🎉

Coverage data is based on head (6a614c6) compared to base (28cb6c9).
Patch coverage: 64.44% of modified lines in pull request are covered.

❗ Current head 6a614c6 differs from pull request most recent head ac4e968. Consider uploading reports for the commit ac4e968 to get more accurate results

Additional details and impacted files
@@             Coverage Diff              @@
##               main     #103      +/-   ##
============================================
+ Coverage     71.64%   72.00%   +0.35%     
- Complexity      261      263       +2     
============================================
  Files            44       44              
  Lines           871      875       +4     
============================================
+ Hits            624      630       +6     
+ Misses          247      245       -2     
Impacted Files Coverage Δ
src/FileManager.php 14.14% <0.00%> (ø)
src/ToolServiceProvider.php 95.91% <94.73%> (+2.30%) ⬆️
src/Http/Controllers/FileController.php 100.00% <100.00%> (ø)
src/Http/Requests/DeleteFileRequest.php 100.00% <100.00%> (ø)
src/Services/FileManagerService.php 80.00% <100.00%> (+0.16%) ⬆️
src/Support/Asset.php 0.00% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@Rezrazi
Copy link
Collaborator Author

Rezrazi commented Jan 27, 2023

ready to merge

@mikaelpopowicz mikaelpopowicz merged commit 1aa3158 into main Jan 27, 2023
@Rezrazi Rezrazi deleted the typescript branch February 20, 2023 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants