line-reminder

Line annotation for changed and saved lines.

Emacs (with line-reminder)	Visual Studio

🔨 Usage

Enable for all buffers.

(global-line-reminder-mode t)

Or you can just enable in specific buffer you want.

(line-reminder-mode t)

❗ Display Annotation

You can either set line-reminder-show-option to linum or indicators like the following snippet below.

(setq line-reminder-show-option 'linum)  ; Or set to 'indicators

Change display symbol: (Default to "▐")

(setq line-reminder-modified-sign "▐"
      line-reminder-saved-sign "▐")

💥 Using linum

linum uses text to display annotation, you can customize the two variables below to change the display symbol. The default value for both variables is set to "▐".

• line-reminder-modified-sign
• line-reminder-saved-sign

Customize format for how line annotation is displayed.

(setq line-reminder-linum-format "%s ")

💥 Using indicators

Customize the symbol of the fringe: (Default to 'line-reminder--default-bitmap)

(setq line-reminder-bitmap 'filled-rectangle)

If you change the fringe location by altering this variable: (Default to 'left-fringe)

(setq line-reminder-fringe-placed 'left-fringe)

🖼️ Display thumbnail

You can display thumbnail by setting:

(setq line-reminder-thumbnail t)

P.S. fringe is oppsing from variable line-reminder-fringe-placed, hence it's default to right-fringe

You can change the thumbnail bitmap by: (Defaul to line-reminder--default-thumbnail-bitmap)

(setq line-reminder-thumbnail-bitmap 'filled-rectangle)

Change thumbnail display symbol: (Default to "▐")

(setq line-reminder-thumb-modified-sign "▐"
      line-reminder-thumb-saved-sign "▐")

💨 Face

List of face you can customize.

For regular indicators

• line-reminder-modified-sign-face
• line-reminder-saved-sign-face

For thumbnail

• line-reminder-modified-sign-thumb-face
• line-reminder-saved-sign-thumb-face

🛠️ Contribute

If you would like to contribute to this project, you may either clone and make pull requests to this repository. Or you can clone the project and establish your own branch of this tool. Any methods are welcome!

🔬 Development

To run the test locally, you will need the following tools:

• Eask
• Make (optional)

Install all dependencies and development dependencies:

$ eask install-deps --dev

To test the package's installation:

$ eask package
$ eask install

To test compilation:

$ eask compile

🪧 The following steps are optional, but we recommend you follow these lint results!

The built-in checkdoc linter:

$ eask lint checkdoc

The standard package linter:

$ eask lint package

📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.

⚜️ License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

See LICENSE for details.