Skip to content

Conversation

happy5214
Copy link
Member

This PR makes several changes to issue handling:

  • BidsIssue has been merged into BidsHedIssue, and most of the combined class's fields have been renamed.
  • A new static method has been added to IssueError as a shortcut for throwing internal errors.
  • All remaining uses of plain Errors have been converted to IssueErrors.
  • internalConsistencyError has been merged into internalError.

I also added a few types back where allowed by JSDoc. In particular, I found that Map and Set generics are allowed.

I attempted to create an IssueError analog for BidsHedIssue, but it wouldn't wrap issues created within the partnered schema merge, so I removed it.

@happy5214 happy5214 added bids BIDS integration hed 3 HED 3-specific issues issues BIDS and HED-specific issue data tasks labels Feb 14, 2025
@happy5214 happy5214 added this to the 4.0.0 milestone Feb 14, 2025
@happy5214 happy5214 requested a review from VisLab February 14, 2025 01:22
@happy5214 happy5214 self-assigned this Feb 14, 2025
Copy link
Member

@VisLab VisLab left a comment

Choose a reason for hiding this comment

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

Looks good -- except I wonder why in issues.js on line 75 this returns a promise?

Also, can you add the additional items we discussed to the public interface. Then you can go ahead and merge.

@happy5214
Copy link
Member Author

Looks good -- except I wonder why in issues.js on line 75 this returns a promise?

Also, can you add the additional items we discussed to the public interface. Then you can go ahead and merge.

It returns a Promise because all async functions return those implicitly.

I was planning to do the API changes in a separate PR once we finalized the list (which I didn't feel like we completed yesterday).

@VisLab VisLab merged commit 08f5e7d into hed-standard:develop Feb 15, 2025
6 of 7 checks passed
@happy5214 happy5214 deleted the issue-changes branch March 8, 2025 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bids BIDS integration hed 3 HED 3-specific issues issues BIDS and HED-specific issue data tasks

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants