Better more complete fix for allowing filename to set date and slug #3762

maxandersen · 2017-08-01T20:36:49Z

This is a better and more complete PR for #3310 which:

has actual working tests :)
uses a single boolean to decide if should enable filename as fallback or not
(this allows us to add if needed more and more complex parsing of the header rather than lock it down to user specified regex)
also sets the slug so the date is not part of the url

bep · 2017-08-15T08:29:32Z

hugolib/page.go

 			p.Date = fi.ModTime()
 			p.Params["date"] = p.Date
 		}
 	}

+	if p.Date.IsZero() && p.s.Cfg.GetString("useFilenameDateAsFallback") != "" {


useFilenameDateAsFallback is a bool (not a string)

also, I think it should default to true

fixed use of bool and I changed the default to true including updating the docs/commit messages to match.

bep · 2017-08-15T08:31:26Z

hugolib/page.go

 			p.Date = fi.ModTime()
 			p.Params["date"] = p.Date
 		}
 	}

+	if p.Date.IsZero() && p.s.Cfg.GetString("useFilenameDateAsFallback") != "" {
+		dateExp := regexp.MustCompile("(?P<year>\\d{4})\\-(?P<month>\\d{2})\\-(?P<day>\\d{2})-(?P<slug>.*)\\..*")


This regexp looks reasonable slow to compile so it should be pulled out into a variable and reused.

maxandersen · 2017-08-29T08:41:19Z

I've updated with a fix that ensures even if post has no frontmatter dates gets calculated correctly.

Anything else I need to do here to get it merged in ?

maxandersen · 2017-08-29T19:13:21Z

now rebased against master.

maxandersen · 2017-08-29T19:19:31Z

hugolib/page.go

 			return err
 		}
 	}
+	p.updateMetadata()


this is added so when you render pages that are missing frontmatter they don't get more broken than they need to be. Took me ages to figure out that title/slug and lastmod changes were not handled unless I had an explicit title in frontmatter. With this change it at least still sorts and gets rendered somewhat properly.

Removed useFilenameDateAsFallback option and instead check to see if filenameDateFallbackPattern is set. As a result, filenameDateFallbackPattern now defaults to Nil. Added a reference example to the docs to ease copy/paste configuration for a popular YYYY-MM-DD filename format.

Why: * when migrating from systems like jekylla and awestruct to hugo you might have hundreds if not thousands of blog entries using the filename as a way to set the date and slug part of page. i.e. 2017-08-01-my-life-as-a-dog.md would have a date of 2017-08-01 and a url called my-life-as-a-dog.md. This change addreses the need by: * introduce a setting called `useFilenameDateAsFallback` that defaults to true, which will derive date and slug from the filename. * fix bug where adjusting metadata defaults were ignored when page has no frontmatter

maxandersen · 2017-09-09T07:16:07Z

rebased again - hope this can go in soon :)

stale · 2018-01-07T07:50:15Z

This issue has been automatically marked as stale because it has not had recent activity. The resources of the Hugo team are limited, and so we are asking for your help.
If this is a bug and you can still reproduce this error on the master branch, please reply with all of the information you have about it in order to keep the issue open.
If this is a feature request, and you feel that it is still relevant and valuable, please tell us why.
This issue will automatically be closed in the near future if no further activity occurs. Thank you for all your contributions.

maxandersen · 2018-01-17T20:17:09Z

this is still relevant - just awaiting for update on it from dev.

vassudanagunta · 2018-01-22T12:49:45Z

This takes away the flexibility of @devjack's PR #3310, hardcoding the filename pattern. I think that's the wrong direction to go. I'm going to offer Yet Another Take when I get the chance in the next few of days.

BTW, the four component commits in this PR are strange. The first only has the second half of @devjack's PR, the third is attributed to @bep and has a diff of +38 −14,450, and the final attributed to @maxandersen has a diff of +14,574 −14. 😮

maxandersen · 2018-01-22T14:29:57Z

the flexibility about customizing pattern was taken away to make the initial feature simpler and avoid overengineering it.

bep · 2018-01-22T14:40:59Z

This takes away the flexibility of @devjack's PR #3310, hardcoding the filename pattern.

This only works if it is simple. Both to document/explain and to maintain/test and it makes your content as portable as possible. So one filename pattern it is.

I'm sorry for neglecting this issue for so long. I don't need it myself, but I understand that many others are. I have added the tracking issue to the 0.35 milestone. Let's see if we can agree on a solution by then.

