https://github.com/drewbrokke/vscode-poshi-language-support

https://github.com/drewbrokke/vscode-poshi-language-support

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/drewbrokke/vscode-poshi-language-support
• Owner: drewbrokke
• License: bsd-2-clause
• Created: 2022-02-23T19:59:00.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-06T03:00:33.000Z (about 3 years ago)
• Last Synced: 2025-02-26T18:12:38.601Z (3 months ago)
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=LiferayInc.poshi-language-support
• Size: 3.45 MB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Poshi Language Support for VS Code

## Features

### Go To Definition

Navigate to definitions using `F12` or using the **Go to Definition** command.

#### Go to function/macro file

![Go to function/macro file](images/gifs/POHSI_VSCODE_GOTODEFINITION_01_CLASS_NAME.gif)

#### Go to function/macro definition

![Go to function/macro definition](images/gifs/POHSI_VSCODE_GOTODEFINITION_02_METHOD_NAME.gif)

#### Go to path file

![Go to path file](images/gifs/POHSI_VSCODE_GOTODEFINITION_03_PATH_NAME.gif)

#### Go to locator definition

![Go to locator definition](images/gifs/POHSI_VSCODE_GOTODEFINITION_04_LOCATOR_NAME.gif)

### Completion

Disabled by default. Can be enabled with the **Poshi > Completion: Enabled** setting.

#### Function/Macro completion

![Function/Macro completion](images/gifs/POHSI_VSCODE_COMPLETION_01_METHOD.gif)

### Formatting

Source formatting powered by Liferay's Source Formatter.

Disabled by default. Can be enabled with the **Poshi > Source Formatter: Enabled** setting.

A Source Formatter standalone jar from [repository.liferay.com](https://repository.liferay.com/nexus/content/repositories/liferay-public-releases/com/liferay/com.liferay.source.formatter.standalone/1.0.0/.) is required for this to work. Auto-fetching the jar will be available in the future.

This is a work in progress. If enabled, it is recommended that you disable format on save for now and invoke it manually.

## Extension Settings

```json

"poshi.completion.enabled": {

    "description": "Specifies whether or not to enable auto-completion.",

    "default": false,

    "type": "boolean"

},

"poshi.goToDefinition.enabled": {

    "description": "Specifies whether or not to enable go-to-definition.",

    "default": true,

    "type": "boolean"

},

"poshi.sourceFormatter.enabled": {

    "description": "Specifies whether the to use Liferay's Source Formatter as the formatter for Poshi files.",

    "default": false,

    "type": "boolean"

},

"poshi.sourceFormatter.jarPath": {

    "markdownDescription": "The path to the source-formatter-standalone jar. It will be invoked with `java -jar {}`.\nExample: `file:///Users/me/Documents/source-formatter-standalone.jar`",

    "default": "",

    "type": "string",

    "format": "uri"

}

```

## Release Notes

### 0.2.0

-   Provides method completion from multiple possible files

-   POSHI-304: Adds locator completion

-   POSHI-300: Adds "Show References" support for functions and macros

-   POSHI-296: Adds go-to-definition for selenium methods

-   POSHI-267: Adds go-to-definition support for Util class methods

### 0.1.0, 0.1.1, 0.1.2

Implements CI builds

### 0.0.3

-   Adds more precise go-to-definition for methods

-   Adds go-to-definition for variables

-   Fixes property completion suggestions

### 0.0.2

Adds License and README.md descriptions.

### 0.0.1

Initial test release