The issue has been solved

Refactor the page interface #332

egoist posted onGitHub

https://saber.land/docs/page-interface.html

We should not reuse the page.attributes object, i.e. setting a new page.permalink property instead of overriding page.attributes.permalink

Currently the behavior is inconsistent, sometimes we use page.attributes.permalink the other times we use page.excerpt 😅

Basically we will keep page.attributes which is set by front matter or export const attributes = {}, instead of modifying page.attributes we should infer page from page.attributes and other information, e.g. page.slug is inferred from page.attributes.slug and the filename.

This will introduce breaking changes.

@issuehunt has funded $100.00 to this issue.

Submit pull request via IssueHunt to receive this reward.
Want to contribute? Chip in to this issue via IssueHunt.
Checkout the IssueHunt Issue Explorer to see more funded issues.
Need help from developers? Add your repository on IssueHunt to raise funds.

posted by issuehunt-app[bot] over 5 years ago

Hi, can I work on this? I’ve used Saber for a few weeks and really like it.

posted by saltysugar over 5 years ago

@saltysugar Sure, if having any questions, feel free to ask.

saltysugar notifications@github.com 于 2019年7月21日周日上午12:18写道：

Hi, can I work on this? I’ve used Saber for a few weeks and really like it.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/saberland/saber/issues/332?email_source=notifications&email_token=ACDAWSHNL77UAB7WIGQV6Z3QAM3GJA5CNFSM4IDV4242YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD2NRM6Y#issuecomment-513480315, or mute the thread https://github.com/notifications/unsubscribe-auth/ACDAWSFY53ZZCM4UL4FWKUTQAM3GJANCNFSM4IDV424Q .

posted by egoist over 5 years ago

Hmm I'm thinking about making this more similar to Jekyll:

The page variable in Jekyll is simply page specific information + front matter, i.e. custom variables set via the front matter will be available on page.

Here in Saber, we can have a page object like this:

interface Page {
   // merge front matter into this
  [key: string]: any
  internal: {
    id: string
    parent?: string
  }
  content?: string
  contentType?: string
}

This is easy to migrate to, just change all your page.attributes.foo to page.foo, however for plugins like saber-plugin-query-posts, we need to rename injected variables like page.tags and page.categories to something else, since they might already be set by front matter now.

posted by egoist over 5 years ago

@egoist has rewarded $70.00 to @saltysugar. See it on IssueHunt