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

[UICAL-269] Migrate from self-contained typings to stripes-types (again) #508

Merged
merged 6 commits into from
Dec 28, 2023

Conversation

ncovercash
Copy link
Member

@ncovercash ncovercash commented Dec 22, 2023

Jira UICAL-269

redo of #506

Purpose

Initially, we developed our own typings for the Stripes framework, to be used internally by ui-calendar. This was great when we were the only TypeScript module in the FOLIO ecosystem, however, that is no longer the case, and it does not make sense for ui-calendar to be the source of truth for Stripes typings.

Approach

Types were moved to https://github.com/folio-org/stripes-types (over the past many months), where they can be contributed to and shared by all FOLIO developers.

Now that this central location exists, there's no reason for ui-calendar to contain the old types; in fact, they often caused conflicts when attempting to build a platform.

Note

This broke the build on the first attempt, due to what appeared to be a type error in ui-calendar. This, however, was hiding the real issue — ui-bulk-edit contained old types which had some incorrect and missing information. Once folio-org/ui-bulk-edit#440 is merged, this issue will be resolved.

Pre-Merge Checklist

Before merging this PR, please go through the following list and take appropriate actions.

  • I've added an appropriate record to the CHANGELOG.md
  • Does this PR meet or exceed the expected quality standards?
    • Code coverage on new code is 80% or greater
    • Duplications on new code is 3% or less
    • There are no major code smells or security issues
  • Does this introduce breaking changes?
    • If any API-related changes - okapi interfaces and permissions are reviewed/changed correspondingly N/A
    • There are no breaking changes in this PR.
      • We could consider this a breaking change, however, these types were never intended to be used externally and therefore were not a public interface.

This comment has been minimized.

Copy link

Jest Unit Test Statistics

    1 files  ±0    71 suites  ±0   2m 44s ⏱️ -8s
327 tests ±0  326 ✔️ ±0  1 💤 ±0  0 ±0 
354 runs  ±0  353 ✔️ ±0  1 💤 ±0  0 ±0 

Results for commit 8dd4cc3. ± Comparison against base commit ca090c8.

Copy link

@ncovercash ncovercash merged commit adec801 into master Dec 28, 2023
5 checks passed
@ncovercash ncovercash deleted the uical-269 branch December 28, 2023 20:17
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.

3 participants