| hg-reviewers |
This allows distributing opt-in fixer tool configurations in .hgrc
files. This may be useful for adding default configs in core, or for
orgranizations that want to provide configs to their users.
Tools are still enabled by default because it would be confusing to add a
config and find that it has no effect until you add enabled=true.
| Lint Skipped |
| Unit Tests Skipped |
| Path | Packages | |||
|---|---|---|---|---|
| M | hgext/fix.py (5 lines) | |||
| M | tests/test-fix.t (16 lines) |
| Commit | Parents | Author | Summary | Date |
|---|---|---|---|---|
| ca6fcee4ee2a | c348d829d23a | Danny Hooper | Oct 5 2019, 10:10 AM |
| # Register the suboptions allowed for each configured fixer, and default values. | # Register the suboptions allowed for each configured fixer, and default values. | ||||
| FIXER_ATTRS = { | FIXER_ATTRS = { | ||||
| 'command': None, | 'command': None, | ||||
| 'linerange': None, | 'linerange': None, | ||||
| 'pattern': None, | 'pattern': None, | ||||
| 'priority': 0, | 'priority': 0, | ||||
| 'metadata': 'false', | 'metadata': 'false', | ||||
| 'skipclean': 'true', | 'skipclean': 'true', | ||||
| 'enabled': 'true', | |||||
| } | } | ||||
| for key, default in FIXER_ATTRS.items(): | for key, default in FIXER_ATTRS.items(): | ||||
| configitem('fix', '.*(:%s)?' % key, default=default, generic=True) | configitem('fix', '.*(:%s)?' % key, default=default, generic=True) | ||||
| # A good default size allows most source code files to be fixed, but avoids | # A good default size allows most source code files to be fixed, but avoids | ||||
| # letting fixer tools choke on huge inputs, which could be surprising to the | # letting fixer tools choke on huge inputs, which could be surprising to the | ||||
| # user. | # user. | ||||
| fixers[name] = Fixer() | fixers[name] = Fixer() | ||||
| attrs = ui.configsuboptions('fix', name)[1] | attrs = ui.configsuboptions('fix', name)[1] | ||||
| for key, default in FIXER_ATTRS.items(): | for key, default in FIXER_ATTRS.items(): | ||||
| setattr(fixers[name], pycompat.sysstr('_' + key), | setattr(fixers[name], pycompat.sysstr('_' + key), | ||||
| attrs.get(key, default)) | attrs.get(key, default)) | ||||
| fixers[name]._priority = int(fixers[name]._priority) | fixers[name]._priority = int(fixers[name]._priority) | ||||
| fixers[name]._metadata = stringutil.parsebool(fixers[name]._metadata) | fixers[name]._metadata = stringutil.parsebool(fixers[name]._metadata) | ||||
| fixers[name]._skipclean = stringutil.parsebool(fixers[name]._skipclean) | fixers[name]._skipclean = stringutil.parsebool(fixers[name]._skipclean) | ||||
| fixers[name]._enabled = stringutil.parsebool(fixers[name]._enabled) | |||||
| # Don't use a fixer if it has no pattern configured. It would be | # Don't use a fixer if it has no pattern configured. It would be | ||||
| # dangerous to let it affect all files. It would be pointless to let it | # dangerous to let it affect all files. It would be pointless to let it | ||||
| # affect no files. There is no reasonable subset of files to use as the | # affect no files. There is no reasonable subset of files to use as the | ||||
| # default. | # default. | ||||
| if fixers[name]._pattern is None: | if fixers[name]._pattern is None: | ||||
| ui.warn( | ui.warn( | ||||
| _('fixer tool has no pattern configuration: %s\n') % (name,)) | _('fixer tool has no pattern configuration: %s\n') % (name,)) | ||||
| del fixers[name] | del fixers[name] | ||||
| elif not fixers[name]._enabled: | |||||
| ui.debug('ignoring disabled fixer tool: %s\n' % (name,)) | |||||
| del fixers[name] | |||||
| return collections.OrderedDict( | return collections.OrderedDict( | ||||
| sorted(fixers.items(), key=lambda item: item[1]._priority, | sorted(fixers.items(), key=lambda item: item[1]._priority, | ||||
| reverse=True)) | reverse=True)) | ||||
| def fixernames(ui): | def fixernames(ui): | ||||
| """Returns the names of [fix] config options that have suboptions""" | """Returns the names of [fix] config options that have suboptions""" | ||||
| names = set() | names = set() | ||||
| for k, v in ui.configitems('fix'): | for k, v in ui.configitems('fix'): | ||||
| $ hg add -q | $ hg add -q | ||||
| $ hg fix --debug --working-dir --config "fix.nopattern:command=echo fixed" | $ hg fix --debug --working-dir --config "fix.nopattern:command=echo fixed" | ||||
| fixer tool has no pattern configuration: nopattern | fixer tool has no pattern configuration: nopattern | ||||
| $ cat foo bar | $ cat foo bar | ||||
| foobar (no-eol) | foobar (no-eol) | ||||
| $ cd .. | $ cd .. | ||||
| Tools can be disabled. Disabled tools do nothing but print a debug message. | |||||
| $ hg init disabled | |||||
| $ cd disabled | |||||
| $ printf "foo\n" > foo | |||||
| $ hg add -q | |||||
| $ hg fix --debug --working-dir --config "fix.disabled:command=echo fixed" \ | |||||
| > --config "fix.disabled:pattern=foo" \ | |||||
| > --config "fix.disabled:enabled=false" | |||||
| ignoring disabled fixer tool: disabled | |||||
| $ cat foo | |||||
| foo | |||||
| $ cd .. | |||||
| Test that we can configure a fixer to affect all files regardless of the cwd. | Test that we can configure a fixer to affect all files regardless of the cwd. | ||||
| The way we invoke matching must not prohibit this. | The way we invoke matching must not prohibit this. | ||||
| $ hg init affectallfiles | $ hg init affectallfiles | ||||
| $ cd affectallfiles | $ cd affectallfiles | ||||
| $ mkdir foo bar | $ mkdir foo bar | ||||
| $ printf "foo" > foo/file | $ printf "foo" > foo/file | ||||