id       = "pycharm"
name     = "PyCharm"
homepage = "https://www.jetbrains.com/pycharm/"
description = "The Python IDE for data science and web development."
icon     = "theSVG:pycharm"
executables   = ["pycharm"]

[dotfiles]

# https://www.jetbrains.com/help/pycharm/directories-used-by-the-ide-to-store-settings-caches-plugins-and-logs.html
# — the configuration directory is
# %APPDATA%\JetBrains\PyCharm<version> on Windows,
# ~/Library/Application Support/JetBrains/PyCharm<version> on macOS and
# ~/.config/JetBrains/PyCharm<version> on Linux: the three spellings of
# [appData]. The version is part of the directory name, hence the glob, which
# a base directory is free to carry and which also picks up the Community
# Edition's PyCharmCE<version> tree. Caches (~/Library/Caches/JetBrains,
# ~/.cache/JetBrains, %LOCALAPPDATA%\JetBrains) and logs (~/Library/Logs) sit
# outside this tree and never come along.
paths = ["[appData]/JetBrains/PyCharm*/"]

# Same page: on Windows and macOS the plugins directory is `plugins` inside the
# configuration directory (on Linux it lives under ~/.local/share and is out of
# this tree already). Downloaded plugin jars are installs, not settings.
exclude = [
  "[appData]/JetBrains/PyCharm*/plugins/",
]

# https://www.jetbrains.com/help/pycharm/reference-ide-settings-password-safe.html
# — passwords go to the native keychain by default, but the "In KeePass" option
# stores them in the database file c.kdbx inside this same configuration
# directory. Whenever it exists it is the credential store, and it sits inside
# a directory `paths` already covers, so a consumer has to let secret win over
# the directory.
secret = ["[appData]/JetBrains/PyCharm*/c.kdbx"]
# JetBrains' bundled Settings Sync plugin already carries these through a
# JetBrains Account.
self_sync = true

# No machine_lines: options/, keymaps/, colors/ and codestyles/ hold the
# preferences a developer wants on every machine, and picking machine-local
# keys out of the IDE's XML would be guesswork.

[commands]
format = 1
label = "Open in PyCharm"
description = "Open a project or file in PyCharm. The diff, merge, format and inspect subcommands are left out."
quality = "ai-draft"
base = "fig:pycharm"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/pycharm.ts"
license = "MIT"

[[commands.field]]
id = "paths"
label = "Project or files"
type = "path"
position = 0
multiple = true
path = { kind = "any", role = "input", must_exist = true }
sources = ["fig"]

[[commands.field]]
id = "wait"
label = "Wait until closed"
type = "boolean"
option = ["--wait"]
sources = ["fig"]

[[commands.field]]
id = "nosplash"
label = "Hide splash screen"
type = "boolean"
option = ["nosplash"]
sources = ["fig"]

[[commands.field]]
id = "dont_reopen"
label = "Do not reopen projects"
type = "boolean"
option = ["dontReopenProjects"]
sources = ["fig"]

[[commands.field]]
id = "disable_plugins"
label = "Disable non-bundled plugins"
type = "boolean"
option = ["disableNonBundledPlugins"]
sources = ["fig"]

[[commands.task]]
id = "open"
label = "Open"
fields = ["paths", "wait"]
required = ["paths"]

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["paths", "wait", "nosplash", "dont_reopen", "disable_plugins"]