Skip to content

cmds

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

cmds

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
bin
bin
 
 
docs
docs
 
 
etc
etc
 
 
examples
examples
 
 
lib
lib
 
 
test
test
 
 
README.md
README.md
 
 
package.json
package.json
 
 

README.md

Package Commands

Find package command-line interface (CLI) commands.

Usage

var findCommands = require( '@stdlib/_tools/pkgs/cmds' );

findCommands( [options,] clbk )

Asynchronously searches for package command-line interface commands.

findCommands( done );

function done( error, cmds ) {
    if ( error ) {
        throw error;
    }
    console.log( cmds.join( '\n' ) );
}

The function accepts the following options:

  • dir: root directory from which to search for packages. May be either an absolute path or a path relative to the current working directory. Default: current working directory.
  • pattern: glob pattern used to find packages. Default: '**/package.json' (note: pattern must end with package.json).
  • ignore: list of glob patterns used to exclude matches.

To search from an alternative directory, set the dir option.

var opts = {
    'dir': '/foo/bar/baz'
};

findCommands( opts, done );

function done( error, cmds ) {
    if ( error ) {
        throw error;
    }
    console.log( cmds.join( '\n' ) );
}

To provide an alternative include filter, set the pattern option.

var opts = {
    'pattern': '**/foo/**/package.json'
};

findCommands( opts, done );

function done( error, cmds ) {
    if ( error ) {
        throw error;
    }
    console.log( cmds.join( '\n' ) );
}

To exclude matches, set the ignore option.

var opts = {
    'ignore': [
        'node_modules/**',
        'build/**',
        'reports/**'
    ]
};

findCommands( opts, done );

function done( error, cmds ) {
    if ( error ) {
        throw error;
    }
    console.log( cmds.join( '\n' ) );
}

findCommands.sync( [options] )

Synchronously searches for package command-line interface commands.

var files = findCommands.sync();
// returns [...]

The function accepts the same options as findCommands() above.

Notes

  • The implementation resolves command-line interfaces by reading package.json files and extracting command names found in the bin field.
  • No attempt is made to ensure that a command-line interface implementation exists.
  • The implementation assumes that a bin field is valid; i.e., either a string or an object.

Examples

var resolve = require( 'path' ).resolve;
var findCommands = require( '@stdlib/_tools/pkgs/cmds' );

var opts = {
    'dir': resolve( __dirname, '..', '..' )
};

findCommands( opts, done );

function done( error, cmds ) {
    if ( error ) {
        throw error;
    }
    console.log( cmds.join( '\n' ) );
}

CLI

Usage

Usage: find-pkg-cmds [options] [<dir>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --pattern pattern     Inclusion glob pattern.
         --ignore pattern      Exclusion glob pattern.

Notes

  • If not provided a dir argument, the current working directory is the search directory.

  • To provide multiple exclusion glob patterns, set multiple --ignore option arguments.

    $ find-pkg-cmds --ignore=node_modules/** --ignore=build/** --ignore=reports/**

Examples

$ find-pkg-cmds
<cmd>
<cmd>
...