forked from platformio/platformio-core
af21c50aec
the output of `bash --version` is different when the system is configured for e.g. de_DE locale. For german locale the it's `GNU bash, Version 5.0…` with an uppercase 'V'. This makes the bash completion setup fail with the error `Error: The minimal supported Bash version is 4.4`. To fix this, the version match regex now uses the `IGNORECASE` flag.
100 lines
3.2 KiB
Python
100 lines
3.2 KiB
Python
# Copyright (c) 2014-present PlatformIO <contact@platformio.org>
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import os
|
|
import re
|
|
import subprocess
|
|
from enum import Enum
|
|
|
|
import click
|
|
|
|
from platformio.compat import IS_MACOS
|
|
|
|
|
|
class ShellType(Enum):
|
|
FISH = "fish"
|
|
ZSH = "zsh"
|
|
BASH = "bash"
|
|
|
|
|
|
def get_bash_version():
|
|
result = subprocess.run(["bash", "--version"], capture_output=True, check=True)
|
|
match = re.search(r"version\s+(\d+)\.(\d+)", result.stdout.decode(), re.IGNORECASE)
|
|
if match:
|
|
return (int(match.group(1)), int(match.group(2)))
|
|
return (0, 0)
|
|
|
|
|
|
def get_completion_install_path(shell):
|
|
home_dir = os.path.expanduser("~")
|
|
prog_name = click.get_current_context().find_root().info_name
|
|
if shell == ShellType.FISH:
|
|
return os.path.join(
|
|
home_dir, ".config", "fish", "completions", "%s.fish" % prog_name
|
|
)
|
|
if shell == ShellType.ZSH:
|
|
return os.path.join(home_dir, ".zshrc")
|
|
if shell == ShellType.BASH:
|
|
return os.path.join(home_dir, ".bash_completion")
|
|
raise click.ClickException("%s is not supported." % shell)
|
|
|
|
|
|
def get_completion_code(shell):
|
|
if shell == ShellType.FISH:
|
|
return "eval (env _PIO_COMPLETE=fish_source pio)"
|
|
if shell == ShellType.ZSH:
|
|
code = "autoload -Uz compinit\ncompinit\n" if IS_MACOS else ""
|
|
return code + 'eval "$(_PIO_COMPLETE=zsh_source pio)"'
|
|
if shell == ShellType.BASH:
|
|
return 'eval "$(_PIO_COMPLETE=bash_source pio)"'
|
|
raise click.ClickException("%s is not supported." % shell)
|
|
|
|
|
|
def is_completion_code_installed(shell, path):
|
|
if shell == ShellType.FISH or not os.path.exists(path):
|
|
return False
|
|
with open(path, encoding="utf8") as fp:
|
|
return get_completion_code(shell) in fp.read()
|
|
|
|
|
|
def install_completion_code(shell, path):
|
|
if shell == ShellType.BASH and get_bash_version() < (4, 4):
|
|
raise click.ClickException("The minimal supported Bash version is 4.4")
|
|
if is_completion_code_installed(shell, path):
|
|
return None
|
|
append = shell != ShellType.FISH
|
|
with open(path, mode="a" if append else "w", encoding="utf8") as fp:
|
|
if append:
|
|
fp.write("\n\n# Begin: PlatformIO Core completion support\n")
|
|
fp.write(get_completion_code(shell))
|
|
if append:
|
|
fp.write("\n# End: PlatformIO Core completion support\n\n")
|
|
return True
|
|
|
|
|
|
def uninstall_completion_code(shell, path):
|
|
if not os.path.exists(path):
|
|
return True
|
|
if shell == ShellType.FISH:
|
|
os.remove(path)
|
|
return True
|
|
|
|
with open(path, "r+", encoding="utf8") as fp:
|
|
contents = fp.read()
|
|
fp.seek(0)
|
|
fp.truncate()
|
|
fp.write(contents.replace(get_completion_code(shell), ""))
|
|
|
|
return True
|