Vendor Functions

---

Vendor is related to specific software vendors and integration with the shell.

contextOpen

Open a file in a shell using the program we

Usage

contextOpen [ --help ]

Open a file in a shell using the program we are using. Supports VSCode and PHPStorm.

Location: bin/build/tools/vendor.sh

Arguments

• --help - Flag. Optional. Display this help.

Return codes

• 0 - Success
• 1 - Environment error
• 2 - Argument error

Environment

• EDITOR Editor Command – Callable. Binary for editing files - Used as a default editor (first)
• VISUAL File Preview – Executable. Binary for viewing files - Used as another default editor (last)

contextShow

Show the current editor being used as a text string

Usage

contextShow

Show the current editor being used as a text string

Location: bin/build/tools/vendor.sh

Arguments

• none

Return codes

• 1 - If no editor or running program can be determined

Environment

• EDITOR Editor Command – Callable. Binary for editing files - Used as a default editor (first)
• VISUAL File Preview – Executable. Binary for viewing files - Used as another default editor (last)

isPHPStorm

Are we within the JetBrains PHPStorm terminal?

Usage

isPHPStorm [ --help ]

Are we within the JetBrains PHPStorm terminal?

Location: bin/build/tools/vendor.sh

Arguments

• --help - Flag. Optional. Display this help.

Return codes

• 0 - within the PhpStorm terminal
• 1 - not within the PhpStorm terminal AFAIK

See Also

• contextOpen - Open a file in a shell using the program we (source)

isPyCharm

Are we within the JetBrains PyCharm terminal?

Usage

isPyCharm [ --help ]

Are we within the JetBrains PyCharm terminal?

Location: bin/build/tools/vendor.sh

Arguments

• --help - Flag. Optional. Display this help.

Return codes

• 0 - within the PyCharm terminal
• 1 - not within the PyCharm terminal AFAIK

See Also

• contextOpen - Open a file in a shell using the program we (source)

isVisualStudioCode

Are we within the Microsoft Visual Studio Code terminal?

Usage

isVisualStudioCode [ --help ]

Are we within the Microsoft Visual Studio Code terminal?

Location: bin/build/tools/vendor.sh

Arguments

• --help - Flag. Optional. Display this help.

Return codes

• 0 - within the Visual Studio Code terminal
• 1 - not within the Visual Studio Code terminal AFAIK

See Also

• contextOpen - Open a file in a shell using the program we (source)

---

🛠️ Tools · ⬅ Top