leapfrogtechnology/just-handlebars-helpers

A package with common Handlebars helpers.

just-handlebars-helpers's Issues

please distinguish dependencies/devDependencies in package.json

current behavior

yarn add just-handlebars-helpers

just this module get installed, but it's dependencies ? like moment or currentformatter.js

expected

distinguish dependencies from devDependencies

Implement some common string helpers

• split, join and some other trivial stuffs

Implement the `include` helper

• The include helper just like what we have in cummings {{{include 'sometemplate abc='xyz'}}}`
• Improve it's functionality to allow retrieval of the current context information from included templates without having to explicitly provide the data like {{{lead=lead ...}}}

Add number and currency formatting helpers

Add a number and currency formatting helper which beautifies the numbers that represent length/distance, currency or any. Implement different currency formats accordingly.

Reference:

• http://ux.stackexchange.com/questions/9105/international-currency-formatting-guidelines-currency-codes
• http://www.thefinancials.com/?SubSectionID=curformat

The 'or' operation doesn't seem to work

I have this in my page:

{{log "The or operator: " (or false false)}}

And I get back:

The or operator: true

which is obviously wrong.

If I register a new 'or' helper, where I check the hasOwnProperty then everything works fine:

        Handlebars.registerHelper('or', function () {
            var params =  Array.prototype.slice.call(arguments);
            if ((typeof params[params.length - 1] === 'object')) {
                params.pop();
            }

            for (var index in params) {
                if (params.hasOwnProperty(index) && params[index]) {
                    return true;
                }
            }

            return false;
        });

The or operator: false

Logical operator consistency

Currently logical operators (like and, or) in the helpers are based on Javascript if operator.
Please consider implementing logical operators bases of the way of Handlebars if operator functions.
So that
{{#if (and a b)}} smth {{/if}} would act 100% as {{#if a}}{{#if b}} smth {{/if}}{{/if}}
Currently there are cases (for example empty array) where these two constructions differ and it may result unexpected behaviour in constructions like:

{{# if (or a b)}}
  Found:
  {{#if a}}Element a{{/if}}
  {{#if b}}Element b{{/if}}
{{/if}}

Thank you.

Add codecov.yml

• Add codecov.yml to enable pull-request integration and much more. More information here

Unable to deal with locale-specific date formatting using moment.js

There currently isn't a way to deal with locale-specific date formatting directives without ability to change moment's locale

Proper documentation in the README

• Have proper documentation in the README after all the features are done

Not actually a issue but request for adding another imp. maths helper function i.e Factorial of a Number

code:

const factorial=(num)=>{
if(num===0 || num===1){
return 1;
}
return num*factorial(num-1);
}
console.log(factorial(18)) //6402373705728000

Need a helper to check if a string matches a regex pattern

We need a conditional helper to check if the string matches a regex pattern something like:

{{#if (match '[email protected]' '[a-z][a-z0-9_]+@\w+\.\w{3,4}')}}
    Email is valid.
{{/if}}

Email is {{ifx (match '[email protected]' '[a-z][a-z0-9_]+@\w+\.\w{3,4}') 'valid' 'invalid'}}

Have List of helpers like a table of contents

• Have a list of helpers in the README above the Helpers section to give the short overview of what helpers do we have and what they do.
• The format would be like this:
  | [Helper Name] | [One line description] |

Introduce some basic datetime helpers

• formatDate would be one. Can have other helpers in addition to this.
• Should be based on moment js

Improvements on ifx helper

The ifx helper just provides a way of using the ternary operator ?: in handlebars.

Currently, we can do this with it:

<li class="{{ifx isEven 'even' 'odd'}}">

But a lot of times we we simply want to return nothing for the else case.
For instance:

<li class="{{ifx isActive 'active' ''}}">
<li class="{{ifx isUnavailable 'unavailable' ''}}">
<li class="{{ifx isUnavailable 'unavailable' ''}}">

So, I think we need to make the third parameter for {{ifx}} optional with a default value empty string ("").
So, we can just omit the else case like this:

<li class="{{ifx isActive 'active'}}">
<li class="{{ifx isUnavailable 'unavailable'}}">
<li class="{{ifx isUnavailable 'unavailable'}}">

Add `and` and `or` helpers

• Add and and or helper.
• For and: this will accept two or more parameters and return true if all of them are true.
• For or: this will accept two or more parameters and return true if any of them is true.
• This will allow us to do:

{{#if (and value1 value2) }}
    // do Something
{{else}}
    // do something else
{{/if}}

{{#if (or value1 value2) }}
    // do Something
{{else}}
    // do something else
{{/if}}

Support using with node and common js require()

• Support using with CommonJS require i.e var H = require('just-handlebars-helpers');
• test it in node, browserify and webpack

Automate README doc generation from doc blocks

We need a new npm script something like npm run doc to automatically generate the markdown and regenerate README using the doc blocks.

@sanjeevkpandit knows how to do it 😄.

how to avoid conflicts with naming when we use variables inside with block helper?

Hi.
From backend I received this data

{
count: '...'',
hasResult: true,
query: '123', // input value
}

and my template is something like this

{{#with this}}
	{{#if hasResult}}
		For your query <strong>"{{query}}"</strong> found <strong>{{count}} peoples</strong>
	{{else}}
		Peoples not found
	{{/if}}
{{/with}}

I spent a lot of time trying to understand why instead of the value, a lie is returned to me before I realized that I connected your package with helper that have same name as "count".

How to avoid this with continue to use with (I like to use direct variables comp. to this.someValue)
Thanks!

Continuous Integration with Travis CI

• Continuous Integration with Travis CI

Why some packages are located in devDependencies but required in the 'src'

Maintain a good Wiki and API documentation

• Have a well maintained wiki
• API documentation
• Have some good examples, how to use stuffs, best practices, tutorials etc.

Implement the `sprintf` helper

• Implement the sprintf helper based upon https://github.com/alexei/sprintf.js

Code analysis and Test Code coverage

• Integrate static code analysis and add a badge in the readme
• Add the unit test coverage badge in the README

Add some basic math helpers

• Add some basic math helpers like ceil, floor, add, subtract
• For reference see: https://github.com/elving/swag#math

Need an array helper contains or includes

This helper should check whether or not the array contains an element and return boolean.

Something like this:

var array = [1, 2, 3];
var value = 2;

{{includes array value}}

Since it returns a boolean, we can use it in any conditional helpers like:

{{#if (includes array value)}}
   <!-- Do something -->
{{/if}}

Includes = {{ifx (includes array value) 'Yes' 'No'}}

Need Travis CI & Code coverage badges in the README

• Add Travis CI badge
• Add Code coverage badges

Replace gulp with rollup & npm scripts

I think we should use rollup for bundling and just npm scripts for simple tasks.

Proper formatting of JSDoc

Change the current set of JSDoc to use a proper standard.

Right now we have this:

/**
 * Determine whether or not two values are equal (==) i.e weak checking.
 * @example
 *      {{eqw '3' 3}}   => true
 *
 * @param value1
 * @param value2
 * @returns boolean
 */
export function eqw(value1, value2) {
  return (value1 == value2);
}

We are missing the type of parameter in all places. Need to update all the JSDoc blocks throughout the repository.

Example:

/**
 * Determine whether or not two values are equal (==) i.e weak checking.
 * @example
 *      {{eqw '3' 3}}   => true
 *
 * @param {any} value1
 * @param {any} value2
 * @returns {boolean}
 */
export function eqw(value1, value2) {
  return (value1 == value2);
}

Our docs does include the parameter type. We need to do the same in our code.