# Highlight Duplicates

**Highlight duplicated lines.**
This is a [Sublime Text 3](http://www.sublimetext.com/3) (and ST2) plugin.

## Installation

**Using Package Control** ([installation instructions](https://packagecontrol.io/installation))

Press ctrl+shift+p (cmd+shift+p for OSX), then use the 'Package Control: Install Package' command.
Search for 'HighlightDuplicates', and press enter to install.

### Manually

Go to your `Packages` subdirectory under ST3's data directory:

* Windows: `%APPDATA%\Sublime Text 3`
* OS X: `~/Library/Application Support/Sublime Text 3/Packages`
* Linux: `~/.config/sublime-text-3`
* Portable Installation: `Sublime Text 3/Data`

Then clone this repository:

    git clone git://github.com/lordbrom/HighlightDuplicates.git

That's it!

## Commands

### Toggle Highlighting

Using this command will turn the plugin on and off. This allows you to see the highlighted only when you want without having to disable/enable to plugin via the Package Control.

### Select Duplicates

Using this command will select the rows that would be highlighted when Highlight Duplicates is toggled on. The duplicate rows do not need to be highlighted in order for this command to work.

### Remove Duplicates

Using this command will remove all duplicate lines, after the first instance, from the file. This command is similar to the build in "Permute Lines > Unique" function found in the Edit menu, however this will follow the plugin's settings for what is considered a duplicate.

For example...

``` html
1: <someTag></someTag>
2: Content
3: <someTag></someTag>
4:
```

Would result in

``` html
 1: <someTag></someTag>
 2: Content
 3:
```

_Note:_ By default none of these commands have a key binding, and can only be used via the Command Palette. You can set a key binding by adding any of the following lines to the key binding file. (Preferences > Key Bindings)

``` js
{ "keys": ["alt+shift+h"], "command": "toggle_highlight_duplicates" }
{ "keys": ["alt+shift+s"], "command": "toggle_select_duplicates" }
{ "keys": ["alt+shift+r"], "command": "remove_duplicates" }
```

## Options

### Change The Highlighting Color

`highlight_duplicates_color: "invalid"`

The highlighting color can be changed by providing a scope name such
as "invalid", "comment", etc...

If you'd like to use a custom color,
it should be defined as a color scope in your theme file.

### Trim White Space

`trim_white_space: true`

If this setting is true, the leading and trailing white space will be removed before being compared to other lines. This setting also affects which lines are selected when using the 'Select Duplicates' command.

For example, if `"trim_white_space" : true` the following 2 lines will be counted as duplicates.

``` html
1: <someTag></someTag>
2:      <someTag></someTag>
```

However, the following lines would not be counted as duplicates. The reason for this is because there is white space in line 1 that is not leading or trailing, which does not appear in line 2.

``` html
1: <someTag>      </someTag>
2:      <someTag></someTag>
```

### Ignore Case

`ignore_case: false`

If this setting is true, upper and lower case letters will be considered the same. This setting also affects which lines are selected when using the 'Select Duplicates' command.

For example, if `"ignore_case" : true` the following 2 lines will be counted as duplicates.

``` html
1: <SomeTag></sOMeTag>
2: <sometag></someTag>
```

### Min Line Length

`min_line_length: 4`

Lines with fewer characters than specified in this setting, will be ignored for all functions. Setting this to 1 will cause all non empty lines to be possible duplicates.

For example, by default, only lines 7 and 8 will be selected when using the "select duplicate" command. If this setting is set to 2, all the lines except lines 1 and 2 will be selected when using the "select duplicate" command.

``` html
1: 1
2: 1
3: 12
4: 12
5: 123
6: 123
7: 1234
8: 1234
```

### Min Duplicate Count

`min_duplicate_count: 1`

The number of matching lines, beyond the first, that need to be found in order to be counted as duplicates.

For example, setting this option to `2`, will make it so only lines 3-5 are highlighted below.

``` html
1: not this
2: not this
3: this
4: this
5: this
```

### Ignore List

`ignore_list: []`

Lines matching entires in this list, will be ignored for all functions. Leading and trailing white space, as well as letter case, will be ignored when checking lines against the ignore list.

`"ignore_list": ["This line will be ignored"]`

``` html
1: This line will be ignored
2: This line will be ignored
3: This line will not be ignored
4: This line will not be ignored
```

### Use Selection

`use_selection: false`

If set to true, the "Select Duplicate" and "Remove Duplicate" commands will only use lines that have selected content. If nothing is selected or the option is set to false, the entire document will be included.