This commit adds a new config option which, when enabled and no date is set in front matter, will make Hugo try to parse the date from the content filename. Also, the filenames in these cases will make for very poor permalinks, so we will also use the remaining part as the page `slug` if that value is not set in front matter. This should make it easier to move content from Jekyll to Hugo. To enable, put this in your `config.toml`: [frontmatter] dateFallbacks = ["filename"] Fixes gohugoio#285 Closes gohugoio#3310 Closes gohugoio#3762

This commit adds a new config option which, when enabled and no date is set in front matter, will make Hugo try to parse the date from the content filename. Also, the filenames in these cases will make for very poor permalinks, so we will also use the remaining part as the page `slug` if that value is not set in front matter. This should make it easier to move content from Jekyll to Hugo. To enable, put this in your `config.toml`: ```toml [frontmatter] dateFallbacks = ["filename"] ``` Fixes gohugoio#285 Closes gohugoio#3310 Closes gohugoio#3762

This commit adds a new config option which, when enabled and no date is set in front matter, will make Hugo try to parse the date from the content filename. Also, the filenames in these cases will make for very poor permalinks, so we will also use the remaining part as the page `slug` if that value is not set in front matter. This should make it easier to move content from Jekyll to Hugo. To enable, put this in your `config.toml`: ```toml [frontmatter] defaultDate = ["filename"] ``` Fixes gohugoio#285 Closes gohugoio#3310 Closes gohugoio#3762

This commit adds a new config option which, when enabled and no date is set in front matter, will make Hugo try to parse the date from the content filename. Also, the filenames in these cases will make for very poor permalinks, so we will also use the remaining part as the page `slug` if that value is not set in front matter. This should make it easier to move content from Jekyll to Hugo. To enable, put this in your `config.toml`: ```toml [frontmatter] defaultDate = ["filename"] ``` Fixes gohugoio#285 Closes gohugoio#3310 Closes gohugoio#3762 Closes gohugoio#4340

This commit adds a new config option which, when enabled and no date is set in front matter, will make Hugo try to parse the date from the content filename. Also, the filenames in these cases will make for very poor permalinks, so we will also use the remaining part as the page `slug` if that value is not set in front matter. This should make it easier to move content from Jekyll to Hugo. To enable, put this in your `config.toml`: ```toml [frontmatter] date = [":filename", "date"] ``` This commit also creates a testable unit from the date front matter handling. We should try to get `:git` as a keyword in the same config map, but that will have to wait for a later time. Fixes gohugoio#285 Closes gohugoio#3310 Closes gohugoio#3762 Closes gohugoio#4340

This commit adds a new config option which, when enabled and no date is set in front matter, will make Hugo try to parse the date from the content filename. Also, the filenames in these cases will make for very poor permalinks, so we will also use the remaining part as the page `slug` if that value is not set in front matter. This should make it easier to move content from Jekyll to Hugo. To enable, put this in your `config.toml`: ```toml [frontmatter] date = [":filename", "date"] ``` This commit also creates a testable unit from the date front matter handling. We should try to get `:git` as a keyword in the same config map, but that will have to wait for a later time. So, if you want to use the `file modification time`, this can be a good configuration: ```toml [frontmatter] date = [ "date",":fileModTime"] lastMod = ["lastMod" ,":fileModTime", "date"] ``` The current config (what you get when doing nothing): ```toml [frontmatter] date = ["date","publishDate", "lastmod"] lastmod = ["lastmod", "date","publishDate"] publishDate = ["publishDate", "date"] expiryDate = ["expiryDate"] ``` Note: * We have some built-in aliases to the above: lastmod => modified, publishDate => pubdate, published and expiryDate => unpublishdate. * If you want a new configuration for, say, `date`, you can provide only that line, and the rest will be preserved. * All the keywords to the right that does not start with a ":" maps to front matter parameters, and can be any date param (e.g. `myCustomDateParam`).. Fixes gohugoio#285 Closes gohugoio#3310 Closes gohugoio#3762 Closes gohugoio#4340

