fkling / fkling/astexplorer

A few items I would like to work on / discuss

Open
#176 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
6.5k
Forks
772
PR merge metrics
No merged PRs in 30d

Description

@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:

- [ ] add unit tests
- i would like to use jest.
- have discussion on where tests go
- [ ] make the site responsive
- small refactor to make header and footer responsive
- body content should either switch to a stacked view or a tabbed view
- [ ] add logos for things
- [x] use real GraphQL logo (#177)
- [ ] add logos for tree vs json view
- [ ] add parser/transformer logos?
- [ ] github logo for links to github
- [ ] script to generate homepage links automatically and put them in README.md
- [ ] make a cli
- `ast open --input-file file.js --parser recast --transformer jscodeshift`
- would open ast explorer with the given settings
- `ast publish --input-file file.js --parser recast --transformer jscodeshift`
- would save data in parse and generate a url for you to share everywhere
- [ ] add badges to readme (npm/travis/coveralls/codeclimate/david-dm)
- [ ] add CI tools:
- travis
- coveralls
- code climate
- [ ] add more parsers
- [x] sql (#178)
- [ ] markdown
- [ ] templates
- [ ] dustjs
- [ ] mustache
- [x] handlebars (#183) [fixed by @Turbo87]

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!

Contributor guide

No contributing guide indexed for this repository

Research direction

This issue is a broad wishlist covering tests, responsive layout, logos, README.md automation, a CLI, CI services, and additional parsers, without naming implementation files or tests. Start by checking the current project structure and README.md, then split one agreed item into a separate issue with a defined entry point and completion criteria.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, javascript
Domain
build-system, ci-cd, cli, documentation, frontend, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.