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

fix(context): Add file size to context, fixes README_FILE_SMALL #2030

Merged
merged 1 commit into from
Jul 30, 2024

Conversation

effigies
Copy link
Collaborator

We were getting false positives on README_FILE_SMALL:

ReadmeFileSmall:
  issue:
    code: README_FILE_SMALL
    message: |
      The recommended file '/README' is very small.
      Please consider expanding it with additional information about the dataset.
    level: warning
  selectors:
    - match(path, '^/README')
  checks:
    - size > 150

Turns out size wasn't implemented, but the fix is quick.

Copy link

codecov bot commented Jul 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.36%. Comparing base (93868ab) to head (9570834).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2030      +/-   ##
==========================================
+ Coverage   85.75%   87.36%   +1.60%     
==========================================
  Files          91      132      +41     
  Lines        3785     6330    +2545     
  Branches     1218     1528     +310     
==========================================
+ Hits         3246     5530    +2284     
- Misses        453      709     +256     
- Partials       86       91       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rwblair rwblair merged commit 1b17f77 into bids-standard:master Jul 30, 2024
33 checks passed
@rwblair
Copy link
Member

rwblair commented Jul 30, 2024

We should double check this in the browser to make sure a size is reported on that api's file object.

@effigies effigies deleted the fix/context-size branch July 30, 2024 14:30
@effigies
Copy link
Collaborator Author

Confirmed that this issue doesn't falsely show up in the web browser now. Truncating a README to 149 characters does cause the issue to be raised.

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