Replace default swig engine with nunjucks #2903

thom4parisot · 2017-12-11T20:26:55Z

It feels reasonable to remove swig due to its deprecation and various issues reporting it: #2895, #1593, #1625, #1915, #2295

This PR aims to:

remove all calls to swig and swig-extras
choice 1, replacing swig with nunjucks as a native renderer (and then processing .njk files)
or choice 2, delegating the rendering to an external renderer (hexo-renderer-swig to opt-in for legacy themes, hexo-renderer-j2 or hexo-render-nunjucks or hexo-renderer-nunjucks2 etc. to opt-in for nunjucks)
~~ensure default theme iissnan/hexo-theme-next is compatible with the outcome of this PR~~ theme-next now embeds its own flavour of nunjucks
Set up TravisCI to enable npm publishing
Create a hexo-renderer-nunjucks@v2.0.0 release will publish the updated package.
Commit this code suggestion to rely on hexo-renderer-nunjucks@v2.0.0, as published on npm.

What do you think?

coveralls · 2017-12-11T20:36:42Z

Coverage decreased (-0.2%) to 96.983% when pulling dbabd3b on oncletom:feature/remove-swig into c8d47b8 on hexojs:master.

kovtunos · 2017-12-12T16:18:30Z

Replace swig with nunjucks v3.

thom4parisot · 2017-12-12T21:00:33Z

Thanks @kovtunos.

Shall we still process .swig files with nunjucks? By default I would not do it but project wise, I don't know if it is relevant.

coveralls · 2017-12-13T12:47:07Z

Coverage decreased (-0.4%) to 96.794% when pulling d994d52 on oncletom:feature/remove-swig into c8d47b8 on hexojs:master.

thom4parisot · 2017-12-13T13:09:17Z

At the moment all swig tests seem to pass with nunjucks as a renderer. Except one which is related to the for override (override "for" tag in test/scripts/renderers/swig.js).

The test is ran against this data structure:

var data = {
      arr: {
        toArray() {
          return [1, 2, 3];
        }
      }
    };

Is that something we want to keep? Is that related to a Collection object (like posts) which has a toArray() method to move out of the Warehouse realm?

I would find it less hacky to write {% for post in posts | list %} for example. I would understand we would like to keep a maximum compatibility

coveralls · 2017-12-13T13:15:01Z

Coverage decreased (-0.06%) to 97.17% when pulling 1e85e39 on oncletom:feature/remove-swig into c8d47b8 on hexojs:master.

NoahDragon · 2017-12-16T02:06:55Z

Hi @oncletom , my two cents, we should keep the backward capability. The most popular Hexo theme NexT (https://github.com/iissnan/hexo-theme-next) is still using the swig. However, if the change could work on NexT, then we could merge this change for Hexo 4.

coveralls · 2017-12-17T18:48:48Z

Coverage decreased (-0.03%) to 97.201% when pulling 1478019 on oncletom:feature/remove-swig into c8d47b8 on hexojs:master.

coveralls · 2017-12-17T18:48:48Z

Coverage decreased (-0.03%) to 97.201% when pulling 1478019 on oncletom:feature/remove-swig into c8d47b8 on hexojs:master.

coveralls · 2017-12-17T19:13:11Z

Coverage increased (+0.005%) to 97.231% when pulling 7179a08 on oncletom:feature/remove-swig into c8d47b8 on hexojs:master.

coveralls · 2017-12-17T19:24:16Z

Coverage decreased (-0.02%) to 97.742% when pulling 2cdecbf on oncletom:feature/remove-swig into fd68a1b on hexojs:master.

huiwang · 2018-01-05T17:36:32Z

hi, this is an exciting proposal. it will make it possible to use async helper in themes.

charsi · 2018-01-13T22:18:10Z

The next theme is now hosted here -- https://github.com/theme-next/hexo-theme-next/

NoahDragon · 2018-03-15T02:20:33Z

@oncletom, is this still working in progress?

thom4parisot · 2018-03-15T08:36:37Z

Hi @NoahDragon!

I would say most of the work is done. At the moment nunjucks is configured to handle .swig files but that can be changed/removed/put under a deprecation notice setting.

Next step would be to try it out with hexo-theme-next to make sure it works, either out of the box or with additional fixes.

I don't know if anybody has time to do it, or to test and to report the issues in this thread.

Otherwise let me know if there are any useful pointers to integrate this contribution to the 4.x branch sooner or later 🙂

NoahDragon · 2018-03-15T22:33:12Z

@oncletom Thanks for the update. I will test this change when I have a chance. 😄

djmtype · 2018-06-27T17:42:35Z

What's the status on using Nunjucks? I'm only pointing this out because the official site no longer mentions it along side of pug, ejs, haml and swig. https://hexo.io/docs/themes.html#layout Besides, it seems *.ejs is currently the adopted template language of Hexo.

chenbojian · 2018-12-05T04:42:46Z

it looks like nunjunks is merged to node itself. And it cause some errors to install hexo on node 11.3.0. #3380

tomap · 2018-12-05T07:13:13Z

@chenbojian it's unrelated to this issue

thom4parisot · 2018-12-05T07:16:21Z

Well, I don't know—I can put more efforts into it.

I can also make it a separate plugin if needed and if none already exist to do the job.

Any feedback from the @hexojs team?

yoshinorin · 2018-12-16T04:23:29Z

I can also make it a separate plugin

IMHO, should merge this change and bump up to hexo version to V4. No need separate to plugin.

chawyehsu · 2019-03-05T13:06:15Z

Any progress? @oncletom maybe you need to resolve the conflicts.

chawyehsu · 2019-03-27T11:31:29Z

I found that it's impossible to render swig template with nunjucks engine, since they have minor different syntax, see https://medium.com/engineers-optimizely/js-templating-transitioning-from-swig-to-nunjucks-ac0e94d1794b

Shall we still process .swig files with nunjucks? By default I would not do it but project wise, I don't know if it is relevant.

So either totally remove swig, or don't add nunjucks renderer. You shouldn't render swig with nunjucks.

thom4parisot · 2019-03-27T12:19:26Z

Interesting, thanks for sharing this conclusion.

Shall we not render both of them and make it a separate renderer instead?

thom4parisot · 2020-01-17T15:38:22Z

Sorry, I made a typo: I was not referring to .js files but .j2 files 😅

Switching to Nunjucks was already a breaking change. I have no idea if hexo-renderer-swig is on par with the previously embedded swig rendering. I'm not convinced it is part of the scope of this PR, but I'm happy to open an additional PR to the default hexo-renderer-swig to maintain a feature parity.

SukkaW

LGTM!

Pending hexo-renderer-nunjucks joins hexo official plugins and releases a new version.

@NoahDragon Please add @oncletom to plugin team at GitHub org.

package.json

thom4parisot · 2020-01-23T17:10:52Z

@SukkaW I invited you as a collaborator on the repo so as you can do the transfer — maybe, if that works?

A new version of hexo-renderer-nunjucks should be published — a v2.0.0 to avoid any conflict with previous installs of the same-npm-but-different-repo renderer).

