https://github.com/logic-finder/proofread
removes spaces at EOL and adds a newline at EOF
https://github.com/logic-finder/proofread
c eof eol text-formatter utility
Last synced: 3 months ago
JSON representation
removes spaces at EOL and adds a newline at EOF
- Host: GitHub
- URL: https://github.com/logic-finder/proofread
- Owner: logic-finder
- License: mit
- Created: 2025-10-26T06:53:23.000Z (7 months ago)
- Default Branch: core
- Last Pushed: 2025-11-16T13:12:21.000Z (7 months ago)
- Last Synced: 2025-11-16T15:13:57.408Z (7 months ago)
- Topics: c, eof, eol, text-formatter, utility
- Language: C
- Homepage:
- Size: 121 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PROOFREAD
**proofread** - removes spaces at EOL (if any) and adds a newline at EOF (if not exist)
```bash
proofread [-l] [-f] [--dry-run[=(full|line)]] [-]
proofread [-l] [-f] [--dry-run[=(full|line)]] [--mute] + [--] ...
proofread [-l] [-f] [--keep[=]] [--mute] + [--] ...
proofread (-h | --help)
proofread (-v | -vv | -vvv)
```
### Demo
[This video](https://youtu.be/fh_IJph_kn4?t=110) shows how I made this program.
## Installation
```bash
$ make install insdir=
```
The `make install` call builds `proofread`, the executable, and installs the program under the directory given by ``. The path must not be a relative path. The program needs this path so as to work properly.
The structure of the installation directory is as follows:
```bash
$ tree
├── bak
├── dat
│ ├── proofread.1
│ ├── proofread.1.txt
│ └── version.txt
└── proofread
3 directories, 4 files
```
## Usage
### Checking for EOL and EOF Problems
```bash
# Reads one file from stdin and prints to stdout
$ proofread -lf --dry-run=line - < input.txt
# Reads multiple files and prints to stdout
$ proofread -lf --dry-run=line + -- a.txt b.txt c.txt
```
### Fixing EOL and EOF Problems
```bash
# Fixes the problem in the input and overwrites to it
$ proofread -lf + -- input.txt
# Fixes the problem in the input and keeps it under a directory
$ proofread -lf --keep=backup/ + -- input.txt
```
### Pre-commit Hook
There is a way to apply **proofread** automatically, when `git commit` is executed, on the files which are staged (by a prior `git add`) and whose state is modified or newly added. The pre-commit hook does this task. Its behavior differs depending on whether the file has local changes or not. If it does, the hook updates the index only. Otherwise, the hook updates both the index and the worktree.
In order to use it, the hook must be compiled first and installed under the `.git/hooks` directory of the desired git repository:
```bash
$ make hook EXT_LIST='".c", ".h"' SHUTUP=1
$ cp hook/pre-commit /.git/hooks
```
Two variables affect the behavior of the hook:
- `EXT_LIST` defines the extensions to apply **proofread**. The value must be enclosed with a single-quote mark and each extension must be enclosed with a double-quote mark. The extensions are comma-separated. If not specified, all of the files which meet the above conditions are subject to the application.
- `SHUTUP` sets the verbosity of the hook. The value of **1** means **true** and **0**, **false**.
If the hook is executed with `l` option, it prints out the extension list at stdout, exiting with the status code 2.
## Verification on Tags and Commits
If one is in need of verifying the tags and commits, please type `git show maintainer-pgp-pub` and follow the instruction written in it.