POSHI

This extension is the support for POSHI in VS Code editor.

Met some problems? You could refer HERE.

Why I do this? READ THIS. Sorry for it was written by chinese.

Installation

Please make sure you have installed Node v4+ runtime, refer to HERE.

In order to install an extension you need to launch the Command Pallete (Ctrl + Shift + P or Cmd + Shift + P) and type Extensions. There you have either the option to show the already installed extensions or install new ones.

See more details HERE.

Also you can install it manually by using .vsix file, just drag and drop it to your editor.

Then you need to set POSHI properties for extension by adding the following json segments to your setting.json file.

The setting file in User level(File > Preferences > User Settings) will overwrite the default setting and Workspace level(File > Preferences > Workspace Settings) will overwrite the user setting again only for one particular project.

For Win,

{
    // The absolute project path of Liferay Portal.
    "poshi.liferay.home": "C:\\liferay\\portal\\portal-6210",

    // The relative project path of POSHI.
	"poshi.project.home": "\\portal-web\\test\\functional\\com\\liferay\\portalweb"
}

For Mac/Linux,

{
	// The absolute project path of Liferay Portal.
	"poshi.liferay.home": "/home/lyon/liferay/portal/portal-6210",

	// The relative project path of POSHI.
	"poshi.project.home": "/portal-web/test/functional/com/liferay/portalweb"
}

Then when you open file with poshi ext rule(.testcase, .macro, .function and .path) at the first time, the initilization of index process will start automatically. When it finishs, you will notice the hint message The poshi source mapping has initilized successfully. displays on the editor top.

Trouble Shooting:

I get Your Liferay Home or POSHI Project HOME is not the valid path, please correct them or refer to example/package.json. instead of successful hint message?

This hint message means your poshi properties didn't valid or contians some punctuations like space or other marks. Maybe it's not reasonable for your own habit, but it's better to keep the path pure. Please refer to the properties example above.

I get Your Liferay Home or POSHI Project HOME is null, please set them !! instead of successful hint message?

This hint message means your poshi properties are empty, so set it before you start using the extension, you could refer to the properties example above.

The poshi properties are valid, but I still can't get successful hint message?

This situation maybe happened you set properties after you open the files, please restart the editor or reopen the file to trigger the init process manually.

After extension installed, nothing happened.

It maybe caused by some errors(like dependencies error) that makes the installing process failed,so maybe you must download extension by git and install dependencies by npm. However, this trouble is quite rare.

Usage Info

Shortcut key

alt + P: open a testcase file by syntax like 'CPBlogs#RateBlogsEntry', you will enter CPBlogs.testcase shortly.

Linters

All PO Linters:

Testcase(In Progress)
Macro(Pending)
Function(Pending)
Path(Pending)

To use Linters, you just need to do nothing. The Linters will trigger automatically considering the file's extension, eg: .testcase type will trigger testcaseLinter.

The Linters includes two level, warning and error. The warning level means the code could be more robust, the error level means the code has errors of syntax and format.

Lens

All PO Lens:

Macro(In Progress)
Function(Pending)
Path(Pending) To use Lens, you also need to do nothing. It also triggers automatically considering the file's extension.

The Lens give the dynamic analysis about the code segments, like the vars should be set in Macro declaration.

Symbol & Hover

Symbol(In Progress)
Hover(Pending)

This module just the implement of Symbol & Hover interface for POSHI(command block shortcut).

To use Symbol just use (Ctrl + Shift + O or Cmd + Shift + O) to trigger Command Pallete and type the Symbol key, then focus will move to that command block.

To use Hover just hover the mouse on KEY(eg: locator key), then the info panel will diaplay and show the infomation about the KEY.

Reference Provider

Definition(In Progress)
Peek（In Progress)

To use Peek and Definition, please refer to official Docs about Definition and Peek. This extension only implements the definition interface about PO files.(.testcase, .macro, .function and .path). The completion feature also works out in Peek View.

Completion Provider

IntelliSense(In Progress)

To use InterlliSense, just same as other rich editor. The extension initialize the all segments about PO object. The InterlliSense menu will display when you type and try to bind the input chars to the ideal segment.