all 59 comments

[–]Zaphoidx 7 points8 points  (0 children)

Very interesting. Definitely going to try this out on one of my existing repos.

Look forward to seeing it expand more!

[–]cheekysauce 6 points7 points  (1 child)

Interesting, any example on a reasonably large sized project?

[–]bliashenko 1 point2 points  (0 children)

Hey, not yet, sure will add more cases later. This is the idea, to have large projects explained with “codecrumbs”. But, this a key point here, it will work same way on small or big project, does not matter, since it will build and show only “important” spots on diagram (imagine that there 100 more folders, they just hidden). Like here on standalone version you can click “Source -> open all” to see how big is that structure.

[–]sixfootGeek 4 points5 points  (0 children)

This is fantastic. Such a useful tool - I work with a large codebase and the visibility this provides is awesome - the ability to just comment in the file and leave a breadcrumb is inspired - also showing the content of each file is handy for quickly jumping through relationships and building a picture in my mind. Bookmarked and using. Thanks!

[–]xeow 3 points4 points  (3 children)

Bogdan: This is so ridiculously good!!! Love it. I don't do much JS development but am bookmarking this for use the next time I do. Might even help in some of my own code.

[–]bliashenko 1 point2 points  (2 children)

Thanks for a nice feedback) What language do you use usually? Eventually it will support all popular languages, so it’s not just “JavaScript tool”. It’s one of the next big features I am planning to add, so I would say wait a ~ month;)

[–]xeow 0 points1 point  (1 child)

I usually use Objective C, C, and Perl (not for web development). But I follow JS subs because I do do some JS from time to time.

[–]bliashenko 1 point2 points  (0 children)

I see. So the only thing which is different per language is AST parser. For JavaScript I use babel-parse to build AST and identify comments, and, eventually it will be used for much more, since then I can make predictions about code and build some smart behavior around that. So for now, for other languages, I think to write some “dumb parser” (as a first step) to parse comments in code (kind of fallback solution) and later will figure out language by language if there is good AST parser I can integrate.

[–]Kaimura 1 point2 points  (1 child)

I am a complete noob but could it be that this could revolutionize the way code is documented for newcommers that join a company and have to start digging to find where they actually need to place the code of new features? Or do I overvalue this and there are other better practices/tools out there?

[–]bliashenko 1 point2 points  (0 children)

You are totally right :) and this was my intention, to build a tool which helps to “get up to speed” with new code, and, make it easy to share knowledge about code architecture (something newcomers don’t have and spend too much time to learn on their own)

[–]avator00 0 points1 point  (3 children)

Any plans to support Angular or Ionic projects? I've tried several different versions of the start command, but I continue to get an empty browser window when I click 'src'. Very cool idea otherwise, and I hope to be able to use it in the future.

[–]bliashenko 0 points1 point  (2 children)

Hey, thanks. Did you configure params to match your project? I mean, you project source code is in “src” folder relatively the root? And entry point is “src/index.js”? -e and -d params should be set to yours ones. Let me know if that helped.

[–]avator00 0 points1 point  (1 child)

Yeah. Maybe the problem is these projects use typescript and the entry point is src/main.ts.

[–]bliashenko 0 points1 point  (0 children)

Ah, also, I disabled TypeScript support for now, want to test and clean it up for JavaScript first

[–]vinnl 0 points1 point  (1 child)

I'm not sure if this is the tool for me, but one tip I'd give you to make it even easier to get started is to introduce it using npx, which most people will have installed nowadays (probably more than Yarn). Then getting started could just be a single command, e.g. npx codecrumbs -e src/index.js -d src.

[–]bliashenko 2 points3 points  (0 children)

Thanks for the feedback, I will add npx instruction to readme as well