check-eol
v0.1.0
Published
CLI for ensuring all given files match the desired newline pattern (LF or CRLF)
Downloads
4
Keywords
Readme
check-eol
A command line utility to check what line endings are being used in files. Useful for enforcing consisten line endings across an entire project (such as an open source project with both windows and non-windows contributors).
Installation
npm
npm install check-eol -g
Usage
check-eol
inspects the line endings of every matching file and return a nonzero error code if any file has incorrect line endings, as well as printing out the paths of the non-compliant files.
You can specify as many file paths or globs as you wish. They will all be merged into a single unified file list before processing.
Examples
verify all files have LF endings
npx check-eol --eol lf "**/*"
verify all .txt files have CRLF endings
npx check-eol --eol crlf "**/*.txt"
verify all html and css files have the platform-specific line endings
npx check-eol --eol platform "**/*.html" "**/*.css"
CLI options
eol
The type of line ending to enforce. If "platform"
is selected, then "crlf"
will be enforced on Windows, and "lf"
everywhere else.
Optional: yes
Default: "lf"
Options: "lf"
, "crlf"
, "platform"
example:
#enforce lf line endings
npx check-eol --eol lf
cwd
The current working directory where relative paths are relative to
Optional: yes
Default: process.cwd()
example:
npx check-eol --cwd "/usr/JohnSmith/projects/project1"
Changelog
Click here to view the changelog.