Add show_dir_listing option for serve command and fix index file names #4533
Conversation
|
Well, this is awkward (tests failing, I mean). I'm pretty sure it's caused by the execution order since changing the random seed makes it pass and setting it to the value that Travis used makes it fail. My first look at the problem was unfruitful but I'll give it another shot. |
|
The latest commit emulates GitHub Pages by returning an error when trying to list directory contents in WEBrick unless it's made clear that the user intends to override that behavior in a dev environment with the There's that, plus I kinda wanted to take another roll of the dice with Travis CI. 😉 |
| WEBrick::Config::FileHandler.merge({ | ||
| :FancyIndexing => true, | ||
| :FancyIndexing => opts['show_dir_listing'] ? true : false, |
There was a problem hiding this comment.
Shouldn't this be flipped? Only do fancy indexing if show_dir_listing is false?
There was a problem hiding this comment.
No @parkr, a "fancy" index in WEBrick-speak turns out to mean showing the contents of the directory when no index is present, which is what I'm trying to do. This is affirmed by the tests.
Anyway, @envygeeks made a good point about not changing behavior for a point release so I was planning to revert it anyway, so as not to hold up the merge. I thought of it as more of a bug fix based on what you were saying about parity with GHP. You decide.
There was a problem hiding this comment.
@hgoodman FancyIndexing by default was a conscious disparity between production and development to enforce WEBrick only being dev quality (as used by us) and to discourage the many users we (or maybe just me?) heard about using it in production. People dislike directory indexing in production unless it's for a download folder which helps us let them know this is not meant for production by any means.
There was a problem hiding this comment.
Right on, @envygeeks, I don't like it in production either and as I said, I'm planning on reverting it later.
hgoodman
force-pushed
the
feature/show-dir-listing
branch
from
9d0b659
to
d387fd0
Compare
|
I rolled back the index file changes and rebased the branch. Let me know if there's anything else I can do to improve index file handling. Thank you for the thorough review! |
|
👍 |
|
LGTM. Thanks for the PR and thanks for your thorough work! Will merge once we have 3.1.2 out. |
|
@jekyllbot: merge +minor |
* origin/master: (65 commits) Update history to reflect merge of #4703 [ci skip] Update history to reflect merge of #4712 [ci skip] Highlight the test code Update history to reflect merge of #4640 [ci skip] readded "env=prod"-condition Update history to reflect merge of #3849 [ci skip] Update history to reflect merge of #4624 [ci skip] Update history to reflect merge of #4704 [ci skip] Update history to reflect merge of #4706 [ci skip] Checks for link file extension in tests Updating assets documentation Fix test teardown for cleaner. Update history to reflect merge of #4542 [ci skip] Add explanation of site variables in the example _config.yml Use double quotes in the gemfile Add test for creation of Gemfile by 'jekyll new' Add comment about github-pages Update history to reflect merge of #4533 [ci skip] Ensure Rouge closes its div/figure properly after highlighting ends. Add Site#config= which can be used to set the config ...
This is a replacement for PR /pull/4503, which I will close momentarily.
This PR adds the
--show-dir-listingCLI option, which can also be included in the config asshow_dir_listing, to show the WEBrick default directory listing instead of loading an index file (e.g. index.html). When testing, I find it much more convenient to be able to navigate to a specific file by clicking through a directory list instead of typing in the file name (which may not be linked from index.html).This PR also fixes the default directory index file list to maintain parity with the file names supported by GitHub Pages (I tested to verify that the order is correct).
I changed the negative option
--no-directory-indexfrom PR /pull/4503 to the affirmative--show-dir-listingfor the sake of clarity and also because I noticed that GitHub Pages gives its own 404 page when an index file is not present.