This commit adds a new config option which, when enabled and no date is set in front matter, will make Hugo try to parse the date from the content filename. Also, the filenames in these cases will make for very poor permalinks, so we will also use the remaining part as the page `slug` if that value is not set in front matter. This should make it easier to move content from Jekyll to Hugo. To enable, put this in your `config.toml`: ```toml [frontmatter] date = [":filename", "date"] ``` This commit also creates a testable unit from the date front matter handling. We should try to get `:git` as a keyword in the same config map, but that will have to wait for a later time. So, if you want to use the `file modification time`, this can be a good configuration: ```toml [frontmatter] date = [ "date",":fileModTime"] lastMod = ["lastMod" ,":fileModTime", "date"] ``` The current config (what you get when doing nothing): ```toml [frontmatter] date = ["date","publishDate", "lastmod"] lastmod = ["lastmod", "date","publishDate"] publishDate = ["publishDate", "date"] expiryDate = ["expiryDate"] ``` Note: * We have some built-in aliases to the above: lastmod => modified, publishDate => pubdate, published and expiryDate => unpublishdate. * If you want a new configuration for, say, `date`, you can provide only that line, and the rest will be preserved. * All the keywords to the right that does not start with a ":" maps to front matter parameters, and can be any date param (e.g. `myCustomDateParam`). Fixes gohugoio#285 Closes gohugoio#3310 Closes gohugoio#3762 Closes gohugoio#4340

This commit adds a new config option which, when enabled and no date is set in front matter, will make Hugo try to parse the date from the content filename. Also, the filenames in these cases will make for very poor permalinks, so we will also use the remaining part as the page `slug` if that value is not set in front matter. This should make it easier to move content from Jekyll to Hugo. To enable, put this in your `config.toml`: ```toml [frontmatter] date = [":filename", "date"] ``` This commit also creates a testable unit from the date front matter handling. We should try to get `:git` as a keyword in the same config map, but that will have to wait for a later time. So, if you want to use the `file modification time`, this can be a good configuration: ```toml [frontmatter] date = [ "date",":fileModTime"] lastMod = ["lastMod" ,":fileModTime", "date"] ``` The current config (what you get when doing nothing): ```toml [frontmatter] date = ["date","publishDate", "lastmod"] lastmod = ["lastmod", "date","publishDate"] publishDate = ["publishDate", "date"] expiryDate = ["expiryDate"] ``` Note: * We have some built-in aliases to the above: lastmod => modified, publishDate => pubdate, published and expiryDate => unpublishdate. * If you want a new configuration for, say, `date`, you can provide only that line, and the rest will be preserved. * All the keywords to the right that does not start with a ":" maps to front matter parameters, and can be any date param (e.g. `myCustomDateParam`). * The keywords to the left are the **4 predefined dates in Hugo**, i.e. they are constant values. Fixes gohugoio#285 Closes gohugoio#3310 Closes gohugoio#3762 Closes gohugoio#4340

This commit adds a new config option which, when enabled and no date is set in front matter, will make Hugo try to parse the date from the content filename. Also, the filenames in these cases will make for very poor permalinks, so we will also use the remaining part as the page `slug` if that value is not set in front matter. This should make it easier to move content from Jekyll to Hugo. To enable, put this in your `config.toml`: ```toml [frontmatter] date = [":filename", ":default"] ``` This commit is also a spring cleaning of how the different dates are configured in Hugo. So, if you want to use the `file modification time`, this can be a good configuration: ```toml [frontmatter] date = [ "date",":fileModTime", ":default"] lastMod = ["lastMod" ,":fileModTime", ":default"] ``` The current `:default` values for the different dates are ```toml [frontmatter] date = ["date","publishDate", "lastmod"] lastmod = ["lastmod", "date","publishDate"] publishDate = ["publishDate", "date"] expiryDate = ["expiryDate"] ``` The above will now be the same as: ```toml [frontmatter] date = [":default"] lastmod = [":default"] publishDate = [":default"] expiryDate = [":default"] ``` Note: * We have some built-in aliases to the above: lastmod => modified, publishDate => pubdate, published and expiryDate => unpublishdate. * If you want a new configuration for, say, `date`, you can provide only that line, and the rest will be preserved. * All the keywords to the right that does not start with a ":" maps to front matter parameters, and can be any date param (e.g. `myCustomDateParam`). * The keywords to the left are the **4 predefined dates in Hugo**, i.e. they are constant values. * The current "special date handlers" are `:fileModTime` and `:filename`. We will soon add `:git` to that list. Fixes gohugoio#285 Closes gohugoio#3310 Closes gohugoio#3762 Closes gohugoio#4340

