navmed / pugzor

A drop in replacement for the Razor view engine using pug

Pugzor is the Pug view engine for ASP.NET Core. You might know Pug by its previous name, Jade.
You can read more about Pug over at their website: https://pugjs.org/api/getting-started.html

Pugzor works by passing your models directly to the node version of Pug via Steve Sanderson's glorious JavaScript Services.
It is actually pretty performant and there are many optimizations still to be made.

Instructions

1. Install the Pugzor package from NuGet

    Install-Package pugzor

2. Hook into Pugzor in your Startup.cs

   public void ConfigureServices(IServiceCollection services)
   {
         // Add framework services.
         services.AddMvc()
                 .AddPugzor();
   }

How to access your model

You can now add .pug files directly to your Views directory alongside the Razor files.
The model is available in your Pug view directly, the view data and model state are attached as properties to the pug model.

If your model looked like this:

public class Model
{
   public string FirstName = "name";
}

You would access the model like this:

p #{FirstName}

The ViewDataDictionary is accessible like this:

p #{ViewData.KEY}

The ModelStateDictionary is accessible like this:

p #{ModelState.KEY.errors[INDEX].errorMessage}

FAQ

Is this a joke?

It started off as one but it kind of worked okay so we rolled with it.

Could I use it in production?

Sure. I mean it is your production site so do whatever you want.
If you have a bunch of Pug views already, then this could help you transition to using an ASP.NET Core back end with little difficulty. I don't know that I'd start a whole new site off using it.

What's the license?

MIT

Did anybody actually ask these questions?

No, we're just guessing at what people would ask. Thanks for reminding us how inconsequential we are.