Move makie executable and move tool to list file names

kgryte · kgryte · commit bf72df9b84a9 · 2016-08-02T13:21:05.000-05:00
diff --git a/tools/bin/makie b/tools/bin/makie
@@ -16,13 +16,13 @@ else
 fi
 
 # Define the path to the `makie` executable:
-makie=`dirname "$0"`/../tools/makie/makie/bin/cli
+makie=`dirname "$0"`/../makie/makie/bin/cli
 
 # Define the path to the `makie` configuration file:
-makie_config=`dirname "$0"`/../etc/.makie.js
+makie_config=`dirname "$0"`/../../etc/.makie.js
 
 # Define the path to the Makefile directory:
-makie_makefile_dir=`dirname "$0"`/../
+makie_makefile_dir=`dirname "$0"`/../../
 
 
 # FUNCTIONS #
diff --git a/tools/ls/module-names/bin/cli b/tools/ls/module-names/bin/cli
@@ -9,7 +9,7 @@ var parseArgs = require( 'minimist' );
 var notifier = require( 'update-notifier' );
 var pkg = require( './../package.json' );
 var opts = require( './opts.json' );
-var list = require( './../lib' );
+var ls = require( './../lib' );
 
 
 // FUNCTIONS //
@@ -78,7 +78,7 @@ if ( args.version ) {
 
 // MAIN //
 
-list( onList );
+ls( onList );
 
 /**
 * Callback invoked after retrieving a list of module names.
diff --git a/tools/ls/module-names/bin/opts.json b/tools/ls/module-names/bin/opts.json
diff --git a/tools/ls/module-names/bin/usage.txt b/tools/ls/module-names/bin/usage.txt
diff --git a/tools/ls/module-names/examples/index.js b/tools/ls/module-names/examples/index.js
@@ -1,8 +1,8 @@
 'use strict';
 
-var list = require( './../lib' );
+var ls = require( './../lib' );
 
-list( onList );
+ls( onList );
 
 function onList( error, names ) {
 	if ( error ) {
diff --git a/tools/ls/module-names/lib/async.js b/tools/ls/module-names/lib/async.js
@@ -6,17 +6,16 @@ var glob = require( 'glob' );
 var path = require( 'path' );
 var stdlib = require( './stdlib.js' );
 var isFunction = require( stdlib+'@stdlib/utils/is-function' );
-var dirname = require( stdlib+'@stdlib/utils/dirname' );
+var transform = require( './transform.js' );
+var config = require( './config.json' );
 
 
 // VARIABLES //
 
-var PATTERN = '**/package.json';
 var ROOT = path.resolve( __dirname, stdlib );
-var MATCH = /\@stdlib/;
 
 
-// ASYNC //
+// LS //
 
 /**
 * Asynchronously generates a list of stdlib module names.
@@ -25,7 +24,7 @@ var MATCH = /\@stdlib/;
 * @throws {TypeError} must provide a function
 *
 * @example
-* list( onList );
+* ls( onList );
 *
 * function onList( error, names ) {
 *     if ( error ) {
@@ -34,15 +33,15 @@ var MATCH = /\@stdlib/;
 *     console.dir( names );
 * }
 */
-function list( clbk ) {
+function ls( clbk ) {
 	var opts;
 	if ( !isFunction( clbk ) ) {
 		throw new TypeError( 'invalid input argument. Must provide a function. Value: `' + clbk + '`.' );
 	}
 	opts = {
 		'cwd': ROOT
 	};
-	glob( PATTERN, opts, onGlob );
+	glob( config.pattern, opts, onGlob );
 
 	/**
 	* Callback invoked after matching files.
@@ -52,27 +51,14 @@ function list( clbk ) {
 	* @param {StringArray} names - list of matching files
 	*/
 	function onGlob( error, names ) {
-		var match;
-		var name;
-		var out;
-		var i;
 		if ( error ) {
 			return clbk( error );
 		}
-		out = [];
-		for ( i = 0; i < names.length; i++ ) {
-			match = names[ i ].match( MATCH );
-			if ( match ) {
-				name = names[ i ].substring( match.index );
-				name = dirname( name );
-				out.push( name );
-			}
-		}
-		clbk( null, out );
+		clbk( null, transform( names ) );
 	} // end FUNCTION onGlob()
-} // end FUNCTION list()
+} // end FUNCTION ls()
 
 
 // EXPORTS //
 
-module.exports = list;
+module.exports = ls;
diff --git a/tools/ls/module-names/lib/config.json b/tools/ls/module-names/lib/config.json
@@ -0,0 +1,3 @@
+{
+	"pattern": "**/package.json"
+}
diff --git a/tools/ls/module-names/lib/index.js b/tools/ls/module-names/lib/index.js
@@ -3,12 +3,12 @@
 /**
 * List stdlib module names.
 *
-* @module @stdlib/tools/misc/stdlib-module-names
+* @module @stdlib/tools/ls/module-names
 *
 * @example
-* var list = require( '@stdlib/tools/misc/stdlib-module-names' );
+* var ls = require( '@stdlib/tools/ls/module-names' );
 *
-* list( onList );
+* ls( onList );
 *
 * function onList( error, names ) {
 *     if ( error ) {
@@ -18,25 +18,25 @@
 * }
 *
 * @example
-* var list = require( '@stdlib/tools/misc/stdlib-module-names' );
+* var ls = require( '@stdlib/tools/ls/module-names' );
 *
-* var names = list.sync();
+* var names = ls.sync();
 * // returns [...]
 */
 
 // MODULES //
 
 var stdlib = require( './stdlib.js' );
 var setReadOnly = require( stdlib+'@stdlib/utils/define-read-only-property' );
-var list = require( './async.js' );
+var ls = require( './async.js' );
 var sync = require( './sync.js' );
 
 
 // METHODS //
 
-setReadOnly( list, 'sync', sync );
+setReadOnly( ls, 'sync', sync );
 
 
 // EXPORTS //
 
-module.exports = list;
+module.exports = ls;
diff --git a/tools/ls/module-names/lib/stdlib.js b/tools/ls/module-names/lib/stdlib.js
diff --git a/tools/ls/module-names/lib/sync.js b/tools/ls/module-names/lib/sync.js
@@ -0,0 +1,41 @@
+'use strict';
+
+// MODULES //
+
+var glob = require( 'glob' ).sync;
+var path = require( 'path' );
+var stdlib = require( './stdlib.js' );
+var transform = require( './transform.js' );
+var config = require( './config.json' );
+
+
+// VARIABLES //
+
+var ROOT = path.resolve( __dirname, stdlib );
+
+
+// LS //
+
+/**
+* Synchronously generates a list of stdlib module names.
+*
+* @returns {StringArray} list of names
+*
+* @example
+* var names = ls();
+* // returns [...]
+*/
+function ls() {
+	var names;
+	var opts;
+	opts = {
+		'cwd': ROOT
+	};
+	names = glob( config.pattern, opts );
+	return transform( names );
+} // end FUNCTION ls()
+
+
+// EXPORTS //
+
+module.exports = ls;
diff --git a/tools/ls/module-names/lib/transform.js b/tools/ls/module-names/lib/transform.js
@@ -0,0 +1,50 @@
+'use strict';
+
+// MODULES //
+
+var stdlib = require( './stdlib.js' );
+var dirname = require( stdlib+'@stdlib/utils/dirname' );
+
+
+// VARIABLES //
+
+var MATCH = /\@stdlib/;
+
+
+// TRANSFORM //
+
+/**
+* Transforms a raw `package.json` list into module names.
+*
+* @private
+* @param {StringArray} files - list of `package.json` absolute file paths
+* @returns {StringArray} names - list of module names
+*
+* @example
+* var files = [ '/stdlib/stdlib/lib/node_modules/@stdlib/math/constants/float64-min-safe-integer/package.json' ];
+*
+* var names = transform( files );
+* // returns [ '@stdlib/math/constants/float64-min-safe-integer' ]
+*/
+function transform( files ) {
+	var match;
+	var name;
+	var out;
+	var i;
+
+	out = [];
+	for ( i = 0; i < files.length; i++ ) {
+		match = files[ i ].match( MATCH );
+		if ( match ) {
+			name = files[ i ].substring( match.index );
+			name = dirname( name );
+			out.push( name );
+		}
+	}
+	return out;
+} // end FUNCTION transform()
+
+
+// EXPORTS //
+
+module.exports = transform;
diff --git a/tools/ls/module-names/package.json b/tools/ls/module-names/package.json
@@ -15,6 +15,7 @@
     "tools",
     "tool",
     "list",
+    "ls",
     "modules",
     "names"
   ],
diff --git a/tools/makie/makie/README.md b/tools/makie/makie/README.md
@@ -113,13 +113,13 @@ function plugin( dir, cwd ) {
 To install the command-line utility, add the following line to your `~/.bashrc` (Linux) or `~/.bash_profile` (Mac OS X), making sure to adjust the path based on your project setup.
 
 ``` text
-alias makie=/path/to/stdlib/bin/makie
+alias makie=/path/to/stdlib/tools/bin/makie
 ```
 
 and then
 
 ``` bash
-$ chmod +x /path/to/stdlib/bin/makie
+$ chmod +x /path/to/stdlib/tools/bin/makie
 ```
 
 <!-- </installation> -->
diff --git a/tools/misc/stdlib-module-names/lib/sync.js b/tools/misc/stdlib-module-names/lib/sync.js

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "pattern": "**/package.json"`
	`3`	`+}`