Add command to jump to the first slide

Author: kgryte

lib/node_modules/@stdlib/repl/presentation/data/example.csv

@@ -1,4 +1,5 @@
 currentSlide,"currentSlide\n"
+first,"first()\n"
 jumpTo,"jumpTo( 2 )\n"
 next,"next()\n"
 numSlides,"numSlides\n"

lib/node_modules/@stdlib/repl/presentation/data/example.json

@@ -1 +1 @@
-{"currentSlide":"currentSlide\n","jumpTo":"jumpTo( 2 )\n","next":"next()\n","numSlides":"numSlides\n","prev":"prev()\n","runSlide":"runSlide()\n"}
+{"currentSlide":"currentSlide\n","first":"first()\n","jumpTo":"jumpTo( 2 )\n","next":"next()\n","numSlides":"numSlides\n","prev":"prev()\n","runSlide":"runSlide()\n"}

lib/node_modules/@stdlib/repl/presentation/data/help.csv

@@ -1,6 +1,7 @@
 currentSlide,"\ncurrentSlide\n    Returns the current presentation slide index.\n\n    The returned index is the nominal (i.e., one-based) slide index.\n\n    Returns\n    -------\n    idx: integer\n        Current presentation slide index.\n\n    Examples\n    --------\n    > currentSlide\n\n    See Also\n    --------\n    jumpTo, next, numSlides, prev\n\n"
+first,"\nfirst()\n    Jumps to the first slide.\n\n    Examples\n    --------\n    > first()\n\n    See Also\n    --------\n    jumpTo, last, next, prev\n\n"
 jumpTo,"\njumpTo( n )\n    Jumps to a specified slide, where `n` is the nominal slide number.\n\n    Parameters\n    ----------\n    n: integer\n    	Nominal slide number (one-based).\n\n    Examples\n    --------\n    > jumpTo( 2 )\n\n    See Also\n    --------\n    next, prev\n\n"
-next,"\nnext()\n    Moves the presentation to the next slide or slide fragment.\n\n    Examples\n    --------\n    > next()\n\n    See Also\n    --------\n    jumpTo, prev\n\n"
+next,"\nnext()\n    Moves the presentation to the next slide or slide fragment.\n\n    Examples\n    --------\n    > next()\n\n    See Also\n    --------\n    first, jumpTo, last, prev\n\n"
 numSlides,"\nnumSlides\n    Returns the presentation length.\n\n    Returns\n    -------\n    len: integer\n        Number of slides.\n\n    Examples\n    --------\n    > numSlides\n\n    See Also\n    --------\n    currentSlide, jumpTo, next, prev\n\n"
-prev,"\nprev()\n    Moves the presentation to the previous slide or slide fragment.\n\n    Examples\n    --------\n    > prev()\n\n    See Also\n    --------\n    jumpTo, next\n\n"
+prev,"\nprev()\n    Moves the presentation to the previous slide or slide fragment.\n\n    Examples\n    --------\n    > prev()\n\n    See Also\n    --------\n    first, jumpTo, last, next\n\n"
 runSlide,"\nrunSlide()\n    Runs slide code.\n\n    Examples\n    --------\n    > runSlide()\n\n    See Also\n    --------\n    next, prev\n\n"

lib/node_modules/@stdlib/repl/presentation/data/help.json

@@ -1 +1 @@
-{"currentSlide":"\ncurrentSlide\n    Returns the current presentation slide index.\n\n    The returned index is the nominal (i.e., one-based) slide index.\n\n    Returns\n    -------\n    idx: integer\n        Current presentation slide index.\n\n    Examples\n    --------\n    > currentSlide\n\n    See Also\n    --------\n    jumpTo, next, numSlides, prev\n\n","jumpTo":"\njumpTo( n )\n    Jumps to a specified slide, where `n` is the nominal slide number.\n\n    Parameters\n    ----------\n    n: integer\n    \tNominal slide number (one-based).\n\n    Examples\n    --------\n    > jumpTo( 2 )\n\n    See Also\n    --------\n    next, prev\n\n","next":"\nnext()\n    Moves the presentation to the next slide or slide fragment.\n\n    Examples\n    --------\n    > next()\n\n    See Also\n    --------\n    jumpTo, prev\n\n","numSlides":"\nnumSlides\n    Returns the presentation length.\n\n    Returns\n    -------\n    len: integer\n        Number of slides.\n\n    Examples\n    --------\n    > numSlides\n\n    See Also\n    --------\n    currentSlide, jumpTo, next, prev\n\n","prev":"\nprev()\n    Moves the presentation to the previous slide or slide fragment.\n\n    Examples\n    --------\n    > prev()\n\n    See Also\n    --------\n    jumpTo, next\n\n","runSlide":"\nrunSlide()\n    Runs slide code.\n\n    Examples\n    --------\n    > runSlide()\n\n    See Also\n    --------\n    next, prev\n\n"}
+{"currentSlide":"\ncurrentSlide\n    Returns the current presentation slide index.\n\n    The returned index is the nominal (i.e., one-based) slide index.\n\n    Returns\n    -------\n    idx: integer\n        Current presentation slide index.\n\n    Examples\n    --------\n    > currentSlide\n\n    See Also\n    --------\n    jumpTo, next, numSlides, prev\n\n","first":"\nfirst()\n    Jumps to the first slide.\n\n    Examples\n    --------\n    > first()\n\n    See Also\n    --------\n    jumpTo, last, next, prev\n\n","jumpTo":"\njumpTo( n )\n    Jumps to a specified slide, where `n` is the nominal slide number.\n\n    Parameters\n    ----------\n    n: integer\n    \tNominal slide number (one-based).\n\n    Examples\n    --------\n    > jumpTo( 2 )\n\n    See Also\n    --------\n    next, prev\n\n","next":"\nnext()\n    Moves the presentation to the next slide or slide fragment.\n\n    Examples\n    --------\n    > next()\n\n    See Also\n    --------\n    first, jumpTo, last, prev\n\n","numSlides":"\nnumSlides\n    Returns the presentation length.\n\n    Returns\n    -------\n    len: integer\n        Number of slides.\n\n    Examples\n    --------\n    > numSlides\n\n    See Also\n    --------\n    currentSlide, jumpTo, next, prev\n\n","prev":"\nprev()\n    Moves the presentation to the previous slide or slide fragment.\n\n    Examples\n    --------\n    > prev()\n\n    See Also\n    --------\n    first, jumpTo, last, next\n\n","runSlide":"\nrunSlide()\n    Runs slide code.\n\n    Examples\n    --------\n    > runSlide()\n\n    See Also\n    --------\n    next, prev\n\n"}