SukkaW · 2020-01-24T06:57:20Z

I invited you as a collaborator on the repo so as you can do the transfer — maybe, if that works?

Emmm, nope. I have accepted the invitation, but collaborator can not access repo's settings page.

BTW, for NPM you could add curben as an package owner. Currently @curbengh is the publisher for all hexo related packages.

SukkaW · 2020-02-26T08:45:31Z

@oncletom I have asked Hexo orgs owner to send your invitation to join hexojs. Maybe then you will have enough permission to transfer the repo then.

thom4parisot · 2020-02-26T20:35:05Z

Okay, thank you @SukkaW.

Also, now I think about it, if you have the correct permissions, you can create an empty repo in the hexojs org, and push the repo content to it. The end result is the same (working code and commits history).

Regarding the npm repo itself (https://www.npmjs.com/package/hexo-renderer-nunjucks), I don't have write access to it. These persons can add curben as a package owner:

[ "tommy351", "ertrzyiks", "jlhwung", "abnerchou", "hexobot" ]

yoshinorin · 2020-03-03T12:04:07Z

@oncletom
I sent you an invitation to join the hexo org.

Thanks :)

SukkaW · 2020-03-03T15:47:03Z

Currently hexo's built-in swig renderer is using some ES6 syntax that hexo-renderer-swig doesn't have yet. I have opened a new PR for that: hexojs/hexo-renderer-swig#23

These persons can add curben as a package owner:

@NoahDragon Would you mind adding @curbengh (curben) as the owner of hexo-renderer-nunjucks at npm?

thom4parisot · 2020-03-03T16:17:38Z

Thank you 🙂 I have transferred the repo. It now lives as hexojs/hexo-renderer-nunjucks 🙌

I added a note in the README to automatically publish a release on npm, for every new Git tag pushed to GitHub.

Once the env variables are set, creating a v2.0.0 release will publish the updated package.

Then this comment can be addressed, by committing the suggestion.

I have updated this PR description to reflect these steps.

SukkaW · 2020-03-30T15:06:28Z

Once the env variables are set, creating a v2.0.0 release will publish the updated package.

@JLHwung @NoahDragon As you are the owners of hexo-renderer-nunjucks, could you please add @oncletom as the owner of the hexo-renderer-nunjucks at npm? So that a newer version could be released.

SukkaW · 2020-04-25T04:40:25Z

@ertrzyiks Hi, it seems that you are an owner of hexo-renderer-nunjucks. Would you mind adding @oncletom (oncletom at npm) to hexo-renderer-nunjucks?

ertrzyiks · 2020-04-25T19:18:49Z

@SukkaW @oncletom added

thom4parisot · 2020-04-26T07:52:49Z

Thank you @ertrzyiks, as well as @SukkaW for chasing this down 🙂

hexo-renderer-nunjucks@2 is live on npm, and this PR has been updated accordingly 👍

NoahDragon added this to the 4.0 milestone Dec 16, 2017

NoahDragon added the enhancement New feature or request label Dec 16, 2017

NoahDragon mentioned this pull request Dec 16, 2017

Hexo Roadmap #2492

