remove-trailing-spaces

What is remove-trailing-spaces?

The remove-trailing-spaces npm package is designed to help developers clean up their code by removing unnecessary trailing spaces from the end of each line in a given text or file. This can be particularly useful for maintaining coding standards, improving readability, and avoiding potential issues in languages or environments where trailing spaces might cause errors or unexpected behavior.

What are remove-trailing-spaces's main functionalities?

Remove trailing spaces from a string

This feature allows you to remove trailing spaces from a given string. It's useful for cleaning up individual lines of text or strings that may have been formatted with extra spaces at the end.

"use strict";\nconst removeTrailingSpaces = require('remove-trailing-spaces');\nlet stringWithTrailingSpaces = 'Hello World!   ';\nlet cleanedString = removeTrailingSpaces(stringWithTrailingSpaces);\nconsole.log(cleanedString); // 'Hello World!'

Integrate with file processing

This feature demonstrates how remove-trailing-spaces can be used in conjunction with Node.js's file system module (fs) to read a file, clean it by removing trailing spaces, and then write the cleaned data to a new file. It's particularly useful for batch processing of files or cleaning up source code files.

"use strict";\nconst fs = require('fs');\nconst removeTrailingSpaces = require('remove-trailing-spaces');\nfs.readFile('example.txt', 'utf8', (err, data) => {\n  if (err) throw err;\n  const cleanedData = removeTrailingSpaces(data);\n  fs.writeFile('example_cleaned.txt', cleanedData, (err) => {\n    if (err) throw err;\n    console.log('File has been cleaned!');\n  });\n});

Other packages similar to remove-trailing-spaces

trim

The trim package offers functionality to remove whitespace from both ends of a string, which is slightly different from remove-trailing-spaces as it also trims leading spaces. It's useful for general string cleanup but doesn't specifically target only trailing spaces.

strip-eof

Strip-eof is designed to remove end-of-file (EOF) markers from a string or buffer. While it focuses on a different aspect of cleanup, it shares the goal of tidying up text content. Unlike remove-trailing-spaces, it doesn't specifically target trailing spaces on each line.

README

remove-trailing-spaces

Remove the trailing spaces from a string.

:cloud: Installation

# Using npm
npm install --save remove-trailing-spaces

# Using yarn
yarn add remove-trailing-spaces

:clipboard: Example

const removeTrailingSpaces = require("remove-trailing-spaces");

let input = "Line 1     "
   + "\n" + "Line 2        "
   + "\n" + "Line 3     \t\t\t"
   + "\n" + "Line 4          " + String.fromCharCode(160)
   + "\n" + "                   "
   + "\n" + "Line 6"
   ;

let res = removeTrailingSpaces(input);

let oLines = input.split("\n");
res.split("\n").forEach((c, i) => {
    console.log(`Removed ${oLines[i].length - c.length} spaces on line ${i + 1}`);
    // Removed 5 spaces on line 1
    // Removed 8 spaces on line 2
    // Removed 8 spaces on line 3
    // Removed 11 spaces on line 4
    // Removed 19 spaces on line 5
    // Removed 0 spaces on line 6
});

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

removeTrailingSpaces(input)

Remove the trailing spaces from a string.

Params

• String input: The input string.

Return

• String The output string.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

• json-to-pretty-yaml
• node-gtk
• write-file-trim
• ngindox
• trailing-whitespaces
• hasura-auto-aliases
• profane-detect
• @marcelorubim/json2yaml

:scroll: License

MIT © Ionică Bizău