[#3243] Ignore JSON comments

[SeliasB]

Fixes #3243

Changes proposed in this pull request:

• added the possibility to ingore comments if in JSON file imported
• the idea is to check if the checkbox is checked, if so, enable ALLOWS_COMMENTS and ALLOW_COMMENTS_YAML from JasonFactory method
• skippable comments are { // ... , # ... , /* ... */ } format

[wetneb]

Thank you for this pull request!
I wonder about two things:

• as a user, is there any case in which I would want to turn off this option? When is it important that ignoreComments == false? Intuitively, I feel like this option could be always left to true - and therefore not be exposed in the UI at all.
• are there other features of JsonFactory that make the JSON parsing more forgiving, and if so, would it also make sense to turn them on systematically?

[SeliasB]

@wetneb

About setting the ignore comment to true, I feel like it could be always setted to skip comments. on another hand, I can double check, but I have noticed that if I set the ignore comments to true by default, the importer creates new empty rows on the viewer, so it probably creates unmanaged artifacts.
two possible reasons: I enabled comments on the parser as it has the same behaviour as the Jsonfactory or :
The way it preset at the importation and during the project creation is slightly different so it creates artifacts

I will try to set it true by default and double check if I can manage to have consistent behaviour on the viewer. if so, yes it is relevant to set it to true by default

[wetneb]

Sounds like a great plan, thank you!

[wetneb]

Hi @SeliasB, are you still working on this?

[SeliasB]

@wetneb Sorry, I've been in a rush,
should finish the work by the end of june !

[wetneb]

Hi @SeliasB, are you still working on this?

[wetneb]

Closing per inactivity, but happy to reopen if activity resumes.

[thadguidry]

Thank you for this pull request! I wonder about two things:

• as a user, is there any case in which I would want to turn off this option? When is it important that ignoreComments == false? Intuitively, I feel like this option could be always left to true - and therefore not be exposed in the UI at all.
• are there other features of JsonFactory that make the JSON parsing more forgiving, and if so, would it also make sense to turn them on systematically?

The use case of having an option was so that users could edit and use the data that is sometimes inside the comment lines. Using facets they can filter out the first X rows, and also copy/paste metadata from within comment lines into actual real row cell values as necessary. The comment lines sometimes hold partial schema annotations and metadata. That's why the option to keep the comment lines is useful, thereby letting the users data wrangle with the lines themselves and create a full project for export that includes the incorporated metadata into JSON record row headers and then export.

@wetneb Please make this a checkbox option with default OFF. We want to continue to give choices to users, not make them for them. "Smart defaults with options - always." Thanks.

[thadguidry]

ugh this is the PR !
@wetneb Perhaps I should delete those above comments from me and put all this explanation into the Issue #3243 ?