https://github.com/nebrius/eol-tools
A set of tools for working with EOL markings
https://github.com/nebrius/eol-tools
Last synced: 5 months ago
JSON representation
A set of tools for working with EOL markings
- Host: GitHub
- URL: https://github.com/nebrius/eol-tools
- Owner: nebrius
- License: gpl-3.0
- Created: 2018-09-28T18:14:14.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-04-28T17:03:50.000Z (about 4 years ago)
- Last Synced: 2025-10-21T21:37:47.878Z (9 months ago)
- Language: JavaScript
- Size: 26.4 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# EOL Tools
A set of tools for working with EOL markings in files.
## Installation
Install using npm:
```BASH
npm install -g eol-tools
```
## Usage
At any time, you can run `eol-tools --help` to get help from the command line.
### Analyzing the line endings of files
You can use eol-tools to analyze the EOL markings of files and report back what they are, including mixed EOL usage and indeterminante usage:
```BASH
eol-tools [a|analayze] [directory...]
```
Each argument after `a` or `analyze` is treated as a separate directory, so you can do things like this:
```BASH
eol-tools a ./src ./dist
```
It will print out the results and indicate one of five possible states:
- None: there were no line endings detected at all, so the EOL type could not be determined. This typically happens on empty files
- UNIX: all EOL markings are `\n`
- Windows: all EOL markings are `\r\n`
- Apple: all EOL markings are `\r` (where did you find this relic?)
- Mixed: there is a cominbination of different markings used in the file
### Converting the line endings of files
**WARNING:** this command is _not_ well tested. Since it's a destructive operation, be careful with it.
You can normalize the line endings by running the following:
```BASH
eol-tools [c|convert] [-e windows|unix] [...]
```
You can specify if you want UNIX-style line endings (`\n`, the default) or Windows-style line endings (`\r\n`) by using the `-e` flag.
For example, to convert all files to UNIX-style line endings, you would run:
```BASH
eol-tools c ./src ./dist
```
or convert them to Windows-style line endings with:
```BASH
eol-tools c -e windows ./src ./dist
```
# License
Copyright (c) Bryan Hughes
EOL Tools 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.
EOL Tools 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 EOL Tools. If not, see .