This commit makes it possible to extract the date from the content filename. Also, the filenames in these cases will make for very poor permalinks, so we will also use the remaining part as the page `slug` if that value is not set in front matter. This should make it easier to move content from Jekyll to Hugo. To enable, put this in your `config.toml`: ```toml [frontmatter] date = [":filename", ":default"] ``` This commit is also a spring cleaning of how the different dates are configured in Hugo. So, if you want to use the `file modification time`, this can be a good configuration: ```toml [frontmatter] date = [ "date",":fileModTime", ":default"] lastMod = ["lastMod" ,":fileModTime", ":default"] ``` The current `:default` values for the different dates are ```toml [frontmatter] date = ["date","publishDate", "lastmod"] lastmod = ["lastmod", "date","publishDate"] publishDate = ["publishDate", "date"] expiryDate = ["expiryDate"] ``` The above will now be the same as: ```toml [frontmatter] date = [":default"] lastmod = [":default"] publishDate = [":default"] expiryDate = [":default"] ``` Note: * We have some built-in aliases to the above: lastmod => modified, publishDate => pubdate, published and expiryDate => unpublishdate. * If you want a new configuration for, say, `date`, you can provide only that line, and the rest will be preserved. * All the keywords to the right that does not start with a ":" maps to front matter parameters, and can be any date param (e.g. `myCustomDateParam`). * The keywords to the left are the **4 predefined dates in Hugo**, i.e. they are constant values. * The current "special date handlers" are `:fileModTime` and `:filename`. We will soon add `:git` to that list. Fixes gohugoio#285 Closes gohugoio#3310 Closes gohugoio#3762 Closes gohugoio#4340

This commit makes it possible to extract the date from the content filename. Also, the filenames in these cases will make for very poor permalinks, so we will also use the remaining part as the page `slug` if that value is not set in front matter. This should make it easier to move content from Jekyll to Hugo. To enable, put this in your `config.toml`: ```toml [frontmatter] date = [":filename", ":default"] ``` This commit is also a spring cleaning of how the different dates are configured in Hugo. Hugo will check for dates following the configuration from left to right, starting with `:filename` etc. So, if you want to use the `file modification time`, this can be a good configuration: ```toml [frontmatter] date = [ "date",":fileModTime", ":default"] lastMod = ["lastMod" ,":fileModTime", ":default"] ``` The current `:default` values for the different dates are ```toml [frontmatter] date = ["date","publishDate", "lastmod"] lastmod = ["lastmod", "date","publishDate"] publishDate = ["publishDate", "date"] expiryDate = ["expiryDate"] ``` The above will now be the same as: ```toml [frontmatter] date = [":default"] lastmod = [":default"] publishDate = [":default"] expiryDate = [":default"] ``` Note: * We have some built-in aliases to the above: lastmod => modified, publishDate => pubdate, published and expiryDate => unpublishdate. * If you want a new configuration for, say, `date`, you can provide only that line, and the rest will be preserved. * All the keywords to the right that does not start with a ":" maps to front matter parameters, and can be any date param (e.g. `myCustomDateParam`). * The keywords to the left are the **4 predefined dates in Hugo**, i.e. they are constant values. * The current "special date handlers" are `:fileModTime` and `:filename`. We will soon add `:git` to that list. Fixes gohugoio#285 Closes gohugoio#3310 Closes gohugoio#3762 Closes gohugoio#4340

This commit makes it possible to extract the date from the content filename. Also, the filenames in these cases will make for very poor permalinks, so we will also use the remaining part as the page `slug` if that value is not set in front matter. This should make it easier to move content from Jekyll to Hugo. To enable, put this in your `config.toml`: ```toml [frontmatter] date = [":filename", ":default"] ``` This commit is also a spring cleaning of how the different dates are configured in Hugo. Hugo will check for dates following the configuration from left to right, starting with `:filename` etc. So, if you want to use the `file modification time`, this can be a good configuration: ```toml [frontmatter] date = [ "date",":fileModTime", ":default"] lastmod = ["lastmod" ,":fileModTime", ":default"] ``` The current `:default` values for the different dates are ```toml [frontmatter] date = ["date","publishDate", "lastmod"] lastmod = ["lastmod", "date","publishDate"] publishDate = ["publishDate", "date"] expiryDate = ["expiryDate"] ``` The above will now be the same as: ```toml [frontmatter] date = [":default"] lastmod = [":default"] publishDate = [":default"] expiryDate = [":default"] ``` Note: * We have some built-in aliases to the above: lastmod => modified, publishDate => pubdate, published and expiryDate => unpublishdate. * If you want a new configuration for, say, `date`, you can provide only that line, and the rest will be preserved. * All the keywords to the right that does not start with a ":" maps to front matter parameters, and can be any date param (e.g. `myCustomDateParam`). * The keywords to the left are the **4 predefined dates in Hugo**, i.e. they are constant values. * The current "special date handlers" are `:fileModTime` and `:filename`. We will soon add `:git` to that list. Fixes gohugoio#285 Closes gohugoio#3310 Closes gohugoio#3762 Closes gohugoio#4340

