|
Size: 1670
Comment: update to description
|
Size: 2046
Comment: simplified description of values for "action" settings
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| This Mercurial extension will remove the BOM from all Unicode files. Resulting file will be UTF-8 and without pesky BOM bytes. |
This Mercurial extension will remove the BOM from all Unicode files. Resulting file will be UTF-8 and without pesky BOM bytes. |
| Line 21: | Line 20: |
| This extension will modify all Unicode files with BOM (byte order mark) and convert them to BOM-less UTF-8. This comes especially handy when dealing with Microsoft's Visual Studio that is really UTF-8 BOM happy. |
This extension will modify all Unicode files with BOM (byte order mark) and convert them to BOM-less UTF-8. This comes especially handy when dealing with Microsoft's Visual Studio that is really UTF-8 BOM happy. |
| Line 25: | Line 22: |
| Extensions adds two commands (`killbom`, `checkbom`) and hooks into the commit process. |
Extensions adds two commands (`killbom`, `checkbom`) and hooks into the commit process. |
| Line 34: | Line 30: |
| [extensions] killbom = /path/to/killbom.py [killbom] extensions = utf-8 utf-16le utf-16be utf-32le utf-32be maxsize = 1024 |
[extensions] killbom = /path/to/killbom.py [killbom] action = modify extensions = utf-8 utf-16le utf-16be utf-32le utf-32be maxsize = 1024 |
| Line 41: | Line 38: |
* `extensions` is a list of all Unicode encodings that will be recognized. * `maxsize` is maximum file size that will be processed (in kilobytes). * `action` can be either `modify` (default), `verify`, or `ignore`: * `modify` - files will be adjusted before the commit * `verify` - commit will be aborted if there are Unicode files with BOM but files won't be modified * `ignore` - no action will be taken |
|
| Line 45: | Line 50: |
| Using `killbom` command will remove Unicode COM from all modified and newly added files: |
Using `killbom` command will remove Unicode BOM from all modified and newly added files: |
| Line 49: | Line 53: |
| hg killbom [options] options: -8 --utf8only removes only UTF-8 BOM signature |
hg killbom [options] options: -8 --utf8only removes only UTF-8 BOM signature |
| Line 59: | Line 63: |
| hg checkbom [options] options: -8 --utf8only checks for only UTF-8 BOM signature |
hg checkbom [options] options: -8 --utf8only checks for only UTF-8 BOM signature |
| Line 66: | Line 70: |
| In addition there are three hooks. On `pretxncommit` and `pretxnchangegroup` extension will verify whether all Unicode files are BOM-free and it will stop commit if they are not. On `precommit` extension will modify files and remove BOM. |
In addition there are three hooks. On `pretxncommit` and `pretxnchangegroup` extension will verify whether all Unicode files are BOM-free and it will stop commit if they are not. On `precommit` extension will modify files and remove BOM. |
KillBom
This Mercurial extension will remove the BOM from all Unicode files. Resulting file will be UTF-8 and without pesky BOM bytes.
Status
This extension is not distributed with Mercurial.
Author: Josip Medved
Repository: https://bitbucket.org/jmedved/hg-killbom
Overview
This extension will modify all Unicode files with BOM (byte order mark) and convert them to BOM-less UTF-8. This comes especially handy when dealing with Microsoft's Visual Studio that is really UTF-8 BOM happy.
Extensions adds two commands (killbom, checkbom) and hooks into the commit process.
Configuration
To use it just add following in the hgrc or global Mercurial settings file:
[extensions] killbom = /path/to/killbom.py [killbom] action = modify extensions = utf-8 utf-16le utf-16be utf-32le utf-32be maxsize = 1024
extensions is a list of all Unicode encodings that will be recognized.
maxsize is maximum file size that will be processed (in kilobytes).
action can be either modify (default), verify, or ignore:
modify - files will be adjusted before the commit
verify - commit will be aborted if there are Unicode files with BOM but files won't be modified
ignore - no action will be taken
Usage
Using killbom command will remove Unicode BOM from all modified and newly added files:
hg killbom [options] options: -8 --utf8only removes only UTF-8 BOM signature
To just verify whether all files are BOM free, you would use checkbom command:
hg checkbom [options] options: -8 --utf8only checks for only UTF-8 BOM signature
In addition there are three hooks. On pretxncommit and pretxnchangegroup extension will verify whether all Unicode files are BOM-free and it will stop commit if they are not. On precommit extension will modify files and remove BOM.