|
Size: 1683
Comment: Updated to match recent code changes
|
Size: 2482
Comment: Move all external links to same place.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 5: | Line 5: |
| Line 12: | Line 11: |
| '''This extension is/is not distributed with Mercurial.''' | '''This extension is not distributed with Mercurial.''' |
| Line 18: | Line 17: |
| * If you like it, drop a note here: https://www.ohloh.net/p/ml-hgext | |
| Line 21: | Line 21: |
| === Configuration === | By avoiding commits with tab characters or trailing whitespace on lines, there is less noise in the diffs and the actual code changes are clearer. The extensions adds a command {{{checkfiles}}} which reports issues in the working directory. Using --fixup will instead fix these files by replacing tabs with spaces and There is also two hooks: * {{{check_hook}}} - checks and blocks commits with issues, useable in {{{pretxncommit}}} or {{{pretxnchangegroup}}} * {{{fixup_hook}}} - automatically fixes issues in files on commit, useable in {{{pre-commit}}} == Configuration == |
| Line 28: | Line 36: |
| [hooks] pretxnchangegroup.checkfiles = python:/path/to/checkfiles.py:check_hook pretxncommit.checkfiles = python:/path/to/checkfiles.py:check_hook pre-commit.checkfiles = python:/path/to/checkfiles.py:fixup_hook |
|
| Line 32: | Line 45: |
| autofixup = True # enable precommit hook to cleanup files automatically commitcheck = True # enable pretxncommit hook to check incoming commits |
|
| Line 47: | Line 58: |
| If problems are found, the command returns 1, otherwise 0. | If problems are found, the command returns 1, otherwise 0. If --fixup is given, the return value is always 0 (unless an error occurs). |
| Line 51: | Line 63: |
| -f --fixup fix files by replacing tabs and removing trailing whitespace -t --tabsize set the tab length (default: 4) |
-f --fixup fix files by replacing tabs and removing trailing whitespace -t --tabsize VALUE set the tab length (default: 4) |
CheckFilesExtension
This extension provides two hooks and a command to prevent committing tabs and trailing whitespaces. The hooks must be explicitly enabled in the hgrc/mercurial.ini file.
Contents
1. Status
This extension is not distributed with Mercurial.
Author: MarcusLindblom
Download site: https://bitbucket.org/marcusl/ml-hgext/src/tip/checkfiles.py
Issue tracker: https://bitbucket.org/marcusl/ml-hgext/issues
If you like it, drop a note here: https://www.ohloh.net/p/ml-hgext
2. Overview
By avoiding commits with tab characters or trailing whitespace on lines, there is less noise in the diffs and the actual code changes are clearer.
The extensions adds a command checkfiles which reports issues in the working directory. Using --fixup will instead fix these files by replacing tabs with spaces and
There is also two hooks:
check_hook - checks and blocks commits with issues, useable in pretxncommit or pretxnchangegroup
fixup_hook - automatically fixes issues in files on commit, useable in pre-commit
3. Configuration
Configure your .hgrc to enable the extension by adding following lines:
[extensions] checkfiles = /path/to/checkfiles.py [hooks] pretxnchangegroup.checkfiles = python:/path/to/checkfiles.py:check_hook pretxncommit.checkfiles = python:/path/to/checkfiles.py:check_hook pre-commit.checkfiles = python:/path/to/checkfiles.py:fixup_hook [checkfiles] checked_exts = .c .h .cpp .xml .cs .html .js .css .txt .py .nsi .java .aspx .asp .bat .cmd .glsl ignored_files = foo/contains_tabs.txt bar/contains_trailing_ws.txt tab_size = 4
3.1. Usage
hg checkfiles [options]
checks changed files in the working directory for tabs or trailing whitespace
- --verbose shows the location of offending characters in each line
- --quiet hides filenames and only reports summary information
- --debug shows settings and details about each file considered for checking
If problems are found, the command returns 1, otherwise 0.
If --fixup is given, the return value is always 0 (unless an error occurs).
options:
-f --fixup fix files by replacing tabs and removing trailing whitespace
-t --tabsize VALUE set the tab length (default: 4)
use "hg -v help checkfiles" to show global options