fkling / astexplorer

A web tool to explore the ASTs generated by various parsers.
https://astexplorer.net/
MIT License
6.21k stars 740 forks source link

A few items I would like to work on / discuss #176

Open skratchdot opened 7 years ago

skratchdot commented 7 years ago

@fkling - First off, thanks again for this great project (and pulling in my small / recent pull requests)!

Since I've started using your tool, there are a few TODOs that I've been thinking about. I would like to start work on these unless you have any suggestions or disagreements about adding any of these features (i.e. you want to do them yourself or don't want them added to the project).

Here's the quick list:

Currently, I've got jest added in a local branch (but no actual unit tests :)). I'm working on a jscodeshift transform that adds base tests / snapshots for functions. I think getting a base test suite started might help me learn the codebase (and get some practice w/ using jest), so was hoping to try to work on that this weekend if you have no objections. We could eventually get the test suite part of the build process (i.e. tests run before pull requests get merged).

Thoughts / Feedback?

Should I close this ticket out or create new issues with labels for these? Is there a different forum/medium to have a discussion/chat, or should I just use Github?

Thanks again!

fkling commented 7 years ago

Hey @skratchdot , sorry for the late reply (it's pretty busy at the end of the year ;) )

I would like to start work on these unless you have any suggestions or disagreements about adding any of these features (i.e. you want to do them yourself or don't want them added to the project).

Thank you so much for contributing! I appreciate any little bit if help (well, in your case it doesn't seem to be just a "little" ;) )

Most of these look good to me, let me comment on some of them.

add unit tests

Yep, that's something I certainly neglected and improving the code quality through tests would be great. At work we are putting tests inside __tests__ folders that live next to the module that is tested. I like that approach.

make the site responsive

Sounds good to me too! Might also be a great starting point to think about the UI of the site in general.

make a cli

That's a really interesting idea. I like it. However, parse is shutting down in January. I'm planning to use gists instead (see #142). So with this we should certainly wait until we sorted out the backend situation.

add more parsers

The more the better! Given the increasing number of parsers, I was actually wondering how parsers could be organized a better without overwhelming the UI. One idea I had (which might also allow us to support different versions of parsers) would be to have a separate parser registry and the UI would allow you to browse and search for parsers (instead of having a single huge menu). That would also enable us to add new parsers or parser versions without having to rebuild the whole site.

This might require running a "parser service" on a server, but I'm OK with that.

Should I close this ticket out or create new issues with labels for these?

Whatever suits you. I kind of like having this overview. Maybe we can start a new post with all todo's for the new future.

Is there a different forum/medium to have a discussion/chat, or should I just use Github?

I added a gitter room https://gitter.im/astexplorer/Lobby ... not exactly how I wanted to set it up but I guess it will work.

skratchdot commented 7 years ago

I just happened to be looking at my github notifications, and saw that gitter link. Kinda scary I joined so fast I guess! Seems like a good idea though. Thanks for all the feedback!