alefragnani / vscode-bookmarks Goto Github PK

View Code? Open in Web Editor NEW

1.6K 19.0 154.0 11.95 MB

Bookmarks Extension for Visual Studio Code

Home Page: https://marketplace.visualstudio.com/items?itemName=alefragnani.Bookmarks

License: GNU General Public License v3.0

TypeScript 96.45% JavaScript 3.55%

bookmark navigation visual-studio-code vscode vscode-extension

vscode-bookmarks's Introduction

What's new in Bookmarks 13.5

Published to Open VSX
Adds Getting Started / Walkthrough
Adds Side Bar badge
Adds Toggle bookmark via mouse click
Adds Icon customization

Support

Bookmarks is an extension created for Visual Studio Code. If you find it useful, please consider supporting it.

Bookmarks

It helps you to navigate in your code, moving between important positions easily and quickly. No more need to search for code. It also supports a set of selection commands, which allows you to select bookmarked lines and regions between bookmarked lines. It's really useful for log file analysis.

Here are some of the features that Bookmarks provides:

Mark/unmark positions in your code
Mark positions in your code and give it name
Jump forward and backward between bookmarks
Icons in gutter and overview ruler
See a list of all Bookmarks in one file and project
Select lines and regions with bookmarks
A dedicated Side Bar

Features

Available commands

Bookmarks: Toggle Mark/unmark positions with bookmarks
Bookmarks: Toggle Labeled Mark labeled bookmarks
Bookmarks: Jump to Next Move the cursor forward, to the bookmark below
Bookmarks: Jump to Previous Move the cursor backward, to the bookmark above
Bookmarks: List List all bookmarks in the current file
Bookmarks: List from All Files List all bookmarks from all files
Bookmarks: Clear remove all bookmarks in the current file
Bookmarks: Clear from All Files remove all bookmarks from all files
Bookmarks (Selection): Select Lines Select all lines that contains bookmarks
Bookmarks (Selection): Expand Selection to Next Expand the selected text to the next bookmark
Bookmarks (Selection): Expand Selection to Previous Expand the selected text to the previous bookmark
Bookmarks (Selection): Shrink Selection Shrink the select text to the Previous/Next bookmark

Manage your bookmarks

Toggle / Toggle Labeled

You can easily Mark/Unmark bookmarks on any position. You can even define Labels for each bookmark.

Navigation

Jump to Next / Previous

Quicky move between bookmarks backward and forward, even if located outside the active file.

List / List from All Files

List all bookmarks from the current file/project and easily navigate to any of them. It shows a line preview and temporarily scroll to its position.

Bookmarks from the active file only shows the line number and its contents
Bookmarks from other files in the project also shows the relative path

Improved Multi-root support

When you work with multi-root workspaces, the extension can manage the bookmarks individually for each folder.

Simply define saveBookmarksInProject as true on your User Settings or in the Workspace Settings, and when you run the Bookmarks: List from All Files command, you will be able to select from which folder the bookmarks will be shown.

Remote Development support

The extension now fully supports Remote Development scenarios.

It means that when you connect to a remote location, like a Docker Container, SSH or WSL, the extension will be available, ready to be used.

You don't need to install the extension on the remote anymore.

Better yet, if you use bookmarks.saveBookmarksInProject setting defined as true, the bookmarks saved locally will be available remotely, and you will be able to navigate and update the bookmarks. Just like it was a resource from folder you opened remotely.

Selection

You can use Bookmarks to easily select lines or text blocks. Simply toggle bookmarks in any position of interest and use some of the Selection commands available.

Select Lines

Select all bookmarked lines. Specially useful while working with log files.

Expand Selection to the Next/Previous Bookmark or Shrink the Selection

Manipulate the selection of lines between bookmarks, up and down.

Available Settings

Allow navigation through all files that contains bookmarks (true by default)

    "bookmarks.navigateThroughAllFiles": false

Allow navigation to wrap around at the first and last bookmarks in scope (current file or all files) (true by default)

    "bookmarks.wrapNavigation": true

Bookmarks are always saved between sessions, and you can decide if it should be saved in the Project, so you can add it to your Git/SVN repo and have it in all your machines (false by default)

    "bookmarks.saveBookmarksInProject": true

