Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature: add option "serveIndex" to enable/disable serveIndex middleware #1752

Merged
merged 12 commits into from
Apr 5, 2019
Merged

Feature: add option "serveIndex" to enable/disable serveIndex middleware #1752

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
c3fc4a7
add option serveIndex
EslamHiko Apr 1, 2019
325c5cb
setting the default option serveIndex value to be true
EslamHiko Apr 2, 2019
c3e4aca
add/remove contentBaseIndex feature to/from defaultFeatures using ser…
EslamHiko Apr 3, 2019
e426144
remove typeof and compare the option value directly with undefined
EslamHiko Apr 3, 2019
bee7cbc
add the option with the default value to options.js & simplifying the…
EslamHiko Apr 3, 2019
88a9252
setting options.serveIndex to a seperate variable
EslamHiko Apr 3, 2019
43337af
add Tests
EslamHiko Apr 3, 2019
f367fda
add Test case where you have a folder with index.html inside of it
EslamHiko Apr 3, 2019
bd56fdc
Merge branch 'master' into add-serve-index-option
evilebottnawi Apr 4, 2019
4c33da3
add (folder with index.html inside it) test case to serveIndex:true &…
EslamHiko Apr 5, 2019
dd3bafe
Merge branch 'add-serve-index-option' of https://github.com/EslamHiko…
EslamHiko Apr 5, 2019
f29502f
Merge branch 'master' into add-serve-index-option
evilebottnawi Apr 5, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions bin/options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ const options = {
type: 'boolean',
describe: 'Lazy',
},
serveIndex: {
type: 'boolean',
describe: 'Enables/Disables serveIndex middleware',
default: true,
},
inline: {
type: 'boolean',
default: true,
Expand Down
8 changes: 7 additions & 1 deletion lib/Server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,9 +551,15 @@ class Server {

defaultFeatures.push('magicHtml');

if (contentBase !== false) {
// checking if it's set to true or not set (Default : undefined => true)
options.serveIndex = options.serveIndex || options.serveIndex === undefined;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Better avoid modify options because code below also can use options and modification original options is not good idea better keep this in separate variable, it is good practice.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@evilebottnawi thank you for the advice, I set the option value to a separate variable this.serveIndex


const shouldHandleServeIndex = contentBase && options.serveIndex;

if (shouldHandleServeIndex) {
defaultFeatures.push('contentBaseIndex');
}

// compress is placed last and uses unshift so that it will be the first middleware used
if (options.compress) {
defaultFeatures.unshift('compress');
Expand Down
3 changes: 3 additions & 0 deletions lib/options.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
{
"type": "object",
"properties": {
"serveIndex": {
"type": "boolean"
},
"hot": {
"type": "boolean"
},
Expand Down