v2.5.4

- updated cycles
- added link to custom typed.js to speech box
- switched from uglify-js to terser

build.js

@@ -1,7 +1,7 @@
 // build me
 
 var jetpack = require('fs-jetpack'),
-    uglify = require('uglify-js');
+    Terser  = require('terser');
 
 function build () {
     var jsFiles = jetpack.find('./scripts', {
@@ -11,11 +11,11 @@ function build () {
 
     jsFiles.forEach( function (file) {
         var source = jetpack.read(file),
-            path = file.split(/[\\\/]/g),
-            name = path.pop().split('.').join('.min.'),
+            path   = file.split(/[\\\/]/g),
+            name   = path.pop().split('.').join('.min.'),
             result, ret;
 
-        result = uglify.minify(source);
+        result = Terser.minify(source);
 
         console.log(result.error);
 

docs/README.md

@@ -1,4 +1,4 @@
-## Chapel's Custom Macro Collection (v2.5.3)
+## Chapel's Custom Macro Collection (v2.5.4)
 
 - [Try the demo!](https://macros.twinelab.net/demo)
 - [Downloads](./download ':ignore')
@@ -8,7 +8,7 @@
 ### Documentation
 - **Gameplay Systems and Mechanics**
   - [The Simple Inventory System](./simple-inventory.md)
-  - [The Cycles System](./cycles-system.md)
+  - [The Cycles System](./cycles-system.md) *updated*
   - [The Playtime System](./playtime-system.md)
 - **Interface and Style**
   - [The Dialog API Macro Set](./dialog-api-macro-set.md)
@@ -26,7 +26,7 @@
   - [The Message Macro](./message-macro.md)
   - [The Typing Simulation Macro](./type-sim.md)
 - **Grammar and Language**
-  - [The Pronoun Templates](./pronoun-templates.md) *updated*
+  - [The Pronoun Templates](./pronoun-templates.md)
   - [The Articles (A/An) Macros](./articles.md)
 - **Utilities and Other**
   - [The Done Macro](./done-macro.md)

docs/changelog.md

@@ -5,6 +5,12 @@
 > [!NOTE]
 > I'm going to start keeping a changelog for these macros because keeping track of them is becoming a nightmare. The overall version numbers are not really helpful for tracking what's happening on a macro-by-macro basis, but I'm trying to stick to major version bumps meaning breaking changes in any macro, or complete refactors of the whole collection, like what v2.0.0 was. Minor version updates indicate new macros have been added. Patch version updates means individual macro updates and bug fixes, or documentation, website, or demo updates.
 
+### June 27, 2020 (v2.5.4)
+
+- **[Update]** Added `Cycle.check()` and `cycle#check()` methods to the cycles system.
+- **[Docs]** Added link to custom `typed.js` module code (from Thomas M. Edwards) to the speech box system docs.
+- **[Meta]** Replaced Uglify with Terser for JS minification.
+
 ### March 31, 2020 (v2.5.3)
 
 - **[Update]** Several improvements to the pronoun macros:

docs/cycles-system.md

@@ -159,6 +159,7 @@ Of particular note to authors:
 
 - [`Cycle.add()`](#method-cycleadd)
 - [`Cycle.get()`](#method-cycleget)
+- [`Cycle.check()`](#method-cyclecheck)
 
 #### Method: `Cycle.add()`
 
@@ -256,6 +257,27 @@ Returns the `Cycle` instance with the given name, or `null` if it doesn't exist.
 var cycle = Cycle.get('blah');
 ```
 
+#### Method: `Cycle.check()`
+
+**Returns**: boolean.
+
+**Syntax**: `Cycle.check(name, phase)`
+
+Returns a whether the indicated `Cycle` instance is at the indicated phase
+
+**Arguments**:
+
+- `name`: The name of a previously defined cycle, by the [`<<newcycle>>` macro](#macro-ltltnewcyclegtgt) or the [`Cycle` API](#javascript-api).
+- `phase`: The string name of one of the phases in this cycle.
+
+**Usage**:
+
+```
+<<if Cycle.check('time', 'afternoon')>>
+    It's afternoon!
+<</if>>
+```
+
 #### Method: `Cycle.del()`
 
 **Returns**: boolean.
@@ -284,6 +306,7 @@ Cycle.get('blah'); // null
 Deletes all registered cycles.
 
 **Usage**:
+
 ```javascript
 Cycle.add('blah', { phases : ['hey', 'hello'] });
 Cycle.clear();
@@ -297,6 +320,7 @@ These are the methods of the `Cycle` instance. Methods that return the `Cycle` i
 Of particular note to authors:
 
 - [`cycle#current()`](#method-cyclecurrent)
+- [`cycle#check()`](#method-instance-cyclecheck)
 - [`cycle#update()`](#method-cycleupdate)
 
 #### Method: `cycle#current()`
@@ -317,6 +341,26 @@ Cycle.get('blah').current();
 <<= Cycle.get('blah').current().toUpperFirst()>>
 ```
 
+#### Method (Instance): `cycle#check()`
+
+**Returns**: boolean.
+
+**Syntax**: `<cycle>.check(phase)`
+
+Returns whether the cycle is at the indicated phase.
+
+**Arguments**:
+
+- `phase`: The string name of one of the phases in this cycle.
+
+**Usage**:
+
+```
+<<if Cycle.get('time').check('afternoon')>>
+	It's afternoon.
+<</if>>
+```
+
 #### Method: `cycle#update()`
 
 **Returns**: This instance (chainable).

docs/speech-box-system.md

@@ -11,6 +11,9 @@ The default look and styling is very bare bones, and meant to be a basic startin
 > [!NOTE]
 > Unlike most of my macros, this code relies on CSS files as well as JavaScript! Be sure to download and install the relevant CSS files as well!
 
+> [!WARNING]
+> If you want to use this system with the `typed.js` integration module, you'll need to use this custom JavaScript in place of that provided by the module: https://gist.github.com/tmedwards/4921bdcd7bfbb955530c135ee3feff83
+
 **THE CODE:** [Minified JS](https://github.com/ChapelR/custom-macros-for-sugarcube-2/blob/master/scripts/minified/speech.min.js). [Pretty JS](https://github.com/ChapelR/custom-macros-for-sugarcube-2/blob/master/scripts/speech.js). [Minified CSS](https://github.com/ChapelR/custom-macros-for-sugarcube-2/blob/master/scripts/minified/speech.min.css). [Pretty CSS](https://github.com/ChapelR/custom-macros-for-sugarcube-2/blob/master/scripts/speech.css).  
 **DEMO:** [Available](http://macros.twinelab.net/demo?macro=speech).  
 **GUIDE:** Not available.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "custom-macros-for-sugarcube-2",
-  "version": "2.5.3",
+  "version": "2.5.4",
   "description": "Collection of custom macros and systems for Twine/SugarCube2.",
   "main": "build.js",
   "directories": {
@@ -26,7 +26,7 @@
   "homepage": "https://github.com/ChapelR/custom-macros-for-sugarcube-2#readme",
   "devDependencies": {
     "fs-jetpack": "^1.3.1",
-    "jshint": "^2.11.0",
-    "uglify-js": "^3.7.6"
+    "jshint": "^2.11.1",
+    "terser": "^4.8.0"
   }
 }

scripts/cycles.js

@@ -139,6 +139,11 @@
             }
             return false;
         },
+        check : function (name, phase) {
+            if (Cycle.has(name)) {
+                return Cycle.get(name).check(phase);
+            }
+        },
         clear : function (name) {
             var got = _get();
             got = {};
@@ -248,6 +253,9 @@
                 this.increment = set;
             }
             return this.increment;
+        },
+        check : function (phase) {
+            return this.current() === phase;
         }
     });