https://github.com/jhermann/gedit-trim-trailing-whitespace-before-saving-plugin

Gedit plugin that trims trailing whitespace before saving a document
https://github.com/jhermann/gedit-trim-trailing-whitespace-before-saving-plugin

Last synced: over 1 year ago
JSON representation

Gedit plugin that trims trailing whitespace before saving a document

• Host: GitHub
• URL: https://github.com/jhermann/gedit-trim-trailing-whitespace-before-saving-plugin
• Owner: jhermann
• Created: 2013-09-22T11:51:26.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2015-03-09T12:12:19.000Z (over 11 years ago)
• Last Synced: 2025-02-02T08:45:28.966Z (over 1 year ago)
• Language: Python
• Homepage:
• Size: 111 KB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
## Introduction

This is a simple plugin for Gedit 3 which automatically trims trailing whitespace from documents when saving. It deletes all horizontal whitespace on the ends of lines as well as extra blank lines at the end of the file.

## Installation

 0. Make sure that you have the GtkSource-3.0 GI typelib (`/usr/lib/girepository-1.0/GtkSource-3.0.typelib`). On Ubuntu, this can be installed via:

    
sudo apt-get install gir1.2-gtksource-3.0


 1. You may need to create some directories if you haven't installed Gedit plugins locally before:

    
mkdir --parents ~/.local/share/gedit/plugins


 2. If running Gedit version 3.8 or higher, save the latest [`trimtrailingws.plugin`](https://raw.github.com/dtrebbien/gedit-trim-trailing-whitespace-before-saving-plugin/master-python3/src/trimtrailingws.plugin) and [`trimtrailingws.py`](https://raw.github.com/dtrebbien/gedit-trim-trailing-whitespace-before-saving-plugin/master-python3/src/trimtrailingws.py) from the master-python3 branch to `~/.local/share/gedit/plugins`.

    If *not* running Gedit version 3.8 or higher, save the latest [`trimtrailingws.plugin`](https://raw.github.com/dtrebbien/gedit-trim-trailing-whitespace-before-saving-plugin/master/src/trimtrailingws.plugin) and [`trimtrailingws.py`](https://raw.github.com/dtrebbien/gedit-trim-trailing-whitespace-before-saving-plugin/master/src/trimtrailingws.py) from the master branch to `~/.local/share/gedit/plugins`

 3. As root, save [`org.gnome.gedit.plugins.trimtrailingws.gschema.xml`](https://raw.github.com/dtrebbien/gedit-trim-trailing-whitespace-before-saving-plugin/master/src/org.gnome.gedit.plugins.trimtrailingws.gschema.xml) to `/usr/local/share/glib-2.0/schemas` and run:

    
glib-compile-schemas /usr/local/share/glib-2.0/schemas


    Alternatively, to install the GSettings schema without root access, you can change the [`XDG_DATA_DIRS` environment variable](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html) to include a directory under your control, such as `~/.local/share/`:

      * Add the following to your `.bashrc`:

        
if [ -z "$XDG_DATA_DIRS" ]; then

            export XDG_DATA_DIRS=/usr/local/share/:/usr/share/

        fi

        export XDG_DATA_DIRS=~/.local/share/:"$XDG_DATA_DIRS"


      * Then run:

        
mkdir --parents ~/.local/share/glib-2.0/schemas


      * Save [`org.gnome.gedit.plugins.trimtrailingws.gschema.xml`](https://raw.github.com/dtrebbien/gedit-trim-trailing-whitespace-before-saving-plugin/master/src/org.gnome.gedit.plugins.trimtrailingws.gschema.xml) to `~/.local/share/glib-2.0/schemas` and run:

        
glib-compile-schemas ~/.local/share/glib-2.0/schemas


 4. Re-start Gedit.

 5. From the Edit menu, select "Preferences".

 6. On the Plugins tab, scroll down to the entry for "Trim Trailing Whitespace Before Saving" and check the checkbox.

 7. Click Close.

## Uninstallation

 0. From the Edit menu, select "Preferences".

 1. On the Plugins tab, scroll down to the entry for "Trim Trailing Whitespace Before Saving" and uncheck the checkbox.

 2. Close Gedit.

 3. Delete `trimtrailingws.plugin` and `trimtrailingws.py` from `~/.local/share/gedit/plugins`.

## Notes

 *  The plugin looks at the document's syntax highlighting mode. If the highlighting mode is "Plain Text" or "Diff", then the plugin does not remove trailing whitespace.

 *  The plugin source code is based on [Osmo Salomaa](https://github.com/otsaloma)'s "Save without trailing space" plugin for Gedit 2.x that was uploaded to `http://users.tkk.fi/~otsaloma/gedit/`. The website seems to be down now, but the Internet Archive as well as this git repo hold copies of the original source files, `trailsave.gedit-plugin` and `trailsave.py`.

 * If you see the error message:

    
(gedit:3582): GLib-GIO-ERROR **: Settings schema 'org.gnome.gedit.plugins.trimtrailingws' is not installed



    then you need to install the GSettings schema file, `org.gnome.gedit.plugins.trimtrailingws.gschema.xml`. See the section on Installation above.

## License


Copyright © 2010–2013 Daniel Trebbien

Copyright © 2006–2008 Osmo Salomaa


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 2 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, write to the Free Software Foundation, Inc., 51

Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.