generator-util

generator-util

Utils for generate generators.

• Install
• Usage
• API
• Related projects
• Running tests
• Contributing
• Author
• License

(TOC generated by verb using markdown-toc)

Install

Install with npm:

$ npm i generator-util --save

Usage

var util = require('generator-util');

API

.isObject

Returns true if a the given value is an object.

Params

• value {any}
• returns {Boolean}

Example

utils.isObject('foo');
//=> false

utils.isObject({});
//=> true

.arrayify

Cast the given value to an array.

Params

• value {String|Array}
• returns {Array}

Example

utils.arrayify('foo');
//=> ['foo']

utils.arrayify(['foo']);
//=> ['foo']

.exists

Return true if a filepath exists on the file system.

Params

• filepath {String}
• returns {Boolean}

Example

utils.exists('foo');
//=> false

utils.exists('gulpfile.js');
//=> true

.toAlias

Opposite of .toFullname, creates an "alias" from the given name by either stripping options.prefix from the name, or just removing everything up to the first dash. If options.alias is a function, it will be used instead.

Params

• name {String}
• options {Object}
• returns {String}

Example

utils.toAlias('generate-foo');
//=> 'foo';

utils.toAlias('a-b-c', {prefix: 'a-b'});
//=> 'c';

.toFullname

Opposite of .toAlias, creates a generator name from the given alias and namespace.

Params

• alias {String}
• namespace {String}
• returns {String}

Example

utils.toFullname('foo', 'generate');
//=> 'generate-foo';

utils.toFullname('generate-bar', 'generate');
//=> 'generate-bar'

.toGeneratorPath

Create an object-path for looking up a generator.

Params

• name {String}
• returns {String}

Example

utils.toGeneratorPath('a.b.c');
//=> 'generators.a.generators.b.generators.c'

.tryResolve

Try to require.resolve module name, first locally then in the globaly npm directory. Fails silently if not found.

Params

• name {String}: The name or filepath of the module to resolve
• options {Object}: Pass options.cwd and/or options.configfile (filename) to modify the path used by resolve.
• returns {String|undefined}

Example

utils.tryResolve('foo');
// or
utils.tryResolve('generate-foo');
// or
utils.tryResolve('generate-foo', {cwd: require('global-modules')});
// or
utils.tryResolve('./foo/bar/baz.js');

.tryRequire

Try to require the given module, failing silently if it doesn't exist. The function first calls require on the given name, then tries require(path.resolve(name)) before giving up.

Params

• name {String}: The module name or file path
• returns {any|undefined}: Returns the value of requiring the specified module, or undefined if unsuccessful.

Example

utils.tryRequire('foo');

Related projects

You might also be interested in these projects:

• base: base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage
• base-fs: base-methods plugin that adds vinyl-fs methods to your 'base' application for working with the file… more | homepage
• base-pipeline: base-methods plugin that adds pipeline and plugin methods for dynamically composing streaming plugin pipelines. | homepage
• base-plugins: Upgrade's plugin support in base-methods to allow plugins to be called any time after init. | homepage
• base-runner: Orchestrate multiple instances of base-methods at once. | homepage
• base-tasks: base-methods plugin that provides a very thin wrapper around https://github.com/jonschlinkert/composer for adding task methods to… more | homepage
• generate: Fast, composable, highly extendable project generator with a user-friendly and expressive API. | homepage

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/doowb

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.

---

This file was generated by verb on January 29, 2016.