development/github-desktop
development/github-desktop
1
0
Fork 0
mirror of https://github.com/desktop/desktop synced 2024-08-28 12:40:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse source
This commit is contained in:
Tsvetilian Yankov 2022-12-17 00:01:29 +02:00
parent 7204c01aad
commit 9a3db00ce4
2 changed files with 21 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
app/src/lib/editors/win32.ts
View file

@ -62,10 +62,12 @@ type WindowsExternalEditor = {
readonly publisher: string
/**
* Default shell script name for JetBrains Products
* Default shell script name for JetBrains Product
* To get the script name go to:
* JetBrains Toolbox > Editor settings > Shell script name
* Note: Don't use on JetBrains community and edu editions
*
* Go to `/docs/techical/editor-integration.md` for more information on
* how to use this field.
*/
readonly jetBrainsToolboxScriptName?: string
} & WindowsExternalEditorPathInfo

22
docs/technical/editor-integration.md
View file

@ -206,20 +206,32 @@ missing or lost it won't let you launch the external editor.
### Support for JetBrains Toolbox editors
Now GitHub Desktop support editors installed through JetBrains Toolbox.
The technique used to achieve that is using `toolboxShellScriptName` parameter
to check if, in the default section for scripts in JetBrainsm Toolbox a script
Now GitHub Desktop support editors installed through JetBrains Toolbox.
The technique used to achieve that is using `jetBrainsToolboxScriptName` field
to check if, in the default section for scripts in JetBrainsm Toolbox, a script
with the corresponding name exists.
```ts
{
name: 'JetBrains PyCharm',
...
toolboxShellScriptName: 'pycharm',
jetBrainsToolboxScriptName: 'pycharm',
},
```
**Note:** Don't use `jetBrainsToolboxScriptName` field on JetBrains community and edu
editions. When JetBrains Toolbox generates the scripts. It doesn't consider the
different editions, so when a new product edition is installed, it generates a shell
script with the same name that overrides the existing one. So it's impossible to
differentiate between the various editions of the same product.
**Overriding example:**
1. Install JetBrains PyCharm Community
2. At this point, JetBrains Toolbox will generate a shell script called `pycharm`
3. Install JetBrains PyCharm Professional
4. JetBrains Toolbox will generate a new script with the same name, `pycharm`
and will override the script generated for the community version
The current method supports only the default generated JetBrains Toolbox shell
scripts.