Path to another image to be shown as Bookmark (16x16 px)

    "bookmarks.gutterIconPath": "c:\\temp\\othericon.png"

Deprecated in 13.3: Use bookmarks.gutterIconFillColor and bookmarks.gutterIconBorderColor instead

Specifies the fill color of the bookmark icon

    "bookmarks.gutterIconFillColor"

Specifies the border color of the bookmark icon

    "bookmarks.gutterIconBorderColor"

Choose the background color to use on a bookmarked line

    "bookmarks.backgroundLineColor"

Deprecated in 10.7: Use workbench.colorCustomizations instead. More info in Available Colors

Allow bookmarks commands, (Toggle, Jump to Next/Previous), to be displayed on the editor contex menu (true by default)

    "bookmarks.showCommandsInContextMenu": true

Experimental. Enables the new Sticky engine with support for Formatters, improved source change detections and undo operations (true by default)

    "bookmarks.experimental.enableNewStickyEngine": false

"Specifies whether bookmarks on deleted line should be kept on file, moving it down to the next line, instead of deleting it with the line where it was toggled." (false by default)

    "bookmarks.keepBookmarksOnLineDelete": true

Limitation: It does not support Undo operations. It means that, once you delete a line and the bookmark is moved to the next available line, the Undo operation won't move the bookmark back to the previous line. The next line is now the new location of the bookmark.

Use a workaround for formatters, like Prettier, which does not notify on document changes and messes Bookmark's Sticky behavior (false by default)

    "bookmarks.useWorkaroundForFormatters": true

This workaround can be turned off if you are using the new Sticky Engine (setting above)

Choose if the Side Bar should start expanded (false by default)

    "bookmarks.sideBar.expanded": true

Controls the count badge on the Bookmark icon on the Activity Bar (all by default)
- all: Show the sum of bookmarks from all files
- files: Show the sum of files that contains some bookmarks
- off: Disable the Bookmarks count badge

    "bookmarks.sideBar.countBadge": "files"

Choose how multi cursor handles already bookmarked lines (allLinesAtOnce by default)
- allLinesAtOnce: Creates bookmarks in all selected lines at once, if at least one of the lines don't have a bookmark
- eachLineIndependently: Literally toggles a bookmark in each line, instead of making all lines equal

    "bookmarks.multicursor.toggleMode": "eachLineIndependently"

Choose how labels are suggested when creating bookmarks (dontUse by default)
- dontUse: Don't use the selection (original behavior)
- useWhenSelected: Use the selected text (if available) directly, no confirmation required
- suggestWhenSelected: Suggests the selected text (if available). You still need to confirm.
- suggestWhenSelectedOrLineWhenNoSelected: Suggests the selected text (if available) or the entire line (when has no selection). You still need to confirm

    "bookmarks.label.suggestion": "useWhenSelected"

Choose the location where the bookmarked line will be revealed (center by default)
- top: Reveals the bookmarked line at the top of the editor
- center: Reveals the bookmarked line in the center of the editor

    "bookmarks.revealPosition": "center"

Available Colors

Choose the background color to use on a bookmarked line

    "workbench.colorCustomizations": {
      "bookmarks.lineBackground": "#157EFB22"  
    }

Choose the border color to use on a bookmarked line

    "workbench.colorCustomizations": {
      "bookmarks.lineBorder": "#FF0000"  
    }

Choose marker color to use in the overview ruler

    "workbench.colorCustomizations": {
      "bookmarks.overviewRuler": "#157EFB88"  
    }

Side Bar

The Bookmarks extension has its own Side Bar, with a variety of commands to improve you productivity.

Single Folder	Multi-root Workspace

Project and Session Based

The bookmarks are saved per session for the project that you are using. You don't have to worry about closing files in Working Files. When you reopen the file, the bookmarks are restored.

It also works even if you only preview a file (simple click in TreeView). You can put bookmarks in any file and when you preview it again, the bookmarks will be there.

License

GPL-3.0 © Alessandro Fragnani

vscode-bookmarks's People

Contributors

Stargazers

Watchers

Forkers

wpostma dotnetcarpenter phaufe gcastl tlemo kenhowardpdx malkomalko purplestone muellerkyle jasongin vbfox jaywick xuansang disco0 lega911 alianzhen tsoliangwu0130 parkourkarthik dotwoo light9gmailcom marcellourbani mitchellsion pf-fornof no-stack-dub-sack kubawolanin marcushawley walonli zanderzhang joelseubring shirow-ozawa devotionzhu rudrasiva86 gerhardboer dmx-patrick goodpaas shepardo dev41989 myhololens haigeno1 chestozo leonshi2019 sthagen davelnewton kartikm123 reciosonny kalbdela adictya mcfcarson ravikannankr yulongsun ahmedmaouloud-aboubacar javalight adchoudhary wjs4572 jasonwilliams iikagenlabo fayazmiraz jvaelen hidetaka-abe chekt ryan311 bogdan-lyashenko lepinekong sandiklibilgisayarprogramlama mltony chenjuneking drizbit zxytry derekpock kmesserig pkief admariner thainxo mjbvz guillerpsanchez akclown fade2gray bfranklyn jan25 vijaykm01 ayangliayangli 7storm7 hercules261188 benjaminhdavis sariohara bepetersn keizure udplus imyuanx karlgusta testfailed kellyk g1gg1l3s kevinlights zxch3n mario206 00mjk satoshi0304 convict-git idpo

vscode-bookmarks's Issues

Produce error when the bookmarked file is not open

Steps to reproduce:

Open folder
Open any file and set bookmark in any line
Close editor
Press F1 and select Bookmarks: List

VSCode show:

Error "Running the contributed command:'bookmarks.list' failed."

If file editor has opened, then all works.

Version 0.10.8
Commit db71ac615ddf9f33b133ff2536f5d33a77d4774e
Date 2016-02-05T10:00:07.223Z
Shell 0.35.6
Renderer 45.0.2454.85
Node 4.1.1

Cannot jump to bookmark when scrolling with mouse

Not sure if this is an issue or a feature that hasn't been implemented yet...

Set a bookmark
Scroll down/up until bookmark is not in the current window
Try to jump to the bookmark, nothing happens, unless the text cursor is not on the same line as the bookmark

Local storage contains lots of files with no bookmarks

Local storage of bookmarks contains many files with no bookmarks. For large projects, this list continue to grow large.

Bookmark icons are missing

The bookmarks function properly but there is no indicator. Using version 1.7.2 on OS X.

On "List from All Files" clicking outside of list closes active file

When navigating the list by keyboard arrows each file is loaded in "preview" mode until the next bookmarked file is loaded (preview mode transfers to next file, previous file is pinned).

Clicking off the list (click into the file body) closes the preview (of currently selected bookmark in list) and returns the user to the last bookmark of the previous file pinned.

There are two issues really. 1) clicking in the document that is previewed closes the document, 2) previous documents get pinned causing a pile-up of documents to be opened.

Question, add message to the bookmarks?

Does it support to add a message for each bookmark?

Tooltip when hovering the scrollbar mark

It would be good to have a little preview when hovering the mark of a bookmark on the scrollbar.

I hope this is a doable feature.

Ability to navigate to bookmarks in other files

Hi,

Unless I'm missing something, it appears that executing "Jump to Next" or "Jump to Previous" only includes bookmarks in the same file. In Visual Studio 'full', the feature will include bookmarks across all files. This is extremely useful in large projects.

Do you think that this is this something very difficult to achieve? If you don't, then I'm open to helping.

Kind regards and thanks for the plug-in.

Bookmarks are cleared after closing VS Code

Hi, @alefragnani

I'm not really sure if it is a bug or maybe a feature, but once VS Code is closed I loose all of my bookmarks. It would really be nice to have them saved cross code's sessions.

Keeping this aside, I think this plug-in is a must and should be included in the core of the editor. Nice work!!! Thanks you.

Enhancement: Click in gutter on Icon to toggle bookmark

The thought is to be able to set/toggle a bookmark by clicking in the gutter. When you click in the gutter for a line you could keep clicking and it would cycle between the break point and a bookmark or none.

Suggestion: Support more functions on bookmarked/unmarked lines

Nice extension BTW. Are you considering to extend it to include functions like those found in Notepad++?

Cut Bookmarked Lines
Copy Bookmarked Lines
Paste to (Replace) Bookmarked Lines
Remove Bookmarked Lines
Remove Unmarked Lines - leave only Bookmarked lines
Inverse Bookmark
Find based Bookmark (find and mark the lines where is found)

Just a suggestion, the extension is great already.

"Open a File First to toggle bookmarks"

I have the latest version. When I try to toggle bookmarks i get the message "Open a File First to toggle bookmarks."

Windows 7, x64
Latest VS Code

Remove console.log from extension

The extension logs a message about activation. I don't think it needs to be in production version:

Extremely large files display error "Open a file to toggle bookmarks"

When attempting to use any of the bookmark commands on a very large file (100,000 lines anecdotally) an info popup appears at the top displaying the message: "Open a file first to toggle bookmarks".

My reproduction:

Open large file.
Attempt to toggle breakpoint
Failure message appears.
Create copy of the large file.
Cut the file down to 50 lines.
Save, close, reopen pruned copy.
Can now toggle breakpoints.

Running the contributed command:'bookmarks.toggle' failed

do you know why it would do that. I had developer's console on but that's all it said.

Suggestion: Bookmarks to remember column number

Currently bookmarks only use entire lines. When jumping to a bookmark the cursor moves to column 1. This suggestion is to have the bookmark remember the column number where the bookmark was set and return to the column number also.

Save bookmarks between sessions

Set to true by default is more logical in my opinion.

Unable to open all file bookmark list

If you delete a file which previously had a bookmark, the all file list no longer works.

Is there any way to bookmark w/ mouse on the gutter (like breakpoints)?

Is there any way to bookmark w/ mouse?

Preview bookmarked lines

Create a new command (Bookmarks: List) that will show all bookmarked lines, with its content, so you easily identify which bookmark you would want to go.

Adopt CHANGELOG file

Save bookmarks between sessions

Allow the bookmarks to be saved and restored, even if you close VS Code or change the active Project/Folder.

Default bookmarks.navigateThroughAllFiles to true

I expect bookmarks to behave like in Visual Studio, so bookmarks.navigateThroughAllFiles should default to true. I'm not sure if this even needs to be configurable.

Auto-save bookmarks by default

I expect my bookmarks to be there when I close/reopen the program. It would be nice if they auto-saved.

Add support to bookmark which could stick with method signature

Request feature:

Now the extension works great, but the problem is that it is based on line number, so every time I changed the code, the bookmark should update accordingly in order to match the latest change.

Any improvement could be very thankful. :)

Commands in context menu

As for breakpoints, it would be easier to add / remove bookmarks via the context menu if it's doable. 😋

Possible to bookmark all search results?

I don't know if this kind of integration is possible, but it'd be handy if so

TSLint

as described

Bookmark icons are missing in Insider 1.6.0

Since the insider 1.6.0, the bookmark icons are not shown. The bookmark itself (the navigation feature) works, but no icon is presented in the gutter.

Reported in VS Code repo microsoft/vscode#12111.

Bookmarks are not being saved for 'preview' files

If you set bookmarks for files that are only previewed, they are not restored when returning to that file.

Only files that goes to Working Files (double clicked in treeview or modified in preview) are saving the bookmarks.

Suggestion: "Go to next/previous bookmark and select" command

Currently we cannot select when moving between bookmarks. This suggestion is to add commands to select while jumping to next/previous bookmark in the current file.

Ctrl+Alt keybindings on Windows

Both Notepad++ and Atom uses F2. Set/Unset with e.g. Shift+F2 and then F2 to jump between.

Bookmarks are _invalidated_ if the file is modified outside VSCode

If you edit the file outside VSCode, no matter if you have the file opened or not, the bookmarks become invalid.

Two problems appears:

If the file is shorter than before, the bookmarks from the deleted lines are moved (appears) to the end of the file (last line). But if you try to navigate with next, it is not reached
If you try to List bookmarks, and error occurs and the list is not displayed

A fix should be check for unreacheable bookmarks when loading, removing them from the file. This should fix both erros.

An enhancement should be add the line contents to the bookmark data so not only unreacheable bookmarks should be fixed, but also outside moved lines could be detected and even fixed

Suggestion: Select all bookmarked lines

A command for selecting all bookmarked lines in the current file could be useful (for example, when working with log files). For example: Scroll through a log file and bookmark lines of interest. Run command to select all lines that are bookmarked, then copy to clipboard.

"No handler found for the command bookmarks.toggle"

Running VSCode 0.10.1

To reproduce:

install the bookmarks extension
open a file
invoke the ">Bookmarks: Toggle" command in the Command Palette.

Result:
"No handler found for the command booksmarks.toggle"

In the console i see the following message:

TypeError: Cannot read property 'document' of undefined

See bookmarks on the scroll bar

It would be great to see the bookmarks on the scroll bar, like the error / warning marks.

Use transparent icon

Replace the current bookmark icon for a transparent one, so it will be shown correctly no matter the theme used

List/Clear bookmarks from all files

Based on the review in the marketplace

If the Bookmarks List command can list all the bookmarks in all files, not just the current file, and the Bookmark Clear can clear all the bookmarks in all files, then it will be awesome.

Keybindings remap option?

Don't see any config block in vs settings to remap the keybindings. Is it possible? Thanks

Change the bookmark icon

Allow the user to define which icon to use as bookmark

Saving Bookmarks

currently when I close the project and reopen it, bookmarks are gone. is this a bug or I have to save bookmarks somehow that I don't know about

Jumping to next bookmark opens a new buffer when same buffer is open in another split panel

OS: Linux and MacOS
version: 0.9.2

Steps to reproduce:

Open to files and split them vertically
Create a book mark in each file
Focus one buffer and jump to next tag

Expected:
The cursor should jump to the buffer in the split.

Actual:
A new buffer was open with the file in the current split.

Here's a video of the reproduction:

Next or Previous bookmarks not working

Using the next or previous bookmark either via the hot key, or selecting from the list, is not working. It doesn't seem to do anything. I have this same exact problem with another library of yours (project manager). Seems like the same issue.

Problem with polish character

VSCode Version: 1.3.1
OS Version: WIndows 10 (polish language)
Bookmarks: 0.9.0
Steps to Reproduce:

Press key RightAlt-l
Instead of getting polish character "Ł" some other operation is done (cursor is going to 1 col)

Sticky bookmark

Would be a nice feature to be able to make the bookmarks sticky to the original line of code when the bookmark was first added. After a while of coding all my bookmarks make no sense anymore.

Can you write in the readme how to install?

I actually have no extension in my vscode. I used to use atom where it was always said how to install. Could you add the instructions to the readme?

Toggle Editing Mode

Would it be possible to add the capability to place the opened file into edit mode when a bookmark is added?

To be more clear:

Open a project with multiple files.
Click on a file and add a bookmark without making any other edits. The file will be listed with the file name in italics
Click on another file
The file gets closed (yet the bookmark does persist)

Could we have the option so that the file is placed into edit mode and does not get closed when a bookmark is added?

Sticky Bookmarks fail with trimAutoWhitespace set to True

I config in 'settings.json' as follow:

"bookmarks.useStickyBookmarks": true

When i add some new blank line before the bookmark, the bookmarks can not stick

Sticky Bookmarks fail if file has unstaged changes in git and already bookmarked when opened

To reproduce this issue,

Enable bookmarks.useStickyBookmarks = true (I also have "editor.trimAutoWhitespace": false, but the bug persists with or without it)
Create a file and add it into git so that it's tracked.
Open the file in vscode and change it. Save the changes but don't stage the changes in git.
Add a bookmark on the file.
Close the file and then open it again.
Make a change to the file above the line that's bookmarked. The bookmark moves or fails.

Here's a gif of the bug in action. Note the lines indicating that the file is currently versioned and changed in git.

The bookmark works at first; it only fails after closing the file and reopening it:

Keybindings should not be used under windows warning

DevConsole logs following warnings with your extenstion