search

ObieSource / obiesource.github.io

The ObieSource Website. Project Leader: Ajai Nelson
https://obiesource.github.io/
2 stars 22 forks source link

Show JSON parsing errors on member page #4

Closed AjaiKN closed 2 years ago

AjaiKN commented 2 years ago

If someone makes a mistake while making their JSON file and it can't be parsed, it will now show that error on the page.

iosenberg commented 2 years ago

This looks great! I love that the error tells the user exactly how to fix it. Very efficient

wknowleskellett commented 2 years ago

Great addition. How can we make sure that .jsons with errors never make it onto the website? That would be embarrassing. I don't think this thought should prevent this pr from moving forward. It would help if we had a github action that generated the page and could check for these h1's. Maybe they could be added as <h1 class="error-header">The message</h1> and an action could easily search for that. I haven't thought it through, but it seems like if you can do it in a CLI, you can do it in Actions

FiskFan1999 commented 2 years ago

We could use a json linter and/or write a python script which uses custom logic to check each json file for the right keys and values.

Sent from my iPhone

On Apr 3, 2022, at 19:55, William Knowles-Kellett @.***> wrote:

 Great addition. How can we make sure that .jsons with errors never make it onto the website? That would be embarrassing. I don't think this thought should prevent this pr from moving forward. It would help if we had a github action that generated the page and could check for these h1's. Maybe they could be added as

The message

and an action could easily search for that. I haven't thought it through, but it seems like if you can do it in a CLI, you can do it in Actions

— Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because your review was requested.

AjaiKN commented 2 years ago

How can we make sure that .jsons with errors never make it onto the website?

I don't think it'll be a huge issue for a small project like this, since presumably we'll have people reviewing and testing the PRs. But it's an interesting idea! If anyone wants to work on this, I wouldn't object.

iosenberg commented 2 years ago

I'm gonna go ahead and merge this. @FiskFan1999 if you think the return issue is big enough, let me know, and I'll open an issue on it.