Skip to content

Keep your place when jumping between a different parts of your code. This is a vscode extension that will highlight lines as you edit them, fading as you move away.

License

Notifications You must be signed in to change notification settings

Wattenberger/footsteps-vscode

Repository files navigation

👣 Footsteps 🐾

Keep your place when jumping between a different parts of your code. This is a VSCode extension that will highlight lines as you edit them, fading as you move away.

Jump between lines using ctrl+alt+left and ctrl+alt+right.

The extension in-action

Extension Settings

This extension allows the following settings:

  • footsteps.highlightColor

    Default: "rgb(153, 128, 250)"

    The color of the highlighted trail (in rgb format). I'd recommend keeping this subtle - black (rgb(0, 0, 0)) if you have a dark theme and white (rgb(255, 255, 255)) if you have a light theme.

  • footsteps.highlightColorMaxOpacity

    Default: 0.4

    The maximum opacity for line highlights (0 - 1) - higher number means a more opaque highlight.

  • footsteps.doHighlightChanges

    Default: true

    Whether or not to add line highlights. If this is false, it will still allow navigation between chunks.

  • footsteps.doHighlightOnClick

    Default: false

    Whether or not to add highlights when you click on a line. This is useful if you want to store a place while navigating around the code.

  • footsteps.doHighlightCurrentlyFocusedChunk

    Default: false

    Whether or not to highlight the actively focused chunk. It can be distracting to highlight the code you're actively working on, so this is off by default.

  • footsteps.doHighlightEmptyLines

    Default: true

    Whether or not to highlight changed lines that are empty. Some may find this distracting.

  • footsteps.doHighlightInactiveEditors

    Default: false

    Whether or not to highlight lines in inactive editors. For example, if you have two files open, and you're editing one, this will highlight the lines in the other file.

  • footsteps.maxNumberOfChangesToRemember

    Default: 6

    The number of changes to save in history

  • footsteps.maxNumberOfChangesToHighlight

    Default: 10

    The number of changes to highlight. A lower number drops off more quickly.

  • footsteps.minDistanceFromCursorToHighlight

    Default: 3

    The minimum distance from the cursor to highlight a line. This is to prevent distracting highlights when you're actively working on a line.

  • footsteps.clearChangesOnFileSave

    Default: false

    Whether or not to clear changes in a file when you save it.

Commands

This extension doesn't have any default commands, to prevent from clashing with your setup. Bind your own keybindings to these commands:

  • footsteps.skipBack

    Skip back in footsteps. Default: ctrl+alt+left

  • footsteps.skipForwards

    Skip forwards in footsteps. Default: ctrl+alt+right

  • footsteps.skipBackSameFile

    Skip back in footsteps (stay in the same file)

  • footsteps.skipForwardsSameFile

    Skip forwards in footsteps (stay in the same file)

  • footsteps.skipBackDifferentFile

    Skip back in footsteps (skip between files)

  • footsteps.skipForwardsDifferentFile

    Skip forwards in footsteps (skip between files)

  • footsteps.clearChangesWithinFile

    Clear all changes within file (useful when you've edited the whole file)

  • footsteps.onClearProjectChanges

    Clear all changes within project

  • footsteps.toggleHighlightingLines

    Toggle the footsteps.doHighlightChanges setting: whether or not we are highlighting lines

🤝 How to Contribute

I'd love suggestions on how to improve the extension (feature requests) or code suggestions.

📝 License

Licensed under the MIT License.

About

Keep your place when jumping between a different parts of your code. This is a vscode extension that will highlight lines as you edit them, fading as you move away.

Topics

Resources

License

Stars

Watchers

Forks