Means for querying nodes, operating on them

sabof / project-explorer

A project explorer sidebar

267 stars 18 forks source link

Means for querying nodes, operating on them #8

Closed vemv closed 10 years ago

vemv commented 10 years ago

All projects I work on have directories that I will always want to be open, for example in the context of a Rails project, it'd be convenient if the models, views and controllers directories were open at startup.

Perhaps a comprehensive/flexible solution for auto-opening would be too much to ask, but an API with basic operations on nodes seems reasonable? i.e.:

Finding a dir/file by name, given a node to search in. That node would be the project root by default, and search probably shouldn't be recursive (for simplicity)
Getting the parent/chilren of a node object
Opening/closing/toggling the collapsed state of a dir node
Opening the file a corresponding to a file node.

What do you think?

Thank you - Victor

sabof commented 10 years ago

The functionality is already implemented, apart from the "node children" one -- that's how navigation works. I admit that there are some shady bits (ex the behavior of *-internal function is not always consistent) , I do plan to refactor/document them at some point.

vemv commented 10 years ago

I failed to find those implemented features. Surely they are 'there' but aren't provided in an orthogonal way - but rather, used ad-hoc in the plugin implementation...

sabof commented 10 years ago

The main functions are (pe/goto-filename) and (pe/get-filename). Many others operate based on the location of point. So if you wanted to fold something specific, you would (pe/goto-filename) and then (pe/fold). You can use them if you want, but I don't guarantee that names and/or implementation won't change. Ex. it's pe/goto-filename on the devel branch, and pe/goto-file on master.

vemv commented 10 years ago

I am glad you plan to keep working in the project. Thanks for the pointers!

On Sun, Nov 10, 2013 at 9:41 PM, Evgkeni Sampelnikof < notifications@github.com> wrote:

The main functions are (pe/goto-filename) and (pe/get-filename). Many others operate based on the location of point. So if you wanted to fold something specific, you would (pe/goto-filename) and then (pe/fold). You can use them if you want, but I don't guarantee that names and/or implementation won't change. Ex. it's pe/goto-filename on the develbranch, and pe/goto-file on master.

— Reply to this email directly or view it on GitHubhttps://github.com/sabof/project-explorer/issues/8#issuecomment-28160025 .

sabof commented 10 years ago

I've added docstrings, and cleaned up the code. Hopefully this will make it more understandable.