Skip to content
This repository was archived by the owner on Jan 11, 2026. It is now read-only.

Commit 994b57d

Browse files
committed
Update README.md
1 parent fa23797 commit 994b57d

File tree

1 file changed

+28
-11
lines changed

1 file changed

+28
-11
lines changed

README.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,38 @@
1-
# peekmo-php-atom-autocomplete package
1+
# atom-autocomplete-php package
22

33
[![Join the chat at https://gitter.im/Peekmo/atom-autocomplete-php](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Peekmo/atom-autocomplete-php?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
44

5-
WORK IN PROGRESS
6-
-----------
5+
# What is done ?
76

8-
Nothing is stable, please, post an issue if you found a problem. And feel free to help :)
7+
This plugin provide those amazing features :
8+
- Autocompletion on class names with use auto added
9+
- Autocompletion on class properties and methods. If your PHP doc is right, you should have autocompletion on X levels (e.g : $this->doctrine->getRepo...) (just works inline for now)
10+
- Local function variables autocompletion
11+
- Writing namespace in top of the file (ctrl - alt - n)
12+
- Autocompletion on PHP internal functions
913

10-
What's needed to make it works ?
11-
- autocomplete-plus plugin
12-
- Window opened in a php project directory, with vendor/autoload.php setted
13-
- Command "php" available.
14+
# How to make it works ?
1415

15-
/!\ Nothing has been test on windows
16+
First, you need the [autocomplete-plus](https://atom.io/packages/autocomplete-plus) package installed.
1617

17-
![AutocompletePHP](http://i.imgur.com/UTaw1BO.gif)
18+
Secondly, only the PHP projects that use [composer](https://getcomposer.org/) to manage their autoload and dependencies are supported. In fact, to give you the autocompletion, the plugin use composer's classmap. So only a project with composer will have all the features. (Some are available without, but not the most interesting ;)
1819

19-
Autocomplete for PHP language on ATOM editor
20+
Finally, your project must follow the PSR norm, some weird things could happen otherwise.
21+
22+
# Settings
23+
24+
To configure the plugin, click on "package" in your preferences, and select "settings" on atom-autocomplete-php plugin.
25+
26+
![Configuration](http://i.imgur.com/MCtNGJQ.png)
27+
28+
## Options :
29+
- *Command to use composer* : it's highly recommended to write here the full path to your composer.phar bin. E.G on unix systems, it could be /usr/local/bin/composer. Using an alias is not recommended at all !
30+
- *Command php* : Command to execute PHP cli in your console. (php by default on unix systems). If it doesn't work, put here the full path to your PHP bin.
31+
- *Composer autoload directories* : Write here, a coma separated list of all the different directories where your composer vendors are in your different projects. By default, it's "vendor", but if you changed it, make sure to update this list ;)
32+
33+
# Next
34+
35+
Keep in mind that this plugin is under active development. If you find a bug, please, open an issue with the more possible informations on how to produce the bug.
36+
Feel free to contribute ;)
2037

2138
![A screenshot of your spankin' package](https://f.cloud.github.com/assets/69169/2290250/c35d867a-a017-11e3-86be-cd7c5bf3ff9b.gif)

0 commit comments

Comments
 (0)