github-actions · 2022-02-06T02:03:22Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

maxandersen force-pushed the devjack-filename-date-fallback branch 2 times, most recently from caaec55 to 903bdef Compare August 1, 2017 20:42

bep requested changes Aug 15, 2017

View reviewed changes

maxandersen force-pushed the devjack-filename-date-fallback branch from 903bdef to b79112a Compare August 17, 2017 09:54

maxandersen force-pushed the devjack-filename-date-fallback branch 2 times, most recently from d779ebc to e9417dc Compare August 29, 2017 19:08

maxandersen force-pushed the devjack-filename-date-fallback branch 3 times, most recently from 74addc9 to dfa3673 Compare August 29, 2017 19:17

maxandersen commented Aug 29, 2017

View reviewed changes

bep requested a review from moorereason August 31, 2017 08:29

bep approved these changes Aug 31, 2017

View reviewed changes

This was referenced Sep 4, 2017

Use filename as title when it’s not defined in front matter #3805

Open

use filename or title header when not defined in frontmatter #3859

Closed

bep and others added 4 commits September 9, 2017 09:09

release: CGO_ENABLED=0

5aacbb6

fix rebased docs and add debug info

2ec62cc

maxandersen force-pushed the devjack-filename-date-fallback branch from dfa3673 to 7e6ca8b Compare September 9, 2017 07:15

stale bot added the Stale label Jan 7, 2018

stale bot removed the Stale label Jan 17, 2018

bep added this to the v0.35 milestone Jan 22, 2018

vassudanagunta mentioned this pull request Jan 28, 2018

Design Proposal: defaultDate & defaultTitle #4341

Closed

bep mentioned this pull request Mar 11, 2018

hugolib: Extract date and slug from filename #4494

Merged

bep closed this in #4494 Mar 11, 2018

dependencies bot mentioned this pull request Apr 2, 2018

Update https://github.com/gohugoio/hugo in repo_dependencies.yml from v0.37 to v0.38 matrixik/dobek.pro#14

Closed

github-actions bot locked as resolved and limited conversation to collaborators Feb 6, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Better more complete fix for allowing filename to set date and slug #3762

Better more complete fix for allowing filename to set date and slug #3762

maxandersen commented Aug 1, 2017 •

edited

Loading

bep Aug 15, 2017

maxandersen Aug 17, 2017

bep Aug 15, 2017

maxandersen Aug 17, 2017

maxandersen commented Aug 29, 2017

maxandersen commented Aug 29, 2017

maxandersen Aug 29, 2017

maxandersen commented Sep 9, 2017

stale bot commented Jan 7, 2018

maxandersen commented Jan 17, 2018

vassudanagunta commented Jan 22, 2018 •

edited

Loading

maxandersen commented Jan 22, 2018

bep commented Jan 22, 2018

github-actions bot commented Feb 6, 2022

Better more complete fix for allowing filename to set date and slug #3762

Better more complete fix for allowing filename to set date and slug #3762

Conversation

maxandersen commented Aug 1, 2017 • edited Loading

bep Aug 15, 2017

Choose a reason for hiding this comment

maxandersen Aug 17, 2017

Choose a reason for hiding this comment

bep Aug 15, 2017

Choose a reason for hiding this comment

maxandersen Aug 17, 2017

Choose a reason for hiding this comment

maxandersen commented Aug 29, 2017

maxandersen commented Aug 29, 2017

maxandersen Aug 29, 2017

Choose a reason for hiding this comment

maxandersen commented Sep 9, 2017

stale bot commented Jan 7, 2018

maxandersen commented Jan 17, 2018

vassudanagunta commented Jan 22, 2018 • edited Loading

maxandersen commented Jan 22, 2018

bep commented Jan 22, 2018

github-actions bot commented Feb 6, 2022

maxandersen commented Aug 1, 2017 •

edited

Loading

vassudanagunta commented Jan 22, 2018 •

edited

Loading