Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vincaslt/vscode-highlight-matching-tag
Highlights matching opening or closing tag in VSCode
https://github.com/vincaslt/vscode-highlight-matching-tag
closing-tags extension markup vscode
Last synced: 3 months ago
JSON representation
Highlights matching opening or closing tag in VSCode
- Host: GitHub
- URL: https://github.com/vincaslt/vscode-highlight-matching-tag
- Owner: vincaslt
- License: mit
- Created: 2017-04-12T20:44:25.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-11T22:46:55.000Z (over 1 year ago)
- Last Synced: 2024-07-05T13:54:45.195Z (4 months ago)
- Topics: closing-tags, extension, markup, vscode
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=vincaslt.highlight-matching-tag
- Size: 532 KB
- Stars: 152
- Watchers: 5
- Forks: 16
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
If you're serious about your software development career,
There's no better platform to learn programming online than Educative.io.
Their courses are excellent and your subscription supports this plugin.
# VSCode Highlight Matching Tag
_GitHub repository:_
This extension highlights matching opening and/or closing tags. Optionally it also shows path to tag in the status bar.
Even though VSCode has some basic tag matching, it's just that - basic. This extension will try to match tags anywhere: from tag attributes, inside of strings, any files, while also providing extensive styling options to customize how tags are highlighted.
Officially supported markup: **HTML** and **JSX**. Other flavors (XML, Vue, Angular, PHP) should work, but there are no guarantees. Feel free to report the issues on them anyway.
## Features
## Extension Settings
You can override any default [settings](https://code.visualstudio.com/docs/getstarted/settings) with your own values. The plugin supports [workspace settings](https://code.visualstudio.com/docs/editor/multi-root-workspaces) as well as global user settings.
| Variable | Default | Description |
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------------------------------------------------- |
| `highlight-matching-tag.enabled` | `true` | Enables/disables the highlighting and status bar |
| `highlight-matching-tag.showPath` | `true` | Enables/disables showing path to tag in status bar (e.g. `div > p > a`) |
| `highlight-matching-tag.showRuler` | `true` | Enables/disables showing highlighted tag pair in ruler section |
| `highlight-matching-tag.highlightSelfClosing` | `false` | Should self-closing tags be highlighted too (can be useful for multiline self-closing tags) |
| `highlight-matching-tag.highlightFromContent` | `false` | Whether to highlight matching tag from inside the tag content |
| `highlight-matching-tag.highlightFromName` | `true` | Whether to highlight matching tag from the tag name |
| `highlight-matching-tag.highlightFromAttributes` | `true` | Whether to highlight matching tag from the tag attributes |
| `highlight-matching-tag.noDefaultEmptyElements` | `false` | Don't use default HTML empty elements |
| `highlight-matching-tag.customEmptyElements` | `null` | Custom [empty elements](#empty-elements) in addition to the default HTML empty elements |
| `highlight-matching-tag.styles` | `{ opening: { name: { underline: 'yellow' } } }` | Custom styling configuration, see [Styling Options](#styling-options) |
## Styling Options
By default, the tag pair's names are underlined with a yellow line. The setting looks like this:
```json
"highlight-matching-tag.styles": {
"opening": {
"name": {
"underline": "yellow"
}
}
}
```
### Custom styling
Version 0.8.0 of this extension introduces new styling options, but old custom settings can be automatically migrated after update.
Now you can change highlighting styles by providing your own style in User Settings (JSON) as `highlight-matching-tag.styles`. The setting accepts an object with two fields:
- **opening: _Style_** - opening tag styles when highlighting (or both, if closing style is not provided)
- **closing: _Style_** - closing tag styles, optional
- **inner: _Decoration_** - styles of text between opening and closing tags, optional
**_Style_** objects can have any combination of fields defining styles for parts of the tag:
- **name: _Decoration_** - decoration for name part of tag
- **left: _Decoration_** - decoration for left side of tag (character <)
- **right: _Decoration_** - decoration for right side of tag (character >)
- **full: _Decoration_** - decoration for the whole tag (including < and >)
**_Decoration_** objects define tag's style with optional fields:
- **highlight: _string_** - background color (e.g. "#666666")
- **underline: _string_** - underline color
- **surround: _string_** - surrounding border's color
- **custom: _vscode.DecorationRenderOptions_** - custom css rules for styling ([`vscode.DecorationRenderOptions`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#DecorationRenderOptions)). This is basically an object with camelCase CSS rules. It can also accept different styles for light or dark color themes.
Colors used in gutter are the same as the ones used for highlighting/underlining, or yellow by default for custom rules. You can change them by setting: `overviewRulerColor` decoration option to the color that you want.
### Styling Examples
This is the old version's style, with the new styling options:
```json
"highlight-matching-tag.styles": {
"opening": {
"left": {
"custom": {
"borderWidth": "0 0 0 1px",
"borderStyle": "dotted",
"borderColor": "white",
"borderRadius": "5px",
"overviewRulerColor": "white"
}
},
"right": {
"custom": {
"borderWidth": "0 1px 0 0",
"borderStyle": "dotted",
"borderColor": "white",
"borderRadius": "5px",
"overviewRulerColor": "white"
}
}
}
}
```
Result:
---
This is an example showing off different styling options:
```json
"highlight-matching-tag.styles": {
"opening": {
"left": {
"underline": "yellow"
},
"right": {
"surround": "#155FFA"
},
"name": {
"highlight": "rgba(180, 20, 80, 0.3)"
}
},
"closing": {
"full": {
"custom": {
"dark": {
"borderWidth": "0 0 1px 0",
"borderColor": "white",
"borderStyle": "solid",
"borderRadius": "4px",
"right": "10px"
},
"light": {
"borderWidth": "0 0 1px 0",
"borderColor": "brown",
"borderStyle": "solid",
"borderRadius": "4px",
"right": "10px"
}
}
}
}
}
```
Result dark theme:
Result light theme:
## Commands
Used in Command Palette (Win/Linux: `Ctrl`+`Shift`+`P`; Mac: `Cmd`+`Shift`+`P`) by searching for command name. Can also be bound to [Keyboard Shortcuts](https://code.visualstudio.com/docs/getstarted/keybindings).
- Jump to matching tag
- Select contents of matching tag pair
## Empty elements
The plugin is able interpret some unclosed tags as self-closing. By default they correspond with HTML [empty elements](https://developer.mozilla.org/en-US/docs/Glossary/Empty_element) (img, meta, link, etc.).
You can disable or extend them by changing `highlight-matching-tag.noDefaultEmptyElements` and/or `highlight-matching-tag.customEmptyElements` configuration options.
For example, this will additionally assume that `custom` and `no-content` elements are always self-closing and can't have any content:
```
"highlight-matching-tag.highlightSelfClosing": true,
"highlight-matching-tag.customEmptyElements": [
"custom",
"no-content"
]
```
## Contributing
If you want to contribute to the development of the plugin, please consult the [contribution guidelines](https://github.com/vincaslt/vscode-highlight-matching-tag/blob/master/CONTRIBUTING.md).