Allow additional front matter for Post #41

toshimaru · 2016-05-14T17:16:19Z

Currently, jekyll-compose post command generates only layout and title as front matter, but I'd like to add more front matters. For example:

---
layout: post
title: Blogging Like a Hacker
published: true
description: 
category: 

---

This PR adds feature that allows addtional front matter loaded from Jekyll's _config.yml for jekyll post command.

_config.yml sample is like:

# _config.yml

# jekyll-compose
jekyll_compose:
  post_default_front_matter:
    published: true
    foo: bar
    category:

mofhu · 2016-07-16T14:31:10Z

Thanks a lot @toshimaru . In fact, I'm writing a short blog introducing jekyll-compose and was wondering if this feature may be added 😄

mvdmakesthings · 2016-10-10T14:16:40Z

I'd LOVE to see this feature merged in.

able to add draft and post front matter in _config.yml in Jekyll directory. adopted from toshimaru's PR (jekyll#41)

hassek · 2017-04-23T05:03:52Z

@codethebeard Totally, I installed this package and immediately though of this feature!

mpchadwick · 2017-07-25T16:52:18Z

+1 to this feature. This project is not particularly useful without it for me.

DirtyF · 2017-10-13T18:36:33Z

@pathawks this seems complementary to #43

pathawks · 2017-10-13T19:15:56Z

There was some online interface I saw once that allowed default YAML for posts to be stored in a way similar to this. Does that ring a bell for anybody?

If somebody out there is already doing this, we should make sure that the way we do it is complementary to that.

DirtyF · 2017-11-14T17:39:54Z

@pathawks rather than adding extra options, I think jeyll-compose should use defaults defined in the config

pathawks · 2017-11-14T20:25:38Z

I’m not sure about this.
We have added post defaults to aid this, but defaults will be overridden if each post contains a key with just an empty string.

Seems best to leave it to the authors to add only what is needed. I would argue that maybe we should stop adding layout

toshimaru · 2017-11-15T01:43:55Z

Almost all of my posts have different description which should be configured in my jekyll site, so additional configuration will be worth it in case I forget writing description in the post.

jeyll-compose should use defaults defined in the config

Might be a good idea, but I'd like to configure post default setting separately because it has a value for the layout, not for the post.

hmistry · 2017-11-29T19:01:58Z

LGTM please!!! I hope this is also added to the draft command.

I'm really surprised that this capability was left out because, as others have pointed out, it's expected or very, very high on the want list. It's the main reason why I bothered to search for this plugin.

I agree with @toshimaru original approach - have a full list of common defaults, prefilled where applicable with sensible values, and allow user to configure in the _config.yml file. To me, this is equivalent to rails generate scaffold posts where it generates a complete set of templates and I modify/delete things accordingly. If rails g scaffold only created an index action and views, then it would be kind of useless by not saving the dev time from having to lookup/copy files - deleting is faster than looking up. Same goes for the draft and post command for jekyll.

parkr · 2018-01-14T20:49:25Z

lib/jekyll/commands/post.rb

@@ -53,6 +53,11 @@ def file_name
        def _date_stamp
          @params.date.strftime '%Y-%m-%d'
        end
+
+        def content
+          post_front_matter = Jekyll.configuration["post_front_matter"]


Let's use a different configuration key here. I'd love to keep things organized under compose. What about:

compose: post_default_front_matter: my: keys go: here

Top-level keys often conflict with user-specific values and it's nice to keep a plugin's keys all under one namespace.

jekyll_compose is used as a top-level namespace, so I use the same naming.

toshimaru · 2018-10-07T16:19:29Z

@DirtyF fixed conflict. Could you review? cc/ @pathawks @parkr

DirtyF

LGTM, as jekyll_compose is already used as configuration key by auto_open.

ashmaroli

@toshimaru This would benefit from some minor changes..

ashmaroli · 2018-10-07T17:18:55Z

lib/jekyll/commands/post.rb

+        private
+
+        def jekyll_compose_config
+          @jekyll_compose_config ||= Jekyll.configuration["jekyll_compose"]


Let's default the config to a hash so that we can avoid a nil check in method #content above:

# Returns a Hash def compose_config @compose_config ||= Jekyll.configuration["jekyll_compose"] || {} end

This has been adressed in #76

ashmaroli · 2018-10-07T17:29:44Z

lib/jekyll/commands/post.rb

@@ -64,8 +64,18 @@ def _time_stamp
        end

        def content(custom_front_matter = {})
+          if jekyll_compose_config && jekyll_compose_config["post_default_front_matter"]
+            custom_front_matter.merge!(jekyll_compose_config["post_default_front_matter"])


Let's merge! only a valid config:

def content(custom_front_matter = {}) default_front_matter = compose_config["post_default_front_matter"] custom_front_matter.merge!(default_front_matter) if default_front_matter.is_a?(Hash) super({ "date" => _time_stamp }.merge(custom_front_matter)) end

toshimaru · 2018-10-08T16:47:00Z

@ashmaroli thanks for your review, fixed!!

ashmaroli · 2018-10-08T16:54:50Z

@toshimaru Thank you for addressing my concerns.
The maintainers have decided to avoid using Jekyll.configuration to get the config data and instead use the configuration_from_options method from the superclass.

You may refer #76 for more details regarding the proposed change

