add fish shell completion (#2363)

master
Hoang Nguyen 2022-03-09 17:33:06 +00:00 committed by GitHub
parent eb2bb7d998
commit 6df2fd694d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 50 additions and 1 deletions

View File

@ -24,7 +24,7 @@ test:
executable:
scripts/pyinstaller.py
completion: data/completion/gallery-dl data/completion/_gallery-dl
completion: data/completion/gallery-dl data/completion/_gallery-dl data/completion/gallery-dl.fish
man: data/man/gallery-dl.1 data/man/gallery-dl.conf.5
@ -46,3 +46,6 @@ data/completion/gallery-dl: gallery_dl/option.py scripts/completion_bash.py
data/completion/_gallery-dl: gallery_dl/option.py scripts/completion_zsh.py
$(PYTHON) scripts/completion_zsh.py
data/completion/gallery-dl.fish: gallery_dl/option.py scripts/completion_fish.py
$(PYTHON) scripts/completion_fish.py

45
scripts/completion_fish.py Executable file
View File

@ -0,0 +1,45 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
"""Generate fish completion script from gallery-dl's argument parser"""
import util
from gallery_dl import option
TEMPLATE = """complete -c gallery-dl -x
%(opts)s
"""
opts = []
for action in option.build_parser()._actions:
if not action.option_strings:
continue
opt = "complete -c gallery-dl"
if action.metavar:
if action.metavar == "FILE":
opt += " -r -F"
elif action.metavar == "PATH":
opt += " -x -a '(__fish_complete_directories)'"
else:
opt += " -x"
for optstr in action.option_strings:
if optstr.startswith("--"):
opt += " -l '" + optstr[2:] + "'"
else:
opt += " -s '" + optstr[1:] + "'"
opt += " -d '" + action.help.replace("'", '"') + "'"
opts.append(opt)
PATH = util.path("data/completion/gallery-dl.fish")
with open(PATH, "w", encoding="utf-8") as file:
file.write(TEMPLATE % {"opts": "\n".join(opts)})

View File

@ -35,6 +35,7 @@ FILES = [
for (path, files) in [
("share/bash-completion/completions", ["data/completion/gallery-dl"]),
("share/zsh/site-functions" , ["data/completion/_gallery-dl"]),
("share/fish/vendor_completions.d" , ["data/completion/gallery-dl.fish"]),
("share/man/man1" , ["data/man/gallery-dl.1"]),
("share/man/man5" , ["data/man/gallery-dl.conf.5"]),
]