Cisco device configuration Syntax Highlighting for Visual Studio Code.
This project is in the development stages.
There's a possibility that definitions will change in the future.
This extension provides some awesome features for Cisco config text, including:
- Syntax highlighting
- Config outline (Experimental)
Syntaxes often used in Config are supported.
- IOS
The following platforms provide similar highlighting for syntaxes that overlap with IOS.
In the future, I would like to support the following platforms.
- NXOS
- IOS-XR
- IOS-XE
- ASA
Note: Screenshots are using a custom theme.
The color of syntax highlighting depends on the theme you have enabled.
All highlighting settings are not enabled in VSCode's default theme. For a better experience, I recommend using a custom theme such as MaterialTheme.
If the colors are not defined in the currently activated theme, or if you want to customize the colors and style to your liking, you will need to edit the settings.json.
Open the settings and add option strings to JSON.
(You can open the settings.json file by typing Preferences: Open Settings (JSON) in the command palette.)
For more information on how to customize the settings.json file, please refer to the following URL.
Visual Studio Code Documentaion - Color Themes
"editor.tokenColorCustomizations": {
"textMateRules": [
{
"scope": "entity.name.class.interface.ethernet.cisco",
"settings": {
"foreground": "#328f16",
"fontStyle": "italic"
}
},
{
"scope": [
"keyword.other.address",
"constant.numeric"
],
"settings": {
"foreground": "#cc0ca2",
"fontStyle": "underline"
}
}
]
}punctuation.config-param.first.cisco
comment.line.config.cisco
string.other.remark.cisco
string.other.description.cisco
entity.name.tag.config-string.domain-name.cisco
entity.name.tag.config-string.hostname.cisco
entity.name.tag.config-string.username.cisco
entity.name.tag.config-string.logging-system-message.cisco
string.other.password.cisco
string.other.secret.cisco
comment.block.banner.cisco
constant.numeric.hex.cisco
constant.numeric.integer.cisco
keyword.other.config-keyword.vlan.cisco
keyword.other.config-keyword.switchport-mode.cisco
keyword.other.config-keyword.add-remove.cisco
keyword.other.config-keyword.allowed-native.cisco
keyword.other.config-keyword.any-all.cisco
keyword.other.config-keyword.permit-deny.cisco
keyword.other.config-keyword.status.cisco
keyword.other.config-keyword.match.cisco
keyword.other.config-keyword.in-out.cisco
keyword.other.config-keyword.input-output.cisco
keyword.other.config-keyword.inside-outside.cisco
keyword.other.config-keyword.shutdown.cisco
entity.name.class.interface.ethernet.cisco
entity.name.class.interface.wireless.cisco
entity.name.class.interface.loopback.cisco
entity.name.class.interface.portchannel.cisco
entity.name.class.interface.tunnel.cisco
entity.name.class.interface.vlan.cisco
entity.name.class.interface.null.cisco
entity.name.class.interface.serial.cisco
entity.name.class.interface.cellular.cisco
entity.name.class.interface.virtual-template.cisco
entity.name.class.interface.dialer.cisco
entity.name.class.interface.async.cisco
entity.name.class.interface.bri.cisco
entity.name.class.interface.bvi.cisco
entity.name.class.interface.management.cisco
keyword.other.address.ipv4.cidr.cisco
keyword.other.address.ipv4.full.cisco
keyword.other.address.ipv6.condensed.cisco
keyword.other.address.ipv6.full.cisco
keyword.other.address.mac.cisco
meta.function-call.command_hostname.user-mode.cisco
meta.function-call.command_hostname.privileged-mode.cisco
entity.name.class.vrf.declaration.cisco
entity.other.vrf.forwarding.cisco
entity.other.vrf.definition.cisco
entity.name.tag.vrf.vrf-name.cisco
entity.name.tag.bgp.neighbor-peer-group.name.cisco
entity.name.tag.bgp.peer-session.name.cisco
entity.name.tag.bgp.peer-policy.name.cisco
entity.name.tag.bgp.peer-group.name.cisco
entity.name.tag.group.class.name.cisco
entity.name.tag.group.service-policy.name.cisco
entity.name.tag.group.policy-map.name.cisco
entity.name.tag.group.class-map.name.cisco
entity.name.tag.group.route-map.name.cisco
entity.name.tag.group.prefix-list.name.cisco
keyword.other.group.object-group.type.cisco
entity.name.tag.group.object-group.name.cisco
keyword.other.acl.access-list.type.cisco
entity.name.tag.acl.access-list.name.cisco
entity.name.tag.acl.access-group.name.cisco
meta.function-call.command-disable.unused.cisco
meta.function-call.command-disable.default.cisco
- Show symbols in outline panel
- Multilingual support (settings page)
Open the settings and enter a keyword in the search box. Select the check box to enable.
@ext:Y-Ysss.cisco-config-highlight showSymbolsInOutlinePanel
- Command
hostname#{command name}hostname>{command name}
- Virtual Routing and Forwarding(VRF)
ip vrf {vrf-name}
- Border Gateway Protocol(BGP)
router bgp {autonomous-system-number}address-family ipv4 {unicast|multicast|vrf vrf-name }
- Group
class-map {match-any|match-all} namepolicy-map {name}
- Interface
interface {type, slot, port, etc...}- e.g.
interface GigabitEthernet0/0
- Sub Interface
interface {type, slot, port, etc...}.{number}
Currently, only the settings page is available.
Following supported languages:
- English
- Japanese
If you want to enable highlighting in large files. Change the following settings to False.
"editor.largeFileOptimizations": false
However VSCode disable feature on large files for performance reasons, and forcing VSCode to syntax highlight large files may result in poor editor performance.
Visual Studio Marketplace - Cisco Config Highlight
I recommend the following extensions to more beautiful look.
If you have any requests or issues, please start an Issue or PullRequest on GitHub.
GitHub - Y-Ysss/vscode-cisco-config-highlight
MIT License Copyright (c) 2021 Y-Ysss