From 6d0835ffe8c8b7aa461f39343cef3e3a82e7cb95 Mon Sep 17 00:00:00 2001 From: Saksham Singh <60515013+wayiam@users.noreply.github.com> Date: Mon, 9 Aug 2021 01:24:11 +0530 Subject: [PATCH 1/7] Used table format for README summary of commands. --- README.md | 73 ++++++++++++++++++++----------------------------------- 1 file changed, 26 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index a43f980b..26a54807 100644 --- a/README.md +++ b/README.md @@ -42,53 +42,32 @@ Using `npx` you can run the script without installing it first: ## Available Options: -`-p` or `--port` Port to use (defaults to 8080). Use `-p 0` to look for an open port, starting at 8080. It will also read from `process.env.PORT`. - -`-a` Address to use (defaults to 0.0.0.0) - -`-d` Show directory listings (defaults to `true`) - -`-i` Display autoIndex (defaults to `true`) - -`-g` or `--gzip` When enabled (defaults to `false`) it will serve `./public/some-file.js.gz` in place of `./public/some-file.js` when a gzipped version of the file exists and the request accepts gzip encoding. If brotli is also enabled, it will try to serve brotli first. - -`-b` or `--brotli` When enabled (defaults to `false`) it will serve `./public/some-file.js.br` in place of `./public/some-file.js` when a brotli compressed version of the file exists and the request accepts `br` encoding. If gzip is also enabled, it will try to serve brotli first. - -`-e` or `--ext` Default file extension if none supplied (defaults to `html`) - -`-s` or `--silent` Suppress log messages from output - -`--cors` Enable CORS via the `Access-Control-Allow-Origin` header - -`-o [path]` Open browser window after starting the server. Optionally provide a URL path to open. e.g.: -o /other/dir/ - -`-c` Set cache time (in seconds) for cache-control max-age header, e.g. `-c10` for 10 seconds (defaults to `3600`). To disable caching, use `-c-1`. - -`-U` or `--utc` Use UTC time format in log messages. - -`--log-ip` Enable logging of the client's IP address (default: `false`). - -`-P` or `--proxy` Proxies all requests which can't be resolved locally to the given url. e.g.: -P http://someurl.com - -`--username` Username for basic authentication [none] - -`--password` Password for basic authentication [none] - -`-S` or `--ssl` Enable https. - -`-C` or `--cert` Path to ssl cert file (default: `cert.pem`). - -`-K` or `--key` Path to ssl key file (default: `key.pem`). - -`-r` or `--robots` Provide a /robots.txt (whose content defaults to `User-agent: *\nDisallow: /`) - -`--no-dotfiles` Do not show dotfiles - -`--mimetypes` Path to a .types file for custom mimetype definition - -`-h` or `--help` Print this list and exit. - -`-v` or `--version` Print the version and exit. +| Command | Description | +| ------------- |:-------------:| +| `-p` or `--port` | Port to use (defaults to 8080). Use `-p 0` to look for an open port, starting at 8080. It will also read from `process.env.PORT`. | +| `-a` | Address to use (defaults to 0.0.0.0) | +| `-d` | Show directory listings (defaults to `true`) | +| `-i` | Address to use (defaults to 0.0.0.0) | +| `-g` or `--gzip` | When enabled (defaults to `false`) it will serve `./public/some-file.js.gz` in place of `./public/some-file.js` when a gzipped version of the file exists and the request accepts gzip encoding. If brotli is also enabled, it will try to serve brotli first.| +| `-b` or `--brotli`| When enabled (defaults to `false`) it will serve `./public/some-file.js.br` in place of `./public/some-file.js` when a brotli compressed version of the file exists and the request accepts `br` encoding. If gzip is also enabled, it will try to serve brotli first. | +| `-e` or `--ext` | Default file extension if none supplied (defaults to `html`) | +| `-s` or `--silent` | Suppress log messages from output | +| `--cors` | Enable CORS via the `Access-Control-Allow-Origin` header | +| `-o [path]` | Open browser window after starting the server. Optionally provide a URL path to open. e.g.: -o /other/dir/ | +| `-c` | Set cache time (in seconds) for cache-control max-age header, e.g. `-c10` for 10 seconds (defaults to `3600`). To disable caching, use `-c-1`.| +| `-U` or `--utc` | Use UTC time format in log messages.| +| `--log-ip` | Enable logging of the client's IP address (default: `false`). | +| `-P` or `--proxy` | Proxies all requests which can't be resolved locally to the given url. e.g.: -P http://someurl.com | +| `--username` | Username for basic authentication [none] | +| `--password` | Password for basic authentication [none] | +| `-S` or `--ssl` | Enable https.| +| `-C` or `--cert` | Path to ssl cert file (default: `cert.pem`). | +|`-K` or `--key` | Path to ssl key file (default: `key.pem`). | +| `-r` or `--robots` | Provide a /robots.txt (whose content defaults to `User-agent: *\nDisallow: /`) | +| `--no-dotfiles` | Do not show dotfiles +| `--mimetypes` |Path to a .types file for custom mimetype definition +| `-h` or `--help` | Print this list and exit. | +| `-v` or `--version`| Print the version and exit. | ## Magic Files From b1e9f4672d9026ecf1c274d301c4a0e7b53ccf53 Mon Sep 17 00:00:00 2001 From: Saksham Singh <60515013+wayiam@users.noreply.github.com> Date: Mon, 9 Aug 2021 20:52:28 +0530 Subject: [PATCH 2/7] Created Column for default values Also set the text to left aligned. --- README.md | 52 ++++++++++++++++++++++++++-------------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 26a54807..7f622763 100644 --- a/README.md +++ b/README.md @@ -42,32 +42,32 @@ Using `npx` you can run the script without installing it first: ## Available Options: -| Command | Description | -| ------------- |:-------------:| -| `-p` or `--port` | Port to use (defaults to 8080). Use `-p 0` to look for an open port, starting at 8080. It will also read from `process.env.PORT`. | -| `-a` | Address to use (defaults to 0.0.0.0) | -| `-d` | Show directory listings (defaults to `true`) | -| `-i` | Address to use (defaults to 0.0.0.0) | -| `-g` or `--gzip` | When enabled (defaults to `false`) it will serve `./public/some-file.js.gz` in place of `./public/some-file.js` when a gzipped version of the file exists and the request accepts gzip encoding. If brotli is also enabled, it will try to serve brotli first.| -| `-b` or `--brotli`| When enabled (defaults to `false`) it will serve `./public/some-file.js.br` in place of `./public/some-file.js` when a brotli compressed version of the file exists and the request accepts `br` encoding. If gzip is also enabled, it will try to serve brotli first. | -| `-e` or `--ext` | Default file extension if none supplied (defaults to `html`) | -| `-s` or `--silent` | Suppress log messages from output | -| `--cors` | Enable CORS via the `Access-Control-Allow-Origin` header | -| `-o [path]` | Open browser window after starting the server. Optionally provide a URL path to open. e.g.: -o /other/dir/ | -| `-c` | Set cache time (in seconds) for cache-control max-age header, e.g. `-c10` for 10 seconds (defaults to `3600`). To disable caching, use `-c-1`.| -| `-U` or `--utc` | Use UTC time format in log messages.| -| `--log-ip` | Enable logging of the client's IP address (default: `false`). | -| `-P` or `--proxy` | Proxies all requests which can't be resolved locally to the given url. e.g.: -P http://someurl.com | -| `--username` | Username for basic authentication [none] | -| `--password` | Password for basic authentication [none] | -| `-S` or `--ssl` | Enable https.| -| `-C` or `--cert` | Path to ssl cert file (default: `cert.pem`). | -|`-K` or `--key` | Path to ssl key file (default: `key.pem`). | -| `-r` or `--robots` | Provide a /robots.txt (whose content defaults to `User-agent: *\nDisallow: /`) | -| `--no-dotfiles` | Do not show dotfiles -| `--mimetypes` |Path to a .types file for custom mimetype definition -| `-h` or `--help` | Print this list and exit. | -| `-v` or `--version`| Print the version and exit. | +| Command | Description | Defaults | +| ------------- |-------------|-------------| +|`-p` or `--port` |Port to use. Use `-p 0` to look for an open port, starting at 8080. It will also read from `process.env.PORT`. |8080 | +|`-a` |Address to use |defaults to 0.0.0.0| +|`-d` |Show directory listings |`true` | +|`-i` |Address to use | defaults to 0.0.0.0 | +|`-g` or `--gzip` |When enabled it will serve `./public/some-file.js.gz` in place of `./public/some-file.js` when a gzipped version of the file exists and the request accepts gzip encoding. If brotli is also enabled, it will try to serve brotli first.|`false`| +|`-b` or `--brotli`|When enabled it will serve `./public/some-file.js.br` in place of `./public/some-file.js` when a brotli compressed version of the file exists and the request accepts `br` encoding. If gzip is also enabled, it will try to serve brotli first. |`false`| +|`-e` or `--ext` |Default file extension if none supplied |`html` | +|`-s` or `--silent` |Suppress log messages from output | | +|`--cors` |Enable CORS via the `Access-Control-Allow-Origin` header | | +|`-o [path]` |Open browser window after starting the server. Optionally provide a URL path to open. e.g.: -o /other/dir/ | | +|`-c` |Set cache time (in seconds) for cache-control max-age header, e.g. `-c10` for 10 seconds. To disable caching, use `-c-1`.|`false` | +|`-U` or `--utc` |Use UTC time format in log messages.| | +|`--log-ip` |Enable logging of the client's IP address |`false` | +|`-P` or `--proxy` |Proxies all requests which can't be resolved locally to the given url. e.g.: -P http://someurl.com | | +|`--username` |Username for basic authentication [none] | | +|`--password` |Password for basic authentication [none] | | +|`-S` or `--ssl` |Enable https.| | +|`-C` or `--cert` |Path to ssl cert file |`cert.pem` | +|`-K` or `--key` |Path to ssl key file |`key.pem` | +|`-r` or `--robots` |Provide a /robots.txt `User-agent: *\nDisallow: /` | | +|`--no-dotfiles` |Do not show dotfiles| | +|`--mimetypes` |Path to a .types file for custom mimetype definition| | +|`-h` or `--help` |Print this list and exit. | | +|`-v` or `--version`|Print the version and exit. | | ## Magic Files From c74855e0a88000975930ca618e447d271c530475 Mon Sep 17 00:00:00 2001 From: Saksham Singh <60515013+wayiam@users.noreply.github.com> Date: Mon, 9 Aug 2021 21:00:22 +0530 Subject: [PATCH 3/7] Fixed the column bug --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7f622763..cd44e527 100644 --- a/README.md +++ b/README.md @@ -45,9 +45,9 @@ Using `npx` you can run the script without installing it first: | Command | Description | Defaults | | ------------- |-------------|-------------| |`-p` or `--port` |Port to use. Use `-p 0` to look for an open port, starting at 8080. It will also read from `process.env.PORT`. |8080 | -|`-a` |Address to use |defaults to 0.0.0.0| +|`-a` |Address to use |0.0.0.0| |`-d` |Show directory listings |`true` | -|`-i` |Address to use | defaults to 0.0.0.0 | +|`-i` |Address to use | 0.0.0.0 | |`-g` or `--gzip` |When enabled it will serve `./public/some-file.js.gz` in place of `./public/some-file.js` when a gzipped version of the file exists and the request accepts gzip encoding. If brotli is also enabled, it will try to serve brotli first.|`false`| |`-b` or `--brotli`|When enabled it will serve `./public/some-file.js.br` in place of `./public/some-file.js` when a brotli compressed version of the file exists and the request accepts `br` encoding. If gzip is also enabled, it will try to serve brotli first. |`false`| |`-e` or `--ext` |Default file extension if none supplied |`html` | From 5536af0656162dac4c060ba8fd07ba181d4b1afd Mon Sep 17 00:00:00 2001 From: Saksham Singh <60515013+wayiam@users.noreply.github.com> Date: Tue, 10 Aug 2021 11:26:27 +0530 Subject: [PATCH 4/7] Update README.md Co-authored-by: Jade Michael Thornton --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cd44e527..3141ab60 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ Using `npx` you can run the script without installing it first: |`-p` or `--port` |Port to use. Use `-p 0` to look for an open port, starting at 8080. It will also read from `process.env.PORT`. |8080 | |`-a` |Address to use |0.0.0.0| |`-d` |Show directory listings |`true` | -|`-i` |Address to use | 0.0.0.0 | +|`-i` | Display autoIndex | `true` | |`-g` or `--gzip` |When enabled it will serve `./public/some-file.js.gz` in place of `./public/some-file.js` when a gzipped version of the file exists and the request accepts gzip encoding. If brotli is also enabled, it will try to serve brotli first.|`false`| |`-b` or `--brotli`|When enabled it will serve `./public/some-file.js.br` in place of `./public/some-file.js` when a brotli compressed version of the file exists and the request accepts `br` encoding. If gzip is also enabled, it will try to serve brotli first. |`false`| |`-e` or `--ext` |Default file extension if none supplied |`html` | From f15af3931ac863c718732758fb051639b8c07bf3 Mon Sep 17 00:00:00 2001 From: Saksham Singh <60515013+wayiam@users.noreply.github.com> Date: Tue, 10 Aug 2021 11:26:35 +0530 Subject: [PATCH 5/7] Update README.md Co-authored-by: Jade Michael Thornton --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3141ab60..fd56284b 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ Using `npx` you can run the script without installing it first: |`-s` or `--silent` |Suppress log messages from output | | |`--cors` |Enable CORS via the `Access-Control-Allow-Origin` header | | |`-o [path]` |Open browser window after starting the server. Optionally provide a URL path to open. e.g.: -o /other/dir/ | | -|`-c` |Set cache time (in seconds) for cache-control max-age header, e.g. `-c10` for 10 seconds. To disable caching, use `-c-1`.|`false` | +|`-c` |Set cache time (in seconds) for cache-control max-age header, e.g. `-c10` for 10 seconds. To disable caching, use `-c-1`.|`3600` | |`-U` or `--utc` |Use UTC time format in log messages.| | |`--log-ip` |Enable logging of the client's IP address |`false` | |`-P` or `--proxy` |Proxies all requests which can't be resolved locally to the given url. e.g.: -P http://someurl.com | | From d49cea579f514bd1bbb49533576499898d9b1449 Mon Sep 17 00:00:00 2001 From: Saksham Singh <60515013+wayiam@users.noreply.github.com> Date: Tue, 10 Aug 2021 11:26:41 +0530 Subject: [PATCH 6/7] Update README.md Co-authored-by: Jade Michael Thornton --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fd56284b..a2dacc1f 100644 --- a/README.md +++ b/README.md @@ -58,8 +58,8 @@ Using `npx` you can run the script without installing it first: |`-U` or `--utc` |Use UTC time format in log messages.| | |`--log-ip` |Enable logging of the client's IP address |`false` | |`-P` or `--proxy` |Proxies all requests which can't be resolved locally to the given url. e.g.: -P http://someurl.com | | -|`--username` |Username for basic authentication [none] | | -|`--password` |Password for basic authentication [none] | | +|`--username` |Username for basic authentication | | +|`--password` |Password for basic authentication | | |`-S` or `--ssl` |Enable https.| | |`-C` or `--cert` |Path to ssl cert file |`cert.pem` | |`-K` or `--key` |Path to ssl key file |`key.pem` | From 7bd98e8ab596aced18dc1f742535c25830f0a68f Mon Sep 17 00:00:00 2001 From: Saksham Singh <60515013+wayiam@users.noreply.github.com> Date: Tue, 10 Aug 2021 11:26:50 +0530 Subject: [PATCH 7/7] Update README.md Co-authored-by: Jade Michael Thornton --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a2dacc1f..266d3977 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ Using `npx` you can run the script without installing it first: |`-S` or `--ssl` |Enable https.| | |`-C` or `--cert` |Path to ssl cert file |`cert.pem` | |`-K` or `--key` |Path to ssl key file |`key.pem` | -|`-r` or `--robots` |Provide a /robots.txt `User-agent: *\nDisallow: /` | | +|`-r` or `--robots` | Automatically provide a /robots.txt (The content of which defaults to `User-agent: *\nDisallow: /`) | `false` | |`--no-dotfiles` |Do not show dotfiles| | |`--mimetypes` |Path to a .types file for custom mimetype definition| | |`-h` or `--help` |Print this list and exit. | |