eol-converter-cli - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "eol-converter-cli",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Newline (EOL) coverter CLI for NodeJs (github repo soon) - Currently doing only CRLF -> LF convertion",
@@ -18,4 +18,4 @@ "main": "src/index.js",
   ],
-  "author": "jurosh",
-  "license": "ISC",
+  "author": "Juraj Husar <http://github.com/jurosh/>",
+  "license": "Apache 2.0",
   "dependencies": {
@@ -22,0 +22,0 @@ "eol": "^0.9.0",

README.md

@@ -1,22 +0,40 @@
-# Newlines (EOL) converter cli for NodeJs
+# Newlines (EOL) converter CLI
 
-Newline (EOL) coverter CLI for NodeJs (github repo soon) - doing only CRLF -> LF, or LF -> CRLF convertion.
+*Having troubles with different files line endings?* :flushed:
 
-Usage:
+This library may simple convert files of your choice to Windows (`CRLF`), or popular `LF` line ends used on Linux and Mac.
 
+Installation: `npm i -g eol-converter-cli`
+
+API: `eolConverter OptionalModifier "glob_files_regex"`
+
+* *OptionalModifier* can be empty, `warmup`, or `crlf` - see examples.
+* For files paths resolution is used [GLOB regex](https://www.npmjs.com/package/glob)
+
+## Examples
+
+See which files will be affected:
+
 ```
-npm i -g eol-converter-cli
-
-// To see which files will be affected
 eolConverter warmup "**/*.js"
+```
 
-// Run conversions (cannot be undone)
+Conversions (cannot be undone):
 
-// To LF
+**To LF (Unix & Mac default)**
+
+```
 eolConverter "**/*.js"
+```
 
-// To CRLF
+**To CRLF (Windows default)**
+
+```
 eolConverter crlf "**/*.{js,jsx,ts,tsx}"
 ```
 
-For files reges is used GLOB regex, see https://www.npmjs.com/package/glob
+## Notes
+
+PS: Don't forget to configure you favourite IDE to work with desired line endings, so that you won't need this tool again! :smirk:
+
+**Please give project :star: if you like it!**

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14196

increased by568.05%

Number of package files

7

increased by16.67%

Number of lines in readme file

40

increased by81.82%

No dependency changes