simple-ftpd - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

package.json

 {
   "name": "simple-ftpd",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "simple ftp server",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -87,15 +87,9 @@ # simple-ftpd
 
-- `host`:
-Required. Must be a valid ipv4 address (for now). Defaults to `127.0.0.1`
-- `port`:
-Required. Server port. Defaults to `1337`.
-- `readOnly`:
-Optional. Disables client write requests. Defaults to `true`.
-Can be overridden on a connection-basis by setting the readOnly property on the session object before logging in.
-- `root`:
-Optional (recommended). The path passed to events will always be joined to `root`. Can be overridden on a connection-basis by setting the root property on the session object before logging in.
-The ftp client will not see `root`, and will think he's at `/`.
-This is simply a convenience to avoid manually joining the path you get in every event.
-- `maxConnections`:
-Optional. Maximum number of server connections. Defaults to 10.
+| option | | description |
+| --- | --- | --- |
+| `host` | required | Must be a valid ipv4 address (for now). Defaults to `127.0.0.1` |
+| `port` | required | Server port. Defaults to `1337`. |
+| `readOnly` | optional | Disables client write requests. Defaults to `true`. Can be overridden on a connection-basis by setting the readOnly property on the session object before logging in. |
+| `root` | optional | The path passed to events will always be joined to `root`. Can be overridden on a connection-basis by setting the root property on the session object before logging in. The ftp client will not see `root`, and will think he's at `/`. This is simply a convenience to avoid manually joining the path you get in every event. |
+| `maxConnections` | optional | Maximum number of server connections. Defaults to 10. |
 
@@ -120,9 +114,7 @@ Passive connections will be initialized on an unused port assigned by the os.
 
-```py
-# In order to prevent a
-# malicious client from determining valid usernames on a server,
-# it is suggested by RFC-2577 that a server always return 331 to
-# the USER command and then reject the combination of username
-# and password for an invalid username when PASS is provided later.
-```
+> In order to prevent a
+> malicious client from determining valid usernames on a server,
+> it is suggested by RFC-2577 that a server always return 331 to
+> the USER command and then reject the combination of username
+> and password for an invalid username when PASS is provided later.
 
@@ -195,9 +187,9 @@ ### `read [pathName, offset, cb]`:
 
-`--host` will default to `127.0.0.1`
-`--port` will default to `1337`
-`--max-connections` will default to `10`
-`--read-only` will default to `true`
-Unless specified, the ftp root will default to `process.cwd()`
+* `--host` will default to `127.0.0.1`
+* `--port` will default to `1337`
+* `--max-connections` will default to `10`
+* `--read-only` will default to `true`
+* Unless specified, the ftp root will default to `process.cwd()`
 
-The cli will accept any login, so be careful when setting --read-only to `false`.
+The cli will accept any login, so be careful when setting `--read-only` to `false`.
 
@@ -204,0 +196,0 @@ ## License

Fixed alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 2 instances in 1 package

Improved metrics

Number of low supply chain risk alerts

0

decreased by-100%

Number of medium supply chain risk alerts

2

decreased by-60%

Worsened metrics

Total package byte prevSize

34270

decreased by-83.79%

Number of package files

27

decreased by-37.21%

Lines of code

876

decreased by-52.88%

Number of lines in readme file

196

decreased by-3.92%

No dependency changes