Open

53 tasks

charsi mentioned this pull request Jan 13, 2018

Drop swig dependency [solved] theme-next/hexo-theme-next#33

Closed

NoahDragon mentioned this pull request Mar 15, 2018

Why not totally replace Swig with Nunjucks? #1593

Closed

djmtype mentioned this pull request Jul 8, 2018

Hexo's future default template language – EJS or Nunjucks? #3207

Closed

SukkaW added the Breaking Change label Jan 17, 2020

SukkaW previously approved these changes Jan 23, 2020

View reviewed changes

thom4parisot commented Jan 23, 2020

View reviewed changes

package.json Outdated Show resolved Hide resolved

stevenjoezhang previously approved these changes Feb 26, 2020

View reviewed changes

SukkaW mentioned this pull request Feb 26, 2020

refactor: avoid using arguments object hexojs/hexo-renderer-swig#23

Merged

stevenjoezhang mentioned this pull request Mar 4, 2020

refactor(post/tag): render tag before content #4171

Closed

2 tasks

Thomas Parisot added 4 commits April 26, 2020 09:50

Replace built-in swig renderer with nunjucks renderer

cf99c97

Run swig tests with nunjucks renderer

35fc684

Remove Swig rendering condition

3d4f4ee

Replace Swig tests with nunjucks

2cdecbf

thom4parisot dismissed stale reviews from stevenjoezhang and SukkaW via 2cdecbf April 26, 2020 07:50

thom4parisot force-pushed the feature/remove-swig branch from 56dea0b to 2cdecbf Compare April 26, 2020 07:50

SukkaW approved these changes Apr 26, 2020

View reviewed changes

stevenjoezhang approved these changes Apr 26, 2020

View reviewed changes

SukkaW merged commit 78b086f into hexojs:master Apr 26, 2020

thom4parisot deleted the feature/remove-swig branch April 26, 2020 08:17

SukkaW mentioned this pull request Jun 13, 2020

refactor(nunjucks): dedicated nunjucks renderer #4356

Merged

2 tasks

Replace default swig engine with nunjucks #2903

Replace default swig engine with nunjucks #2903

Conversation

thom4parisot commented Dec 11, 2017 • edited Loading

coveralls commented Dec 11, 2017 • edited Loading

kovtunos commented Dec 12, 2017

thom4parisot commented Dec 12, 2017

coveralls commented Dec 13, 2017 • edited Loading

thom4parisot commented Dec 13, 2017 • edited Loading

coveralls commented Dec 13, 2017 • edited Loading

NoahDragon commented Dec 16, 2017

coveralls commented Dec 17, 2017

coveralls commented Dec 17, 2017 • edited Loading

coveralls commented Dec 17, 2017 • edited Loading

coveralls commented Dec 17, 2017 • edited Loading

huiwang commented Jan 5, 2018

charsi commented Jan 13, 2018

NoahDragon commented Mar 15, 2018

thom4parisot commented Mar 15, 2018

NoahDragon commented Mar 15, 2018

djmtype commented Jun 27, 2018

chenbojian commented Dec 5, 2018

tomap commented Dec 5, 2018

thom4parisot commented Dec 5, 2018

yoshinorin commented Dec 16, 2018

chawyehsu commented Mar 5, 2019

chawyehsu commented Mar 27, 2019 • edited Loading

thom4parisot commented Mar 27, 2019 • edited Loading

thom4parisot commented Jan 17, 2020 • edited Loading

SukkaW left a comment

Choose a reason for hiding this comment

thom4parisot commented Jan 23, 2020

SukkaW commented Jan 24, 2020 • edited Loading

SukkaW commented Feb 26, 2020

thom4parisot commented Feb 26, 2020 • edited Loading

yoshinorin commented Mar 3, 2020 • edited Loading

SukkaW commented Mar 3, 2020 • edited Loading

thom4parisot commented Mar 3, 2020

SukkaW commented Mar 30, 2020 • edited Loading

SukkaW commented Apr 25, 2020

ertrzyiks commented Apr 25, 2020

thom4parisot commented Apr 26, 2020

thom4parisot commented Dec 11, 2017 •

edited

Loading

coveralls commented Dec 11, 2017 •

edited

Loading

coveralls commented Dec 13, 2017 •

edited

Loading

thom4parisot commented Dec 13, 2017 •

edited

Loading

coveralls commented Dec 13, 2017 •

edited

Loading

coveralls commented Dec 17, 2017 •

edited

Loading

coveralls commented Dec 17, 2017 •

edited

Loading

coveralls commented Dec 17, 2017 •

edited

Loading

chawyehsu commented Mar 27, 2019 •

edited

Loading

thom4parisot commented Mar 27, 2019 •

edited

Loading

thom4parisot commented Jan 17, 2020 •

edited

Loading

SukkaW commented Jan 24, 2020 •

edited

Loading

thom4parisot commented Feb 26, 2020 •

edited

Loading

yoshinorin commented Mar 3, 2020 •

edited

Loading

SukkaW commented Mar 3, 2020 •

edited

Loading

SukkaW commented Mar 30, 2020 •

edited

Loading