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

Updated qiime2.biotools.json manually #638

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

Conversation

matuskalas
Copy link
Contributor

@matuskalas matuskalas commented Oct 12, 2023

There are multiple reasons for this:

❗❗❗ This also points to the fact that the diff is completely useless here, rendering the whole GitHub workflow with PR reviews impossible 😥😥 (at least not if JSON editted outside of Bio.tools) @bgruening @hmenager

There are multiple reasons for this:

- Bio.tools editting didn't work (bio-tools/biotoolsRegistry#573)

- Test what future bot PRs do with files updated by people
@matuskalas matuskalas added help wanted Extra attention is needed discussion content labels Oct 12, 2023
@bgruening
Copy link
Contributor

I would not be too worried about the diff. This only tells use that we need a unified formatting of JSONs. Than the diffs look much better. So we need to autoformat json with a common schema.

@matuskalas
Copy link
Contributor Author

I would not be too worried about the diff. This only tells use that we need a unified formatting of JSONs. Than the diffs look much better. So we need to autoformat json with a common schema.

Exactly! But how to do that? Do you have experience with it / working examples?

E.g.: How does it work with the XMLs in Galaxy and the Conda recipes? If they are editted only manually, it's not an issue. But the combination of graphical editting in a tool, and manual editting as text, causes troubles. This problem is of course enormous in EDAM 😟

@hmenager
Copy link
Collaborator

Hi @matuskalas @bgruening,

Thanks a lot for reporting this. There are three different matters here:

  1. the pull request cannot be usefully merged here, modifications would be automatically erased by the next weekly synch. only logical way to solve this is to have bidirectional sync between bio.tools and RSEc.
  2. the bug with the validation on bio.tools can be investigated, thanks for reporting.
  3. as for the diff, I recommend (and use myself) jq, a small utility that can do lots of things with json. one example is completely resorting json files. We use it in RSEc to reformat automatically all json data from bio.tools, in order to minimize the diff, make them more readable, and minimize (a tiny bit) the growth of the git repo. Command for this is:
    jq --indent 4 'walk( if type == "array" then sort else . end )' -S [FILE]
    This last line sorts all arrays and object keys, and reformats all white space. This means that for the same contents the format is predictable (a bit like the black tool for python formatting).
    Using this to reformat properly the json, the diff goes from 944 lines to 126 lines in this case, which is a lot easier to read.

As for EDAM, this should probably be discussed in an issue on the repository itself. One thing I would advocate is adopting the same strategy, but for an RDF-XML file. This could be harder, because there are "rules" for the formatting of EDAM in order to maintain its readability in a raw text format.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content discussion help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants