^{[ 🌐 📩 🔥 ]}

Inline Bookmarks

Code navigation for inline bookmarks made easy.

• Specify words inside your documents that are highlighted as bookmarks in the IDE.
• Easily navigate to bookmarks from the Inline Bookmarks View added to the Explorer Panel.

Other extensions allow you to set bookmarks with some clicks in the IDE. With Inline Bookmarks you specify custom trigger words inside your documents that are automatically turned into VSCode Bookmarks. They will show up with a customizable gutter icon next to the code lines and are highlighted within the code. Decorations can be customized. An Inline Bookmarks View in the Explorer Panel helps you keep track of all your bookmarks. Navigating to the bookmark location is as easy as clicking on an item in the view.

The extension can be used to keep track of development notes and todo's, for document review, as well as log analysis and auditing purposes. Since bookmarks are stored with your documents you can easily share your notes and bookmarks with others.

Tour

Customizable Inline Bookmarks

• the following bookmark styles are provided by default: red, green, blue, purple

  

Note: Additional custom styles can be added in the extension settings. See Expert options.

• the following default trigger words/tags are configured by default:
  • @todo - (blue) General ToDo remark.
  • @note - (blue) General remark.
  • @remind - (blue) General remark.
  • @follow-up - (blue) General remark.
  • @audit - (red) General bookmark for potential issues.
  • @audit-info - (blue) General bookmark for information to be noted for later use.
  • @audit-ok - (green) Add a note that a specific line is not an issue even though it might look like.
  • @audit-issue - (purple) Reference a code location an issue was filed for.

Note: Words can be fully customized in: code → preferences → Extensions: Inline Bookmarks. Note: Keyboard shortcuts can be assigned in: code → preferences → keyboard shortcuts.

Filterable Bookmarks Finder

command: inlineBookmarks.showSelectBookmark

Bookmarks View

• click on a bookmark to jump to its location
• click refresh to re-scan loaded files for changes
• toggle to only show bookmarks for visible editors
• the bookmarks view will follow your cursor location in the editor. the follow mode can be changed with the configuration option inline-bookmarks.view.followMode.
• jump to next/previous bookmark with commands inlineBookmarks.jumpToNext, inlineBookmarks.jumpToPrevious (assign your own keyboard shortcut in vscode preferences)
• apply custom filter to bookmarks view with command inlineBookmarks.setTreeViewFilterWords.
  • empty list unsets filter
  • takes space- or semicolon-delimited list of regular expressions applied on the items label.
  • affects jumpToNext, jumpToPrevious

Expert

• reset the internal bookmarks state: inlineBookmarks.debug.state.reset
  • bookmarks view is populated when files containing bookmarks are openend in the editor
• go to the extension settings: code → preferences → Extensions: Inline Bookmarks
• Exceptions
  • configure file-extensions to be exempt from decoration
  • configure temporary overrides for trigger words to be exempt from decoration (matches begin of word)
• Custom Styles
  • be aware that existing styles can be overridden
  • The gutterIconPath is not customizable right now. You can only use the images provided with the extension right now: images/bookmark-{red,green,blue,purple}.svg. See example below.
• Custom word mappings
  • You can assign multiple regex trigger words to a decoration style. See example below.

Example style definition: (all vscode style properties are allowed)

"inline-bookmarks.expert.custom.styles": {
    "default": {
        "gutterIconPath": "images/bookmark-blue.svg",
        "overviewRulerColor": "rgba(21, 126, 251, 0.7)",
        "light": {
            "fontWeight": "bold"
        },
        "dark": {
            "color": "Chocolate"
        }
    },
    "red": {
        "gutterIconPath": "images/bookmark-red.svg",
        "light": {
            "fontWeight": "bold"
        },
        "dark": {
            "color": "Chocolate"
        }
    },
    "blue": {
        "gutterIconPath": "images/bookmark-blue.svg",
        "light": {
            "fontWeight": "bold"
        },
        "dark": {
            "color": "Chocolate"
        }
    },
    "green": {
        "gutterIconPath": "images/bookmark-green.svg",
        "light": {
            "fontWeight": "bold"
        },
        "dark": {
            "color": "Chocolate"
        }
    },
    "purple": {
        "gutterIconPath": "images/bookmark-purple.svg",
        "light": {
            "fontWeight": "bold"
        },
        "dark": {
            "color": "Chocolate"
        }
    }
}

Example word mapping: (all vscode style properties are allowed)

"inline-bookmarks.expert.custom.words.mapping": {
    "blue": ["@audit\\-info[ \\t\\n]"],
    "purple": ["@audit\\-issue[ \t\\n]"],
    "green": ["@audit\\-ok[ \\t\\n]"],
    "red": ["@audit[ \\t\\n]"]
}

• Note: gutter icons are hardcoded at this time.

Release Notes

see CHANGELOG

0.0.17

• new: added functionality to quickly filter the list of bookmarks inlineBookmarks.showSelectBookmark #11
• fixed: multiple issues where tree items or bookmarks where undefined #16
• new: debug command to reset the stored bookmarks read from workspace. in case the workspace is corrupt. inlineBookmarks.debug.state.reset #16

0.0.16

• new: added commands to jump to next/previous bookmark: inlineBookmarks.jumpToNext inlineBookmarks.jumpToPrevious #12
  • Note: keyboard shortcuts can be configured in code -> preferences -> keyboard shortcuts #15
• new: added functionality to filter the bookmark view #14
• fixed: remove jumpToLine from command menu #13

0.0.15

• fixed: treeview item id(0) error
• new: set inline-bookmarks.view.words.hide to hide tags/trigger words in bookmarks view (only for entries with additional text)

0.0.14

• fixed: wrong treeview item selected #7

0.0.13

• allow to specify bookmarks view follow behavior: inline-bookmarks.view.followMode
  • nearest - highlights the nearest bookmark (relative distance)
  • chapter - highlights the most recent bookmark or the bookmark that is on the current line.

0.0.12

• new: sync the bookmarks view with the editor click action (highlight nearest)
• fixed: sort bookmarks view by line number

0.0.11

• fixed: icon not shown in bookmark view on Windows
• fixed: bookmark view does not refresh on Windows

0.0.10

• fixed: errors due to assignment to const
• added: dark theme icons
• fixed: make clear that the refresh button only reloads known bookmarks and does not scan all files in the workspace

0.0.9

• changed: when set, show all visible editor files bookmarks in bookmarks view
• new: allow to define bookmark view behavior as initially collapsed (default) or expanded.
  • Code -> Preferences -> Settings inline-bookmarks.view.expanded
  • Or, run command: Toggle: Keep File View expanded (inlineBookmarks.toggleViewKeepFilesExpanded)

0.0.8

• new: toggle Inline Bookmark view to only show bookmarks of active file vs. all files
  • by default shows all files

0.0.7

• new: configuration options
  • disable decorations
  • blacklist files-extensions that should not be decorated
  • blacklist words that should be temporarily ignored from decoration
  • hard-code default styles but allow to override them in the configuration
  • expose trigger words for default styles and allow to customize them
  • allow users to configure new styles and map trigger words to them
• fix: bookmarks view: did not auto-refresh on load
• fix: pattern for audit-issue
• fix: clear empty bookmarks