diff --git a/packages/string-templates/manifest.json b/packages/string-templates/manifest.json index c23e3dc3a4..e3c8b1dc76 100644 --- a/packages/string-templates/manifest.json +++ b/packages/string-templates/manifest.json @@ -20,7 +20,6 @@ "array" ], "numArgs": 1, - "example": "handlebars {{avg \"[1, 2, 3, 4, 5]\"}} ", "description": "
Returns the average of all numbers in the given array.
\n" }, "ceil": { @@ -113,7 +112,6 @@ "array" ], "numArgs": 1, - "example": "handlebars {{sum \"[1, 2, 3, 4, 5]\"}} ", "description": "Returns the sum of all numbers in the given array.
\n" }, "times": { @@ -132,7 +130,6 @@ "n" ], "numArgs": 2, - "example": "handlebars {{after array 1}} ", "description": "Returns all of the items in an array after the specified index. Opposite of before.
\n" }, "arrayify": { @@ -140,7 +137,6 @@ "value" ], "numArgs": 1, - "example": "handlebars {{arrayify \"foo\"}} ", "description": "Cast the given value
to an array.
Return all of the items in the collection before the specified count. Opposite of after.
\n" }, "eachIndex": { @@ -158,7 +153,6 @@ "options" ], "numArgs": 2, - "example": "handlebars {{#eachIndex array}} {{item}} is {{index}} {{/eachIndex}} ", "description": "Iterates the array, listing an item and the index of it.
\n" }, "filter": { @@ -168,7 +162,6 @@ "options" ], "numArgs": 3, - "example": "handlebars {{#filter array \"foo\"}}AAA{{else}}BBB{{/filter}} ", "description": "Block helper that filters the given array and renders the block for values that evaluate to true
, otherwise the inverse block is returned.
Returns the first item, or first n
items of an array.
Iterates over each item in an array and exposes the current item in the array as context to the inner block. In addition to the current array item, the helper exposes the following variables to the inner block: - index
- total
- isFirst
- isLast
Also, @index
is exposed as a private variable, and additional private variables may be defined as hash arguments.
Block helper that renders the block if an array has the given value
. Optionally specify an inverse block to render when the array does not have the given value.
Returns true if value
is an es5 array.
Returns the item from array
at index idx
.
Join all elements of array into a string, optionally using a given separator.
\n" }, "equalsLength": { @@ -239,7 +226,6 @@ "n" ], "numArgs": 2, - "example": "handlebars {{last value}} {{last value 2}} {{last value 3}} ", "description": "Returns the last item, or last n
items of an array or string. Opposite of first.
Returns the length of the given string or array.
\n" }, "lengthEqual": { @@ -265,7 +250,6 @@ "fn" ], "numArgs": 2, - "example": "handlebars {{map array double}} ", "description": "Returns a new array, created by calling function
on each element of the given array
. For example,
Map over the given object or array or objects and create an array of values from the given prop
. Dot-notation may be used (as a string) to get nested properties.
Reverse the elements in an array, or the characters in a string.
\n" }, "some": { @@ -292,7 +274,6 @@ "provided" ], "numArgs": 3, - "example": "handlebars {{#some array isString}} Render me if the array has a string. {{else}} Render me if it doesn't. {{/some}} ", "description": "Block helper that returns the block if the callback returns true for some value in the given array.
\n" }, "sort": { @@ -301,7 +282,6 @@ "key" ], "numArgs": 2, - "example": "handlebars {{sort array}} ", "description": "Sort the given array
. If an array of objects is passed, you may optionally pass a key
to sort on as the second argument. You may alternatively pass a sorting function as the second argument.
Sort an array
. If an array of objects is passed, you may optionally pass a key
to sort on as the second argument. You may alternatively pass a sorting function as the second argument.
Use the items in the array after the specified index as context inside a block. Opposite of withBefore.
\n" }, "withBefore": { @@ -330,7 +308,6 @@ "options" ], "numArgs": 3, - "example": "handlebars {{#withBefore array 3}} {{this}} {{/withBefore}} ", "description": "Use the items in the array before the specified index as context inside a block. Opposite of withAfter.
\n" }, "withFirst": { @@ -340,7 +317,6 @@ "options" ], "numArgs": 3, - "example": "handlebars {{#withFirst array}} {{this}} {{/withFirst}} ", "description": "Use the first item in a collection inside a handlebars block expression. Opposite of withLast.
\n" }, "withGroup": { @@ -350,7 +326,6 @@ "options" ], "numArgs": 3, - "example": "handlebars {{#withGroup array 4}} {{#each this}} {{.}} {{each}}Block helper that groups array elements by given group size
.
Use the last item or n
items in an array as context inside a block. Opposite of withFirst.
Block helper that sorts a collection and exposes the sorted collection as context inside the block.
\n" }, "unique": { @@ -379,7 +352,6 @@ "options" ], "numArgs": 2, - "example": "handlebars {{#each (unique array)}}{{.}}{{/each}} ", "description": "Block helper that return an array with all duplicate values removed. Best used along with a each helper.
\n" } }, @@ -419,7 +391,6 @@ "fractionDigits" ], "numArgs": 2, - "example": "handlebars {{toExponential number digits}}; ", "description": "Returns a string representing the given number in exponential notation.
\n" }, "toFixed": { @@ -428,7 +399,6 @@ "digits" ], "numArgs": 2, - "example": "handlebars {{toFixed \"1.1234\" 2}} //=> '1.12' ", "description": "Formats the given number using fixed-point notation.
\n" }, "toFloat": { @@ -451,7 +421,6 @@ "precision" ], "numArgs": 2, - "example": "handlebars {{toPrecision \"1.1234\" 2}} //=> '1.1' ", "description": "Returns a string representing the Number
object to the specified precision.
Strip protocol from a url
. Useful for displaying media that may have an 'http' protocol on secure connections.
Append the specified suffix
to the given string.
camelCase the characters in the given string
.
Capitalize the first word in a sentence.
\n" }, "capitalizeAll": { @@ -549,7 +514,6 @@ "str" ], "numArgs": 1, - "example": "handlebars {{capitalizeAll \"foo bar baz\"}} ", "description": "Capitalize all words in a string.
\n" }, "center": { @@ -565,7 +529,6 @@ "string" ], "numArgs": 1, - "example": "handlebars {{chop \"_ABC_\"}} {{chop \"-ABC-\"}} {{chop \" ABC \"}} ", "description": "Like trim, but removes both extraneous whitespace and non-word characters from the beginning and end of a string.
\n" }, "dashcase": { @@ -573,7 +536,6 @@ "string" ], "numArgs": 1, - "example": "handlebars {{dashcase \"a-b-c d_e\"}} ", "description": "dash-case the characters in string
. Replaces non-word characters and periods with hyphens.
dot.case the characters in string
.
Lowercase all of the characters in the given string. Alias for lowercase.
\n" }, "ellipsis": { @@ -598,7 +558,6 @@ "length" ], "numArgs": 2, - "example": "handlebars {{ellipsis (sanitize \"foo bar baz\"), 7}} {{ellipsis \"foo bar baz\", 7}} ", "description": "Truncates a string to the specified length
, and appends it with an elipsis, …
.
Replace spaces in a string with hyphens.
\n" }, "isString": { @@ -614,7 +572,6 @@ "value" ], "numArgs": 1, - "example": "handlebars {{isString \"foo\"}} ", "description": "Return true if value
is a string.
Lowercase all characters in the given string.
\n" }, "occurrences": { @@ -631,7 +587,6 @@ "substring" ], "numArgs": 2, - "example": "handlebars {{occurrences \"foo bar foo bar baz\" \"foo\"}} ", "description": "Return the number of occurrences of substring
within the given string
.
PascalCase the characters in string
.
path/case the characters in string
.
Replace spaces in the given string with pluses.
\n" }, "prepend": { @@ -664,7 +616,6 @@ "prefix" ], "numArgs": 2, - "example": "handlebars {{prepend val \"foo-\"}} ", "description": "Prepends the given string
with the specified prefix
.
Render a block without processing mustache templates inside the block.
\n" }, "remove": { @@ -681,7 +631,6 @@ "substring" ], "numArgs": 2, - "example": "handlebars {{remove \"a b a b a b\" \"a \"}} ", "description": "Remove all occurrences of substring
from the given str
.
Remove the first occurrence of substring
from the given str
.
Replace all occurrences of substring a
with substring b
.
Replace the first occurrence of substring a
with substring b
.
Sentence case the given string
\n" }, "snakecase": { @@ -726,7 +671,6 @@ "string" ], "numArgs": 1, - "example": "handlebars {{snakecase \"a-b-c d_e\"}} ", "description": "snake_case the characters in the given string
.
Split string
by the given character
.
Tests whether a string begins with the given prefix.
\n" }, "titleize": { @@ -752,7 +694,6 @@ "str" ], "numArgs": 1, - "example": "handlebars {{titleize \"this title case\"}} ", "description": "Title case the given string.
\n" }, "trim": { @@ -760,7 +701,6 @@ "string" ], "numArgs": 1, - "example": "handlebars {{trim \" ABC \"}} ", "description": "Removes extraneous whitespace from the beginning and end of a string.
\n" }, "trimLeft": { @@ -768,7 +708,6 @@ "string" ], "numArgs": 1, - "example": "handlebars {{trim \" ABC \"}} ", "description": "Removes extraneous whitespace from the beginning of a string.
\n" }, "trimRight": { @@ -776,7 +715,6 @@ "string" ], "numArgs": 1, - "example": "handlebars {{trimRight \" ABC \"}} ", "description": "Removes extraneous whitespace from the end of a string.
\n" }, "truncate": { @@ -786,7 +724,6 @@ "suffix" ], "numArgs": 3, - "example": "handlebars truncate(\"foo bar baz\", 7); truncate(sanitize(\"foo bar baz\", 7)); ", "description": "Truncate a string to the specified length
. Also see ellipsis.
Truncate a string to have the specified number of words. Also see truncate.
\n" }, "upcase": { @@ -804,7 +740,6 @@ "string" ], "numArgs": 1, - "example": "handlebars {{upcase \"aBcDeF\"}} ", "description": "Uppercase all of the characters in the given string. Alias for uppercase.
\n" }, "uppercase": { @@ -813,7 +748,6 @@ "options" ], "numArgs": 2, - "example": "handlebars {{uppercase \"aBcDeF\"}} ", "description": "Uppercase all of the characters in the given string. If used as a block helper it will uppercase the entire block. This helper does not support inverse blocks.
\n" } }, @@ -825,7 +759,6 @@ "options" ], "numArgs": 3, - "example": "handlebars {{#and great magnificent}}A{{else}}B{{/and}} ", "description": "Helper that renders the block if both of the given values are truthy. If an inverse block is specified it will be rendered when falsy. Works as a block helper, inline helper or subexpression.
\n" }, "compare": { @@ -846,7 +779,6 @@ "options" ], "numArgs": 4, - "example": "handlebars {{#contains array \"d\"}} This will not be rendered. {{else}} This will be rendered. {{/contains}} ", "description": "Block helper that renders the block if collection
has the given value
, using strict equality (===
) for comparison, otherwise the inverse block is rendered (if specified). If a startIndex
is specified and is negative, it is used as the offset from the end of the collection.
Return true if the given value is an even number.
\n" }, "ifNth": { @@ -933,7 +864,6 @@ "options" ], "numArgs": 2, - "example": "handlebars {{#ifOdd value}} render A {{else}} render B {{/ifOdd}} ", "description": "Block helper that renders a block if value
is an odd number. If an inverse block is specified it will be rendered when falsy.
Block helper that renders a block if any of the given values is truthy. If an inverse block is specified it will be rendered when falsy.
\n" }, "unlessEq": { diff --git a/packages/string-templates/scripts/gen-collection-info.js b/packages/string-templates/scripts/gen-collection-info.js index d7e464a8ae..413e870519 100644 --- a/packages/string-templates/scripts/gen-collection-info.js +++ b/packages/string-templates/scripts/gen-collection-info.js @@ -78,11 +78,14 @@ function getCommentInfo(file, func) { docs.description = docs.description.replace(/\n/g, " ") docs.description = docs.description.replace(/[ ]{2,}/g, " ") docs.description = docs.description.replace(/is is/g, "is") - const example = docs.description.split("```") - if (example.length > 1) { - docs.example = example[1] + const examples = docs.tags + .filter(el => el.title === "example") + .map(el => el.description) + const blocks = docs.description.split("```") + if (examples.length > 0) { + docs.example = examples.join(" ") } - docs.description = example[0].trim() + docs.description = blocks[0].trim() return docs }