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

[STY] fix some remark warnings #2026

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Remi-Gau
Copy link
Collaborator

@Remi-Gau Remi-Gau commented Jan 9, 2025

I was getting those locally.

Not sure why they are not caught in CI.

@Remi-Gau Remi-Gau added the exclude-from-changelog This item will not feature in the automatically generated changelog label Jan 9, 2025
Copy link
Collaborator

@DimitriPapadopoulos DimitriPapadopoulos left a comment

Choose a reason for hiding this comment

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

What sort of errors do you get, and from which linter? The reason for the local warnings might be different versions.

@Remi-Gau
Copy link
Collaborator Author

jsut did the following on master and tried to use a node version close to the one used in CI

$ nvm install 22                                   
$ node --version
v22.13.0
$ npm --version
10.9.2
$ npm install `cat npm-requirements.txt` 
$ npx remark src/**/*.md --frail --rc-path .remarkrc 
src/appendices/arterial-spin-labeling.md: no issues found
src/appendices/contributors.md: no issues found
src/appendices/coordinate-systems.md: no issues found
src/appendices/cross-modality-correspondence.md: no issues found
src/appendices/entities.md: no issues found
src/appendices/entity-table.md: no issues found
src/appendices/file-collections.md: no issues found
src/appendices/hed.md: no issues found
src/appendices/licenses.md: no issues found
src/appendices/meg-file-formats.md: no issues found
src/appendices/meg-systems.md: no issues found
src/appendices/qmri.md: no issues found
src/appendices/schema.md: no issues found
src/appendices/units.md: no issues found
src/CHANGES.md
40:53-40:80      warning Unexpected GFM autolink literal, expected regular autolink, add `<` before and `>` after          no-literal-urls             remark-lint

src/common-principles.md
18:1             warning Unexpected unordered list marker `*`, expected `-`                                                unordered-list-marker-style remark-lint
18:3             warning Unexpected `1` space between list item marker and content, expected `3` spaces, add `2` spaces    list-item-indent            remark-lint
19:1             warning Unexpected unordered list marker `*`, expected `-`                                                unordered-list-marker-style remark-lint
19:3             warning Unexpected `1` space between list item marker and content, expected `3` spaces, add `2` spaces    list-item-indent            remark-lint
20:1             warning Unexpected unordered list marker `*`, expected `-`                                                unordered-list-marker-style remark-lint
20:3             warning Unexpected `1` space between list item marker and content, expected `3` spaces, add `2` spaces    list-item-indent            remark-lint
486:74-487:1     warning Unexpected `0` blank lines between list items, expected `1` blank line, add `1` blank line        list-item-spacing           remark-lint
  [cause]:
    484:1-486:74 info    Spaced list item first defined here                                                               list-item-spacing           remark-lint
608:59-609:1     warning Unexpected `0` blank lines between list items, expected `1` blank line, add `1` blank line        list-item-spacing           remark-lint
  [cause]:
    607:1-608:59 info    Spaced list item first defined here                                                               list-item-spacing           remark-lint
610:33-611:1     warning Unexpected `0` blank lines between list items, expected `1` blank line, add `1` blank line        list-item-spacing           remark-lint
  [cause]:
    607:1-608:59 info    Spaced list item first defined here                                                               list-item-spacing           remark-lint

src/derivatives/common-data-types.md: no issues found
src/derivatives/imaging.md: no issues found
src/derivatives/introduction.md: no issues found
src/extensions.md: no issues found
src/glossary.md: no issues found
src/index.md: no issues found
src/introduction.md
181:6            warning Unexpected `4` spaces between list item marker and content, expected `3` spaces, remove `1` space list-item-indent            remark-lint

src/longitudinal-and-multi-site-studies.md
99:1             warning Unexpected `2` blank lines before node, expected up to `1` blank line, remove `1` blank line      no-consecutive-blank-lines  remark-lint

src/modality-agnostic-files.md
549:1-549:44     warning Unexpected unused definition, expected no definition or one or more references to `object`        no-unused-definitions       remark-lint
551:1-551:61     warning Unexpected unused definition, expected no definition or one or more references to `string`        no-unused-definitions       remark-lint
553:1-553:57     warning Unexpected unused definition, expected no definition or one or more references to `uri`           no-unused-definitions       remark-lint

src/modality-specific-files/behavioral-experiments.md: no issues found
src/modality-specific-files/electroencephalography.md: no issues found
src/modality-specific-files/genetic-descriptor.md: no issues found
src/modality-specific-files/intracranial-electroencephalography.md: no issues found
src/modality-specific-files/magnetic-resonance-imaging-data.md: no issues found
src/modality-specific-files/magnetic-resonance-spectroscopy.md: no issues found
src/modality-specific-files/magnetoencephalography.md: no issues found
src/modality-specific-files/microscopy.md: no issues found
src/modality-specific-files/motion.md: no issues found
src/modality-specific-files/near-infrared-spectroscopy.md: no issues found
src/modality-specific-files/physiological-recordings.md: no issues found
src/modality-specific-files/positron-emission-tomography.md: no issues found
src/modality-specific-files/task-events.md: no issues found
src/pregh-changes.md: no issues found
src/schema/README.md: no issues found

⚠ 15 warnings

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
exclude-from-changelog This item will not feature in the automatically generated changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants