Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/on2-dev/nasc-vscode-mac-touchbar

A customization for your the macbook pro touch bar buttons with features for VSCode.
https://github.com/on2-dev/nasc-vscode-mac-touchbar

functions macbook macbook-pro shortcuts touchbar touchbar-support vscode vscode-extension

Last synced: 3 months ago
JSON representation

A customization for your the macbook pro touch bar buttons with features for VSCode.

Host: GitHub
URL: https://github.com/on2-dev/nasc-vscode-mac-touchbar
Owner: on2-dev
License: mit
Created: 2017-10-29T21:45:19.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2022-09-24T11:26:40.000Z (over 2 years ago)
Last Synced: 2024-08-02T15:51:39.045Z (6 months ago)
Topics: functions, macbook, macbook-pro, shortcuts, touchbar, touchbar-support, vscode, vscode-extension
Language: JavaScript
Size: 323 KB
Stars: 112
Watchers: 7
Forks: 35
Open Issues: 27
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: license

Awesome Lists containing this project

README

# Nasc's Macbook Pro Touch Bar features for VSCode

This adds a few useful features to your Macbook Pro's touch bar while you are working in VSCode.
**Read the notes in the end of this document**

Installation link (if your are not seeing this from inside VSCode): https://marketplace.visualstudio.com/items?itemName=felipe.nasc-touchbar#overview

## Features

This is how your touchbar will look like:

![Touchbar visualization](images/nasc-macbook-pro-vscode-touch-bar.png)

![Touchbar visualization](images/editor-group.png)
![Touchbar visualization](images/functions-group.png)
![Touchbar visualization](images/source-group.png)
![Touchbar visualization](images/cursors-group.png)
![Touchbar visualization](images/tools-groups.png)

The list of features are:

- Go to definition
- Add cursor above
- Add cursor below
- Run command
- Toggle side bar
- Toggle Panel/terminal
- Rename/replace all
- Duplicate lines
- Toggle white space characters
- Peek definition
- Show references
- Settings
- Indent
- Outdent
- Jump to matching bracket
- Block comment
- Comment line
- Select next
- Go to next
- Open Dash / Zeal
- Search Dash / Zeal with current selection

## Settings

You can choose the buttons by setting the following settings.
Please have in mind the limit of 5 active buttons (if you have the OS control strip enabled, 9 buttons if you don't). More than that will break the layout and the buttons will not be visible. It is possible to hide the default VSCode buttons, see **NOTES** at the end of the documentation.

- "nasc-touchbar.goToDefinition": (default _true_) Go to the function or variable definition
- "nasc-touchbar.addCursorAbove": (default _false_) Add a cursor in the line above
- "nasc-touchbar.addCursorBelow": (default _true_) Add a cursor in the line below
- "nasc-touchbar.selectNext": (default _false_) Selects next match
- "nasc-touchbar.toggleSidebar": (default _false_) Toggles the sidebar
- "nasc-touchbar.togglePanel": (default _true_) Toggles the panel in the bottom of the editor
- "nasc-touchbar.showCommands": (default _true_) Shows the _run command_ prompt
- "nasc-touchbar.rename": (default _true_) Rename (replace all) variable or function names
- "nasc-touchbar.copyLineDown": (default _false_) Duplicates the current line (or selected lines)
- "nasc-touchbar.goToNext": (default _false_) Go to next match
- "nasc-touchbar.toggleWhiteSpace": (default _false_) Show or hide white spaces
- "nasc-touchbar.peekDefinition": (default _false_) Peek definition/declaration
- "nasc-touchbar.showReferences": (default _false_) List references who use the current symbol
- "nasc-touchbar.settings": (default _false_) Open user settings
- "nasc-touchbar.indent": (default _false_) Indent text
- "nasc-touchbar.outdent": (default _false_) Outdent text
- "nasc-touchbar.jumpToBracket": (default _false_) Jump to matching bracket
- "nasc-touchbar.blockComment": (default _false_) Toggles block comments ( /* ... */ ) for the current selection
- "nasc-touchbar.commentLine": (default _false_) Toggles line comments ( // ) for the current selection
- "nasc-touchbar.formatDocument": (default _false_) Formats the current document
- "nasc-touchbar.docs": (default _false_) Show documentation for current file in Dash / Zeal. Requires extension _deerawan.vscode-dash_
- "nasc-touchbar.docsSelection": (default _false_) Shows documentation for current selection in Dash / Zeal, depending on the doctype. Requires extension _deerawan.vscode-dash_ If "nasc-touchbar.docs" is enabled, then the docs icon will display when there is no selection, and will swap to this tool once text is selected.
- "nasc-touchbar.enableFuncGroup": (default _false_) Adds a group with the buttons related to _Functions_
- "nasc-touchbar.enableSrcGroup": (default _false_) Adds a group with the buttons related to the _Source code_
- "nasc-touchbar.enableCursorsGroup": (default _false_) Adds a group with the buttons related to your _cursors_
- "nasc-touchbar.enableEditorGroup": (default _false_) Adds a group with the buttons related to _editor's tools_

## Groups

When you enable groups, each group has a bunch of features.
Here they are:

Functions

- Close group
- Peek definition
- Show references
- Rename/replace all
- Jump to matching bracket

Source

- Close group
- Duplicate lines
- Indent
- Outdent
- Block comment

Cursors

- Close group
- Select next
- Go to next
- Add cursor above
- Add cursor bellow

Editor

- Close group
- Run command
- Toggle side bar
- Toggle Pannel/terminal
- Togle white space characters

## Contributing:

Please, refer to the [_CONTRIBUTING.md_](https://github.com/NascHQ/nasc-vscode-mac-touchbar/blob/master/CONTRIBUTING.md) file and help this project grow :)

## NOTES:

Important, if the buttons don't fit in the bar, they will not be shown (this is a current bug in VSCode support for the TouchBar and soon to be fixed).
If the bar disappeared, see the options (ctrl+, or cmd+,), filter by "nasc" and adjust the settings.

Usually, if your are not using the "Strip" group of buttons, you can fit **9** buttons on it. If you have the OS's _Strip_ buttons enabled, you can fit **5** buttons.

If you would like to create more space by removing VSCode's default buttons you can do so with the `keyboard.touchbar.ignored` setting, adding some or all of the following to the ignored list:
- workbench.action.navigateBack
- workbench.action.navigateForward
- workbench.action.debug.start
- workbench.action.debug.run
- workbench.action.debug.restart
- workbench.action.debug.stepOver
- workbench.action.debug.stepInto
- workbench.action.debug.stepOut
- workbench.action.debug.stop
- workbench.action.debug.continue
- workbench.action.debug.pause
See [this pull request](https://github.com/microsoft/vscode/pull/70174) to vscode for more information on the implementation of this customisation. This is not a feature of nasc-vscode-mac-touchbar, but a feature of vscode, and so the above list may change at any time.

## Donate:

Buy us a beer :)

**BTC:** 1GuTME1bGbk7hY7ssrUBh3M1k4AeyVCSjW
**ETH:** 0x49f1612d4a8e9165f2eb94be79af9dbbf3815af5