mirror of
https://github.com/pre-commit/pre-commit.git
synced 2026-01-14 13:00:10 -06:00
124 lines
3.8 KiB
Python
124 lines
3.8 KiB
Python
from __future__ import print_function
|
|
from __future__ import unicode_literals
|
|
|
|
import io
|
|
import logging
|
|
import os.path
|
|
import sys
|
|
|
|
from pre_commit import git
|
|
from pre_commit import output
|
|
from pre_commit.repository import repositories
|
|
from pre_commit.util import cmd_output
|
|
from pre_commit.util import make_executable
|
|
from pre_commit.util import mkdirp
|
|
from pre_commit.util import resource_filename
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
# This is used to identify the hook file we install
|
|
PRIOR_HASHES = (
|
|
'4d9958c90bc262f47553e2c073f14cfe',
|
|
'd8ee923c46731b42cd95cc869add4062',
|
|
'49fd668cb42069aa1b6048464be5d395',
|
|
'79f09a650522a87b0da915d0d983b2de',
|
|
'e358c9dae00eac5d06b38dfdb1e33a8c',
|
|
)
|
|
CURRENT_HASH = '138fd403232d2ddd5efb44317e38bf03'
|
|
TEMPLATE_START = '# start templated\n'
|
|
TEMPLATE_END = '# end templated\n'
|
|
|
|
|
|
def _hook_paths(git_root, hook_type):
|
|
pth = os.path.join(git.get_git_dir(git_root), 'hooks', hook_type)
|
|
return pth, '{}.legacy'.format(pth)
|
|
|
|
|
|
def is_our_script(filename):
|
|
if not os.path.exists(filename):
|
|
return False
|
|
contents = io.open(filename).read()
|
|
return any(h in contents for h in (CURRENT_HASH,) + PRIOR_HASHES)
|
|
|
|
|
|
def install(
|
|
runner, store, overwrite=False, hooks=False, hook_type='pre-commit',
|
|
skip_on_missing_conf=False,
|
|
):
|
|
"""Install the pre-commit hooks."""
|
|
if cmd_output('git', 'config', 'core.hooksPath', retcode=None)[1].strip():
|
|
logger.error(
|
|
'Cowardly refusing to install hooks with `core.hooksPath` set.\n'
|
|
'hint: `git config --unset-all core.hooksPath`',
|
|
)
|
|
return 1
|
|
|
|
hook_path, legacy_path = _hook_paths(runner.git_root, hook_type)
|
|
|
|
mkdirp(os.path.dirname(hook_path))
|
|
|
|
# If we have an existing hook, move it to pre-commit.legacy
|
|
if os.path.lexists(hook_path) and not is_our_script(hook_path):
|
|
os.rename(hook_path, legacy_path)
|
|
|
|
# If we specify overwrite, we simply delete the legacy file
|
|
if overwrite and os.path.exists(legacy_path):
|
|
os.remove(legacy_path)
|
|
elif os.path.exists(legacy_path):
|
|
output.write_line(
|
|
'Running in migration mode with existing hooks at {}\n'
|
|
'Use -f to use only pre-commit.'.format(legacy_path),
|
|
)
|
|
|
|
params = {
|
|
'CONFIG': runner.config_file,
|
|
'HOOK_TYPE': hook_type,
|
|
'INSTALL_PYTHON': sys.executable,
|
|
'SKIP_ON_MISSING_CONFIG': skip_on_missing_conf,
|
|
}
|
|
|
|
with io.open(hook_path, 'w') as hook_file:
|
|
with io.open(resource_filename('hook-tmpl')) as f:
|
|
contents = f.read()
|
|
before, rest = contents.split(TEMPLATE_START)
|
|
to_template, after = rest.split(TEMPLATE_END)
|
|
|
|
hook_file.write(before + TEMPLATE_START)
|
|
for line in to_template.splitlines():
|
|
var = line.split()[0]
|
|
hook_file.write('{} = {!r}\n'.format(var, params[var]))
|
|
hook_file.write(TEMPLATE_END + after)
|
|
make_executable(hook_path)
|
|
|
|
output.write_line('pre-commit installed at {}'.format(hook_path))
|
|
|
|
# If they requested we install all of the hooks, do so.
|
|
if hooks:
|
|
install_hooks(runner, store)
|
|
|
|
return 0
|
|
|
|
|
|
def install_hooks(runner, store):
|
|
for repository in repositories(runner.config, store):
|
|
repository.require_installed()
|
|
|
|
|
|
def uninstall(runner, hook_type='pre-commit'):
|
|
"""Uninstall the pre-commit hooks."""
|
|
hook_path, legacy_path = _hook_paths(runner.git_root, hook_type)
|
|
|
|
# If our file doesn't exist or it isn't ours, gtfo.
|
|
if not os.path.exists(hook_path) or not is_our_script(hook_path):
|
|
return 0
|
|
|
|
os.remove(hook_path)
|
|
output.write_line('{} uninstalled'.format(hook_type))
|
|
|
|
if os.path.exists(legacy_path):
|
|
os.rename(legacy_path, hook_path)
|
|
output.write_line('Restored previous hooks to {}'.format(hook_path))
|
|
|
|
return 0
|