Add a way to skip compilation if a certain metadata tag is set

[kennyjwilli]

Right now the only way to tell Sablono to not compile the body is by type hinting it as a String or Number. Because this type hint doesn't make sense for all cases, I think it would be nice to have a short, general type hint telling Sablono to just return the form, skipping compilation. In this PR I named that type hint :! because it is short and can be thought of as "not compiled." I am totally open to other (preferably short) names though.

[r0man]

Kenny, what is the use case for skipping compilation?

On 8 Nov 2016 20:53, "Kenny Williams" notifications@github.com wrote:

Right now the only way to tell Sablono to not compile the body is by type
hinting it as a String or Number. Because this type hint doesn't make sense
for all cases, I think it would be nice to have a short, general type hint
telling Sablono to just return the form, skipping compilation. In this PR I
named that type hint :! because it is short and can be thought of as "not

compiled." I am totally open to other (preferably short) names though.

You can view, comment on, or merge this pull request online at:

#135
Commit Summary

• Add a way to skip compilation if a certain metadata tag is set
• Add test for skipping compilation

File Changes

• M src/sablono/compiler.clj
  https://github.com/r0man/sablono/pull/135/files#diff-0 (1)
• M test/sablono/compiler_test.clj
  https://github.com/r0man/sablono/pull/135/files#diff-1 (3)

Patch Links:

• https://github.com/r0man/sablono/pull/135.patch
• https://github.com/r0man/sablono/pull/135.diff

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
#135, or mute the thread
https://github.com/notifications/unsubscribe-auth/AABUPs05wRWRZuY3A45rY8fKEx6xpKbwks5q8NMhgaJpZM4Ks1pC
.

[kennyjwilli]

To avoid the interpret call altogether. For example, right now this is the code Sablono would return:

(macroexpand-1 '(html
                  [:div {}
                   (function-that-returns-react-component)]))
=> (js/React.createElement "div" nil (sablono.interpreter/interpret (function-that-returns-react-component)))

With the metadata tag I added, the call to sablono.interpreter/interpret can be skipped.

(macroexpand-1 '(html
                  [:div {}
                   ^:! (function-that-returns-react-component)]))
=> (js/React.createElement "div" nil (function-that-returns-react-component))

[r0man]

Ok, I would like to have more descriptive (and possibly short) name for the name of the :! type hint. Any suggestions?

[kennyjwilli]

Maybe one of these: :skip, :no-c, :omit, :noop

[r0man]

What about : inline ?

On 10 Nov 2016 22:24, "Kenny Williams" notifications@github.com wrote:

Maybe one of these: :skip, :no-c, :omit, :noop

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
#135 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AABUPj96YMGnOMZT1atNw_WA6-rideFAks5q84uogaJpZM4Ks1pC
.

[martinklepsch]

Was concerned about the brevity of :! as well — some suggestions: :no-interpretation, :as-is, :skip-interpretation, :raw.

I also like :inline I think. It does not mention "interpretation" though which is the term used throughout the codebase, so may lead to some confusion.

The -interpretation ones could also be abbreviated like no-interpret. I guess if you use this a lot you can always make a macro to shorten it. In general I vote for the more obvious option :)

[piranha]

:raw sounds nice!

[kennyjwilli]

Works for me.

On Nov 12, 2016 8:35 AM, "r0man" notifications@github.com wrote:

What about : inline ?

On 10 Nov 2016 22:24, "Kenny Williams" notifications@github.com wrote:

Maybe one of these: :skip, :no-c, :omit, :noop

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
#135 (comment), or
mute
the thread
<https://github.com/notifications/unsubscribe-
auth/AABUPj96YMGnOMZT1atNw_WA6-rideFAks5q84uogaJpZM4Ks1pC>
.

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#135 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/ACVx2P4EiX0lSwYoxhw_jNj1SsNr_Foxks5q9erRgaJpZM4Ks1pC
.

[r0man]

@kennyjwilli I think I would like to go with :inline. Could you change the tag, and document this use case in the README?

[kennyjwilli]

@r0man Updated metadata tag to :inline and added a section to the README.

[r0man]

@kennyjwilli Thanks! Will cut a release soon ...