Templ8 - npm Package Compare versions

Comparing version 0.1.8 to 0.1.9

package.json

@@ -13,3 +13,3 @@ {
 	"main"        : "./Templ8.js",
-	"version"     : "0.1.8",
+	"version"     : "0.1.9",
 
@@ -16,0 +16,0 @@ "repository"  : {

README.md

@@ -338,9 +338,9 @@ #TODO:
 
-Just like regular JavaScript Templ8 features conditional statements. It also introduces the **unless** statement based off Perl.
+Just like regular JavaScript Templ8 features conditional statements. It also introduces the `unless` statement based off Perl.
 
-Every open **if** or **unless** statement must end with an **endif** statement -- with any number of **elseif**s in between, and one optional **else** just before the **endif**.
+Every open `if`/ `unless` statement must end with an `endif` statement -- with any number of`elseif`s in between; an optional `else` is also allowed just before `endif`.
 
-The reason for this is that Templ8 does not use braces to encapsulate block statements, so it requires a flag to let the parser know when to close a block.
+The reason for the `endif` statement is that Templ8 does not use braces to encapsulate block statements, so it requires a flag to let the parser know when to close a block.
 
-**Note: elseif should be written as one word, no spaces.**
+**Note: `elseif` should be written as one word, no spaces. It can also be written as `elsif`, again, based off Perl.**
 
@@ -372,4 +372,60 @@ An example would be:
 ##### for/ forempty/ endfor Statements
-TODO
+The `for` statement allows you to iterate over Arrays as well as Objects. There are a number of options available with the `for` statement.
 
+Just like the `if` statement the `for` statement must end with an `endfor` statement to tell the parser that the statement block is ending.
+
+You can also include a `forempty` statement which will be used in the case where an Array/ Object is either empty or the item you are trying to iterate over is not iterable, e.g. a Number or Date. `forempty` is not mandatory.
+
+The `iter` variable mentioned above is the standard way to access any and all properties you require while iterating over an Array/ Object.
+
+You can also use `$_` to access the current value being iterated over.
+
+However you can also assign your own variable names to the `for`. e.g.
+
+```javascript
+    {% for item in items %}
+        {{item}}
+    {% forempty %}
+        No items
+    {% endfor %}
+```
+
+Will assign the current value being iterated over to the variable `item`, which is accessible as demonstrated.
+
+```javascript
+    {% for [key, value] in items %}
+        {{key}}. {{value}}
+    {% endfor %}
+```
+
+Will assign the current value being iterated over to the variable `value`. If you are iterating over an Array then the variable `key` will be the zero based index of the the current item being iterated over. If you are iterating over an Object then the variable `key` will be the the key name of the current item being iterted over.
+
+If you want to limit the number of items you are iterating over you can do so by using brackets to specify the range of items to iterate over.
+
+```javascript
+    {% for item in items [..10] %}
+        {{item}}
+    {% endfor %}
+```
+
+Will iterate over items 0 to 10, so the first 11 items in the Array/ Object.
+
+```javascript
+    {% for item in items [5..10] %}
+        {{item}}
+    {% endfor %}
+```
+
+Will iterate over items 5 to 10.
+
+```javascript
+    {% for item in items [5..] %}
+        {{item}}
+    {% endfor %}
+```
+
+Will iterate over all items starting from the 6th item in the Array/ Object.
+
+If you are nesting `for` statements you can access the parent `iter` Object by using the syntax `iter.parent` this will maintain state no matter how deep you nest.
+
 ##### sub/ endsub templates
@@ -376,0 +432,0 @@ TODO

Templ8.js

@@ -30,3 +30,4 @@ #!/usr/bin/env node
 			notEmpty   : not_empty,
-			startsWith : function( s, str ) { return String( s ).indexOf( str ) === 0; }
+			startsWith : function( s, str ) { return String( s ).indexOf( str ) === 0; },
+			type       : T
 		},
@@ -33,0 +34,0 @@ bf = {},

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

92199

increased by99.95%

Number of package files

7

increased by40%

Lines of code

1183

increased by83.13%

Number of lines in readme file

614

increased by10.04%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes