This package adds features to improve PHP development in ATOM.

The project panel gets a section to list Open Files and access to user defined tools written in plain javascript.

A new Explorer Panel is added to access the source tree (symbols), bookmarks and other features in context of a file.

The command exw-ide:show-explorer displays the Explorer Panel where symbols, bookmarks and others are displayed.

Toggle bookmarks to parts of your code with CTRL-SHIFT-8.

Use the commands exw-ide:toggle-bookmark, exw-ide:jump-to-next-bookmark when configuring your own Keymaps.

The command exw-ide:show-explorer displays the Explorer Panel where bookmarks are listed.

Adds autocomplete to PHP scripts.

The Symbol Tree displays code symbols (functions, objects, etc) found in your source code.

The Symbol Tree uses a grammar definition that can easily be modified to accommodate your needs. The first time this package is used a default grammar is placed in the file ~/.atom/exc_sym_grammer.js. Open this file to make your modifications and relaunch Atom.

The command exw-ide:show-explorer displays the Explorer Panel where symbols are displayed.

Press the keys ctrl-r or cmd-r to show a dialog to search for symbols. (Use command exw-ide:show-symbols).

The Symbol Tree allows special markers in your code as PRAGMA instructions for the IDE. A basic pragma allows you to add code bookmarks for special areas or as to-do reminders.

//#MARK My comment here...
//#TODO Review this function
//#TODO

Markers use the syntax of single line comments for the given source code language. For example in css we would use:

/* #MARK My comment here... */

The file exc_config_store.json stores more advance configurations not available in settings. This file is found in your ~/.atom folder.

Available keys:

This configuration file can also be used to add configuration keys for your user tools.

You can add your own costume tool scripts to the Project Panel. A tool script executes miscellaneous code.

Tool scripts are JS scripts that you place in the folder ~/atom/exw-ide-tools/ and add an action that will be listed in the Tools menu of the project panel.

tool = {
	title: 'Selection to string',
	onAction: function(){
		let editor = ide.getTextEditor();
		if(!editor) return;
		let selection = ide.editor.getSelection();
		if(!selection) return;

		if (!selection.endsWith('\n')) {
			selection += '\n';
		}
		var escaped = '\'' + selection.replace(/'/g, '\\\'').replace(/\n/g, '\\n\' + \n\'').replace(/\' \+ \n\'$/, '\';');

		ide.editor.insertText(escaped);
    }
}

The tool script creates a tool object with the definition of your tool command. The 'onAction' property is the function where you place the code to be executed when the action is invoked.

Tools have a helper object ide that makes it easier to write tools without having to learn all of the Atoms internals.

//Run commands
//Proxy for exec, see: https://nodejs.org/api/child_process.html
let cmdPromise = ide.exec(cmd, options);
//this function is resolved with an object {code, stdout, stderr}, where code is the exit code.

//Proxy for spawn, see https://nodejs.org/api/child_process.html
let cmdPromise = ide.spawn(cmd, args, options);

//Returns the active document a helper that wraps together related functionality found in Atom.
let doc = ide.getDocument();

//Returns the current TextEditor, see https://flight-manual.atom.io/api/v1.57.0/TextEditor/
let editor = ide.getTextEditor();

//Key-Value Pair storage
ide.config.set(key, value);
ide.config.get(key);
ide.config.save(); //save the kv store

//Simplified editor interface
let lng = ide.editor.getLanguage();
let textSize = ide.editor.getLength();
let text = ide.editor.getValue();
let text = ide.editor.getSelection();
let title = ide.editor.getTitle();
let filePath = ide.editor.getPath();
let filename = ide.editor.getFileName();

ide.editor.setValue(text);
ide.editor.insertText(aString, opIsSelected);

Other objects exposed to tools are atom, fs, path, console.