toshimaru · 2018-10-09T01:29:12Z

@ashmaroli So, should I wait until #76 get merged?

DirtyF · 2018-10-09T07:43:19Z

@toshimaru We'll deal with jekyll.configuration in #76, thanks for this useful feature.

@jekyllbot: merge +minor

DirtyF · 2018-10-18T12:51:55Z

Note: this does not currently work for drafts.

mofhu added a commit to mofhu/jekyll-compose that referenced this pull request Mar 5, 2017

Add draft and post front matter support.

853caf1

able to add draft and post front matter in _config.yml in Jekyll directory. adopted from toshimaru's PR (jekyll#41)

DirtyF requested review from courajs and pathawks October 13, 2017 18:33

courajs removed their request for review October 14, 2017 13:39

DirtyF requested a review from a team January 14, 2018 20:20

parkr reviewed Jan 14, 2018

View reviewed changes

DirtyF mentioned this pull request May 25, 2018

Time for a new release #70

Closed

DirtyF added the pending-rebase label Sep 26, 2018

toshimaru added 4 commits October 7, 2018 23:20

Load additional front matter from config.yml

4b0ea12

Check front matter is nil

40d3ffc

Add fixture

5c4289d

Add test

8195ded

toshimaru force-pushed the feature/post-template branch from 005b2af to 8195ded Compare October 7, 2018 14:22

jekyllbot removed the pending-rebase label Oct 7, 2018

merge post_default_front_matter config setting

37355c5

toshimaru force-pushed the feature/post-template branch from fe54470 to 557eb97 Compare October 7, 2018 15:53

Modify spec

a653e4a

toshimaru force-pushed the feature/post-template branch from 557eb97 to a653e4a Compare October 7, 2018 16:10

DirtyF requested a review from a team October 7, 2018 16:58

DirtyF removed the request for review from pathawks October 7, 2018 16:59

DirtyF approved these changes Oct 7, 2018

View reviewed changes

DirtyF added this to the 0.9.0 milestone Oct 7, 2018

DirtyF added the feature label Oct 7, 2018

ashmaroli requested changes Oct 7, 2018

View reviewed changes

Check if default_front_matter is Hash

84a1f91

jekyllbot merged commit 14e6e54 into jekyll:master Oct 9, 2018

jekyllbot added the enhancement label Oct 9, 2018

jekyllbot added a commit that referenced this pull request Oct 9, 2018

Update history to reflect merge of #41 [ci skip]

7aab81a

DirtyF mentioned this pull request Oct 9, 2018

Simply use compose as main key configuration #78

Closed

toshimaru deleted the feature/post-template branch October 10, 2018 06:46

jekyll locked and limited conversation to collaborators Oct 18, 2019

jekyllbot added the frozen-due-to-age label Oct 18, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow additional front matter for Post #41

Allow additional front matter for Post #41

toshimaru commented May 14, 2016 •

edited

mofhu commented Jul 16, 2016

mvdmakesthings commented Oct 10, 2016

hassek commented Apr 23, 2017

mpchadwick commented Jul 25, 2017

DirtyF commented Oct 13, 2017

pathawks commented Oct 13, 2017

DirtyF commented Nov 14, 2017

pathawks commented Nov 14, 2017

toshimaru commented Nov 15, 2017

hmistry commented Nov 29, 2017

parkr Jan 14, 2018

toshimaru Oct 7, 2018

toshimaru commented Oct 7, 2018

DirtyF left a comment •

edited

ashmaroli left a comment

ashmaroli Oct 7, 2018

DirtyF Oct 8, 2018

ashmaroli Oct 7, 2018

toshimaru commented Oct 8, 2018

ashmaroli commented Oct 8, 2018

toshimaru commented Oct 9, 2018

DirtyF commented Oct 9, 2018 •

edited

DirtyF commented Oct 18, 2018

Allow additional front matter for Post #41

Allow additional front matter for Post #41

Conversation

toshimaru commented May 14, 2016 • edited

mofhu commented Jul 16, 2016

mvdmakesthings commented Oct 10, 2016

hassek commented Apr 23, 2017

mpchadwick commented Jul 25, 2017

DirtyF commented Oct 13, 2017

pathawks commented Oct 13, 2017

DirtyF commented Nov 14, 2017

pathawks commented Nov 14, 2017

toshimaru commented Nov 15, 2017

hmistry commented Nov 29, 2017

parkr Jan 14, 2018

Choose a reason for hiding this comment

toshimaru Oct 7, 2018

Choose a reason for hiding this comment

toshimaru commented Oct 7, 2018

DirtyF left a comment • edited

Choose a reason for hiding this comment

ashmaroli left a comment

Choose a reason for hiding this comment

ashmaroli Oct 7, 2018

Choose a reason for hiding this comment

DirtyF Oct 8, 2018

Choose a reason for hiding this comment

ashmaroli Oct 7, 2018

Choose a reason for hiding this comment

toshimaru commented Oct 8, 2018

ashmaroli commented Oct 8, 2018

toshimaru commented Oct 9, 2018

DirtyF commented Oct 9, 2018 • edited

DirtyF commented Oct 18, 2018

toshimaru commented May 14, 2016 •

edited

DirtyF left a comment •

edited

DirtyF commented Oct 9, 2018 •

edited