lib/node_modules/@stdlib/repl/presentation/data/info.csv

@@ -1,4 +1,5 @@
 currentSlide,"\ncurrentSlide\n    Returns the current presentation slide index.\n"
+first,"\nfirst()\n    Jumps to the first slide.\n"
 jumpTo,"\njumpTo( n )\n    Jumps to a specified slide, where `n` is the nominal slide number.\n"
 next,"\nnext()\n    Moves the presentation to the next slide or slide fragment.\n"
 numSlides,"\nnumSlides\n    Returns the presentation length.\n"

lib/node_modules/@stdlib/repl/presentation/data/info.json

@@ -1 +1 @@
-{"currentSlide":"\ncurrentSlide\n    Returns the current presentation slide index.\n","jumpTo":"\njumpTo( n )\n    Jumps to a specified slide, where `n` is the nominal slide number.\n","next":"\nnext()\n    Moves the presentation to the next slide or slide fragment.\n","numSlides":"\nnumSlides\n    Returns the presentation length.\n","prev":"\nprev()\n    Moves the presentation to the previous slide or slide fragment.\n","runSlide":"\nrunSlide()\n    Runs slide code.\n"}
+{"currentSlide":"\ncurrentSlide\n    Returns the current presentation slide index.\n","first":"\nfirst()\n    Jumps to the first slide.\n","jumpTo":"\njumpTo( n )\n    Jumps to a specified slide, where `n` is the nominal slide number.\n","next":"\nnext()\n    Moves the presentation to the next slide or slide fragment.\n","numSlides":"\nnumSlides\n    Returns the presentation length.\n","prev":"\nprev()\n    Moves the presentation to the previous slide or slide fragment.\n","runSlide":"\nrunSlide()\n    Runs slide code.\n"}

lib/node_modules/@stdlib/repl/presentation/docs/commands/first.txt

@@ -0,0 +1,12 @@
+
+first()
+    Jumps to the first slide.
+
+    Examples
+    --------
+    > first()
+
+    See Also
+    --------
+    jumpTo, last, next, prev
+

lib/node_modules/@stdlib/repl/presentation/docs/commands/next.txt

@@ -8,5 +8,5 @@ next()
 
     See Also
     --------
-    jumpTo, prev
+    first, jumpTo, last, prev
 

lib/node_modules/@stdlib/repl/presentation/docs/commands/prev.txt

@@ -8,5 +8,5 @@ prev()
 
     See Also
     --------
-    jumpTo, next
+    first, jumpTo, last, next
 

lib/node_modules/@stdlib/repl/presentation/lib/commands.js

@@ -21,6 +21,7 @@
 // MODULES //
 
 var onCurrentSlide = require( './commands/current_slide.js' );
+var onFirst = require( './commands/first.js' );
 var onJumpTo = require( './commands/jump_to.js' );
 var onNext = require( './commands/next.js' );
 var onNumSlides = require( './commands/num_slides.js' );
@@ -53,6 +54,7 @@ function commands( pres ) {
 	// Define a list of REPL presentation-specific commands (NOTE: keep in alphabetical order):
 	cmds = [];
 	cmds.push( [ 'currentSlide', '', onCurrentSlide( pres ), true ] );
+	cmds.push( [ 'first', 'f', onFirst( pres ), false ] );
 	cmds.push( [ 'jumpTo', 'j', onJumpTo( pres ), false ] );
 	cmds.push( [ 'next', 'n', onNext( pres ), false ] );
 	cmds.push( [ 'numSlides', '', onNumSlides( pres ), true ] );

lib/node_modules/@stdlib/repl/presentation/lib/commands/first.js

@@ -0,0 +1,55 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2019 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MAIN //
+
+/**
+* Returns a callback to be invoked upon calling the `first` command.
+*
+* @private
+* @param {Presentation} pres - presentation instance
+* @returns {Function} callback
+*/
+function command( pres ) {
+	return onCommand;
+
+	/**
+	* Jumps to the first slide.
+	*
+	* @private
+	*/
+	function onCommand() {
+		pres._repl.once( 'drain', onDrain ); // eslint-disable-line no-underscore-dangle
+
+		/**
+		* Callback invoked upon a `drain` event.
+		*
+		* @private
+		*/
+		function onDrain() {
+			pres.first().show();
+		}
+	}
+}
+
+
+// EXPORTS //
+
+module.exports = command;