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

PIMS-531: Absolute Imports for Express API starting the absolute paths #1979

Merged
merged 12 commits into from
Dec 29, 2023

Conversation

LawrenceLau2020
Copy link
Collaborator

@LawrenceLau2020 LawrenceLau2020 commented Dec 14, 2023

🎯 Summary

PIMS-531

Changes

  • Adds ability to import absolute paths with the following prefix :@/. This corresponds to anything in the src folder.
  • Added packages to allow for working builds and tests with these paths.
  • Introduced a /src folder to house the API's code.

Testing

Ensure that it can be run in development mode, in a container, and that tests run.

Effects on Other Branches

Depending on what merges before this, imports in other branches and the folder structure of other branches will need to be changed.

🔰 Checklist

  • I have read and agree with the following checklist and am following the guidelines in our Code of Conduct document.
  • I have performed a self-review of my code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation where required.
  • I have tested my changes to the best of my ability.
  • My changes generate no new warnings.

@LawrenceLau2020 LawrenceLau2020 self-assigned this Dec 14, 2023
@dbarkowsky
Copy link
Collaborator

dbarkowsky commented Dec 15, 2023

for some reason the imports are failing in some of the tests.

I had a similar issue in another PR where jest keywords like describe weren't recognized. Had to restart VS Code, and TypeScript seemed to pick them up after.
Nvm. Misunderstood the issue.

Copy link

codeclimate bot commented Dec 21, 2023

Code Climate has analyzed commit 2135b7d and detected 2 issues on this pull request.

Here's the issue category breakdown:

Category Count
Duplication 2

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 97.2%.

View more on Code Climate.

Copy link
Collaborator

@dbarkowsky dbarkowsky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving this so we can move forward with other tickets. Contains big changes to folder structure that will have to be rectified in other branches.

@dbarkowsky dbarkowsky merged commit f7d5d07 into main Dec 29, 2023
3 checks passed
@dbarkowsky dbarkowsky deleted the PIMS-531 branch December 29, 2023 16:47
TaylorFries pushed a commit that referenced this pull request Jan 3, 2024
#1979)

Co-authored-by: dbarkowsky <dylanbarkowsky@gmail.com>
Co-authored-by: Graham Stewart <graham.stewart@quartech.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants