articulate-nlg - npm Package Compare versions

Comparing version 1.1.1 to 1.1.2

package.json

 {
   "name": "articulate-nlg",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "A natural language generator (NLG) that articulates concepts as words, phrases, and sentences.",
@@ -5,0 +5,0 @@ "main": "./dist/index.js",

README.md

@@ -74,3 +74,3 @@ [![Build Status](https://travis-ci.org/justinmahar/articulate-nlg.svg?branch=master)](https://travis-ci.org/justinmahar/articulate-nlg) [![codecov](https://codecov.io/gh/justinmahar/articulate-nlg/branch/master/graph/badge.svg)](https://codecov.io/gh/justinmahar/articulate-nlg)
 // Woof! Welcome home, bringer of food! 👅
-// Wag tail! Welcome home, bringer of food! 🐕‍
+// Wag tail! Welcome home, bringer of food! 💩
 // Etc.
@@ -82,11 +82,16 @@
 
-// If you reference a concept that's not understood, you'll get an empty string back.
+// If you reference a concept that's not understood, you'll get
+// an empty string back.
 max.say("wubalubadubdub");
 // ""
 
-// Params can be used in the vocab, too. Here, the "master" concept uses a name if provided.
+// Params can be used in the vocab, too. Here, the "master" 
+// concept uses a name if provided.
 max.say("master", { name: "justin" });
 // "Justin"
+max.say("welcomeHome", { name: "justin" });
+// Sniff sniff! Welcome home, Justin! 🐩
 
-// And if not provided, can fall back on a default using the ifElse helper. See the vocab above.
+// And if not provided, can fall back on a default using the 
+// ifElse helper. See the vocab above.
 max.say("master");
@@ -106,16 +111,48 @@ // "Bringer of food"
 
-- `capitalize(text: string)` - Creates a template for capitalization. Capitalizes the first letter of the contents after articulating it.
-- `choose(texts: (string|{v:value,w:weight})[])` - Creates a template for random choice. This chooses one of the items at random. Takes a mixed array of strings or weighted objects in the format `{v: value, w: weight}`. You cannot use a `|` character in any of the texts. If you need this character, use `say("pipe")` and have the `"pipe"` key map to `"|"`.
-  - Each item is articulated, meaning you can `say()` vocab keys.
-    - `choose(["apple", "orange", say("meat")])` -> Randomly selects `apple`, `orange`, or whatever `meat` articulates as.
-  - You can specify weights using `{v: value, w: weight}` objects instead of strings, where `v` is the text to articulate and `w` is the weight value. Weights default to `1` if not provided.
-    - `choose([{v: "apple" w: 3}, "orange", "banana"])` -> `apple` has an 80% chance, `orange` and `banana` have a 20% chance (default weight of `1`).
-- `maybe(text: string)` - Creates a template that results in a 50/50 choice between an empty string or the provided text. You cannot use a `|` character in the text. If you need this character, use `say("pipe")` and have the `"pipe"` key map to `"|"`.
-- `say(vocabKey: string)` - Creates a template that articulates another vocab key.
-- `param(paramKey: string)` - Creates a template that references the value of a parameter.
-- `ifThen(paramKey: string, thenText: string)` - Creates a template that uses the provided `thenText` if the param key exists and is not falsy.
-- `ifNot(paramKey: string, thenText: string)` - Creates a template that uses the provided `thenText` if the param key doesn't exist or is falsy.
-- `ifElse(paramKey: string, thenText: string, elseText: string)` - Creates a template with both `ifThen()` and `ifNot()` templates for the given param key.
-- `doFirst(paramTextPairs: {p: paramKey, t: text}[], defaultText: string = "")` - Creates a template that uses `ifElse()` templates for each pair provided until true. If no param keys are truthy, the `defaultText` is used (defaults to empty string).
+### • `capitalize(text: string)`
 
+Creates a template for capitalization. Capitalizes the first letter of the contents after articulating it.
+
+### • `choose(texts: (string|{v:value,w:weight})[])`
+
+Creates a template for random choice. This chooses one of the items at random. Takes a mixed array of strings or weighted objects in the format `{v: value, w: weight}`. You cannot use a `|` character in any of the texts. If you need this character, use `say("pipe")` and have the `"pipe"` key map to `"|"`.
+
+Each item is articulated, meaning you can `say()` vocab keys.
+  - `choose(["apple", "orange", say("meat")])` -> Randomly selects `apple`, `orange`, or whatever `meat` articulates as.
+
+You can specify weights using `{v: value, w: weight}` objects instead of strings, where `v` is the text to articulate and `w` is the weight value. Weights default to `1` if not provided.
+  - `choose([{v: "apple" w: 3}, "orange", "banana"])` -> `apple` has an 80% chance, `orange` and `banana` have a 20% chance (default weight of `1`).
+
+### • `maybe(text: string)`
+
+Creates a template that results in a 50/50 choice between an empty string or the provided text. 
+
+You cannot use a `|` character in the text. If you need this character, use `say("pipe")` and have the `"pipe"` key map to `"|"`.
+
+### • `say(vocabKey: string)`
+
+Creates a template that articulates another vocab key.
+
+### • `param(paramKey: string)`
+
+Creates a template that references the value of a parameter.
+
+### • `ifThen(paramKey: string, thenText: string)`
+
+Creates a template that uses the provided `thenText` if the param key exists and is not falsy.
+
+### • `ifNot(paramKey: string, thenText: string)`
+
+Creates a template that uses the provided `thenText` if the param key doesn't exist or is falsy.
+
+### • `ifElse(paramKey: string, thenText: string, elseText: string)`
+
+Creates a template with both `ifThen()` and `ifNot()` templates for the given param key.
+
+### • `doFirst(paramTextPairs: {p: paramKey, t: text}[], defaultText: string = "")`
+
+Creates a template that uses `ifElse()` templates for each pair provided until true. If no param keys are truthy, the `defaultText` is used (defaults to empty string).
+
+### Note on Nesting
+
 You cannot nest the same function wrapper in itself. If, say, you need to nest `choose()` within `choose()`, you should create a separate vocab key with the function and reference it in the original one like so: `say("nameOfVocabKey")`. A safety check is built into these functions to prevent nesting and a warning will be printed to the console if you do nest them on accident.
@@ -122,0 +159,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

106708

increased by0.19%

Number of lines in readme file

168

increased by28.24%

No dependency changes