Skip to content

🚧Improve pathing based on OS #358

@CalvinWilkinson

Description

@CalvinWilkinson

Complete The Item Below

  • I have updated the title without removing the 🚧 emoji.

Description

Improve the pathing and how it is treated based on the operating system.

When on the Windows OS, check for and replace all / characters with \ characters.

This will prevent the worry of using mixed directory separators in the path, causing issues with other libraries that use CASL. One library that benefits from this change is Velaptor. In Velaptor, this path is used as a unique caching key and will make sure that the path is using the expected directory separators per OS just like in Velaptor.

With non-Windows operating systems, only the / character is accepted, so the worry of a mix of directory separator characters does not exist.

Acceptance Criteria

### The items to complete to satisfy the Definition of Done.
- [x] All the unit tests have been executed and passed locally after PR work is complete. _(Why? Refer to 'Additional Information' below.)_
- [x] Mixed dir seperators converted to only `\` characters

ToDo Items

### The items to complete to satisfy the Definition of Done.
- [x] Add a change type label to the issue.  Refer to the _**Change Type Labels**_ section below.
- [x] Add a priority label to the issue.  Refer to the _**Priority Type Labels**_ section below.
- [x] Link the issue to the correct milestone _(if applicable)_.

Issue Dependencies

No response

Related Work

No response

Additional Information:

Unit Tests

Reasons for local unit test execution:

  • Unit tests might pass locally but not in the CI environment during the status check process or vice-versa.
  • Tests might pass on the developer's machine but not necessarily on the code reviewer's machine.
  • If you notice that the test status check has passed but the test failed locally, please notify a project maintainer!

💡Warning💡
If the unit tests pass remotely and are not executed locally, this means we could be letting a bug slip into production.
Though bugs will always exist in some capacity, we should all do our part to help prevent them from happening.

Change Type Labels

Change Type Label
Bug Fixes 🐛bug
Breaking Changes 🧨breaking-changes
New Feature ✨new-feature
CICD Changes ♻️cicd
Config Changes ⚙️config
Performance Improvements 🏎️performance
Code Doc Changes 🗒️documentation/code
Product Doc Changes 📝documentation/product

Priority Type Labels

Priority Type Label
Low Priority low priority
Medium Priority medium priority
High Priority high priority

Code of Conduct

  • I agree to follow this project's Code of Conduct.

Metadata

Metadata

Labels

documentation-codeCode documentation changes in source code. XML code docs/commentshigh-priorityHigh PrioritypreviewDone while in preview

Projects

Status

✅Done

Relationships

None yet

Development

No branches or pull requests

Issue actions