Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactored and ready to be pulled #5

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

limjohnny88
Copy link

Hi Jerod,

I have already refactor my code to match the coding style of this project.

I have added a check box control to the top of the console to let the user choose between option.
As I'm not very good at design, I think that it needs to be redesign and make it more presentable.

Maybe we can have another easy to implement feature, by default having auto-completion return 'staring with', and the user can turn it off to return 'global result'.
This would be useful if the user can only remember part of the function or class name.

Let me know what do you think ya. :)

Thanks

Regards
Johnny

@jerodsanto
Copy link
Owner

Hi Johnny-

Cool. Would you mind rebasing all these changes into a single commit that I can test and apply? You can read about this technique here if you haven't done it before.

Also, it is helpful for you to put these in a topic branch on your repo so the pull request will track it instead of your master branch. Just fyi.

Thanks!

-Jerod

@limjohnny88
Copy link
Author

Hi Jerod,

Thanks for the tips! Am learning something new everyday. yay.
I have already merged up my master branch, and in the future i will work on the topic branch and you'll pull from there?

Regards
Johnny

@jerodsanto
Copy link
Owner

Hey Johnny-

I just checked out your changes on wp 3.2 and everything works great. I really like having the auto-completion show the function parameters. Super useful, especially for stuff like array_*

I like it so much, in fact, that I prefer just making it always show the parameters in the single column format rather than giving an option with a checkbox. This is much more simple both for the user and in the code.

Any chance you'd take a crack at just implementing the function parameter changes and leave out all the option management stuff? If so, I suggest reforking (or resetting) off my master and creating a topic branch for the feature.

I hope that isn't asking too much of you!

Thanks.

-Jerod

@limjohnny88
Copy link
Author

Hi Jerod,

So, I will clean up my branch(remove the option management stuff)? Is there any others feature you have in mind, I can help you with that too. :)

I believe that this plugin need a better readme/user guide, like:

$object_variable-> OR $array_of_object[array_index]-> [Tab_Key] will show the object's properties and method
ClassName:: [Tab_Key] will show the class' properties and method
...

Thanks

Regards
Johnny

@jerodsanto
Copy link
Owner

When I first wrote the plugin I was considering inline documentation as a feature (similar to Ruby's "ri" command), but never got around to it and I don't work with WordPress or PHP nearly as much as I used to.

I like the idea of access to documentation (especially WordPress docs) from inside the console, but I don't like overloading the tab completion feature with this as well. Tab completion should "just work" the way it does in other shells (with the exception of showing function parameters, which I think is a solid improvement).

If you want to take a shot at adding inline docs as a feature, by all means go for it. I would suggest introducing a new keyword command (we already have "clear", "help" and "reload") like "doc" or similar which when passed a string will pull up the docs that it finds for said string.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants