Implement pre-commit init-templatedir

This commit is contained in:
Anthony Sottile 2019-07-20 19:10:50 -07:00
parent 3def940574
commit 9a52eefc99
7 changed files with 114 additions and 9 deletions

View file

@ -0,0 +1,21 @@
import logging
import os.path
from pre_commit.commands.install_uninstall import install
from pre_commit.util import cmd_output
logger = logging.getLogger('pre_commit')
def init_templatedir(config_file, store, directory, hook_type):
install(
config_file, store, overwrite=True, hook_type=hook_type,
skip_on_missing_config=True, git_dir=directory,
)
_, out, _ = cmd_output('git', 'config', 'init.templateDir', retcode=None)
dest = os.path.realpath(directory)
if os.path.realpath(out.strip()) != dest:
logger.warning('`init.templateDir` not set to the target directory')
logger.warning(
'maybe `git config --global init.templateDir {}`?'.format(dest),
)

View file

@ -34,8 +34,9 @@ TEMPLATE_START = '# start templated\n'
TEMPLATE_END = '# end templated\n'
def _hook_paths(hook_type):
pth = os.path.join(git.get_git_dir(), 'hooks', hook_type)
def _hook_paths(hook_type, git_dir=None):
git_dir = git_dir if git_dir is not None else git.get_git_dir()
pth = os.path.join(git_dir, 'hooks', hook_type)
return pth, '{}.legacy'.format(pth)
@ -69,7 +70,7 @@ def shebang():
def install(
config_file, store,
overwrite=False, hooks=False, hook_type='pre-commit',
skip_on_missing_conf=False,
skip_on_missing_config=False, git_dir=None,
):
"""Install the pre-commit hooks."""
if cmd_output('git', 'config', 'core.hooksPath', retcode=None)[1].strip():
@ -79,7 +80,7 @@ def install(
)
return 1
hook_path, legacy_path = _hook_paths(hook_type)
hook_path, legacy_path = _hook_paths(hook_type, git_dir=git_dir)
mkdirp(os.path.dirname(hook_path))
@ -100,7 +101,7 @@ def install(
'CONFIG': config_file,
'HOOK_TYPE': hook_type,
'INSTALL_PYTHON': sys.executable,
'SKIP_ON_MISSING_CONFIG': skip_on_missing_conf,
'SKIP_ON_MISSING_CONFIG': skip_on_missing_config,
}
with io.open(hook_path, 'w') as hook_file:

View file

@ -12,6 +12,7 @@ from pre_commit import git
from pre_commit.commands.autoupdate import autoupdate
from pre_commit.commands.clean import clean
from pre_commit.commands.gc import gc
from pre_commit.commands.init_templatedir import init_templatedir
from pre_commit.commands.install_uninstall import install
from pre_commit.commands.install_uninstall import install_hooks
from pre_commit.commands.install_uninstall import uninstall
@ -162,6 +163,20 @@ def main(argv=None):
_add_color_option(gc_parser)
_add_config_option(gc_parser)
init_templatedir_parser = subparsers.add_parser(
'init-templatedir',
help=(
'Install hook script in a directory intended for use with '
'`git config init.templateDir`.'
),
)
_add_color_option(init_templatedir_parser)
_add_config_option(init_templatedir_parser)
init_templatedir_parser.add_argument(
'directory', help='The directory in which to write the hook script.',
)
_add_hook_type_option(init_templatedir_parser)
install_parser = subparsers.add_parser(
'install', help='Install the pre-commit script.',
)
@ -282,7 +297,12 @@ def main(argv=None):
args.config, store,
overwrite=args.overwrite, hooks=args.install_hooks,
hook_type=args.hook_type,
skip_on_missing_conf=args.allow_missing_config,
skip_on_missing_config=args.allow_missing_config,
)
elif args.command == 'init-templatedir':
return init_templatedir(
args.config, store,
args.directory, hook_type=args.hook_type,
)
elif args.command == 'install-hooks':
return install_hooks(args.config, store)