GithubHelp home page GithubHelp logo

Docs seems outdated about adaro HOT 4 CLOSED

krakenjs avatar krakenjs commented on August 17, 2024
Docs seems outdated

from adaro.

Comments (4)

grawk avatar grawk commented on August 17, 2024

Hi @sielay. Can you please point out the exact document and section that is misleading? This module's README doesn't appear to show such an example.

from adaro.

sielay avatar sielay commented on August 17, 2024

In your readme - you take module exports of adaro to adaro var (example 1)

var adaro = require('adaro');

You pass helpers via options (example 2)

var options = {
  helpers: [
    //NOTE: function has to take dust as an argument.
    //The following function defines @myHelper helper
    function (dust) { dust.helpers.myHelper = function (a, b, c, d) {} },
    '../my-custom-helpers',   //Relative path to your custom helpers works
    'dustjs-helpers',   //So do installed modules
    {
      name: '../my-custom-helpers/helper-to-render-data-with-args',
      // or use this signature if you need to pass in additional args
      arguments: { "debug": true }
    }
  ]
};

And now this is version of current readme

app.engine('dust', adaro.dust(options));

and that is version of doc in package on npm

app.engine('dust', adaro(options)); 

Change happened here fd7d42f but seems to not be reflected in npm.

Version in npm will throw error that adaro is not a function (example 1)

Still, if I pass helpers I don't have them registered then in dust instance in adaro object given by invoking adaro(options). To make them appear I had to do something like

let dust = adaro.dust({
        cache: false
    });

    dust.dust.helpers = helpers;

    server.engine('dust', dust);

This finally worked for me.

I think both issues may be due to npm not updated.

from adaro.

grawk avatar grawk commented on August 17, 2024

The first issue is documentation related. I didn't look at what was showing on npm until now, but I see that since v1.0.1 was published there are a couple changes to the README. I'll publish those as v1.0.2.

Regarding your issue registering helpers, that looks like a separate one to me.

Let's address the documentation with this issue and deal with the helpers issue separately.

from adaro.

grawk avatar grawk commented on August 17, 2024

Resolved with the publish of v1.0.2.

from adaro.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.