function-factory v6.0.0

function-factory

Simple, minimalist templating from the command line.

Table of Contents

• Background
• Install
• Usage
• API
• Contributing
• License

Background

Install

Example using pnpm:

pnpm add --save function-factory

It can, of course, also be installed by npm or Yarn using the normal methods.

Usage

To use the command-line interface:

[pnpm] function-factory [options]

Remember to prepend pnpm to the command when you haven't installed it globally.

CLI

function-factory

Simple, minimalist templating from the command line.

Options

-h, --help Writes this help text to STDOUT.
-n, --noop Reserved Show what would be done without actually doing it.
-v, --verbose Verbose output to STDERR.
-V, --version Writes version information to STDOUT.
-x, --no-quick-exit Don't immediately exit after printing help, version, and/or config
information.
-i, --stdin Read input from STDIN.
-I, --input string The path to the file to read input from.
-e, --edit string Edit the input in $EDITOR, optionally specifying a file in the "defaults"
directory to use as a base.
-a, --ask string Reserved Interactively prompt for input properties, optionally specifying a file in the "defaults" directory to use as a base.
-D, --do string Reserved Select a default input file and an output template based on a
single string.
-o, --stdout Write output to STDOUT.
-O, --output string The name of the file to write output to.
-p, --pasteboard Copy output to pasteboard (clipboard).
-c, --config Print search paths and configuration values to STDOUT.
-C, --config-file string Use the given config file instead of the default.
-d, --defaults Reserved Print a list of the "defaults" files.
-l, --templates Reserved Print a list of available templates to stdout.
-T, --template-override string Override the template to the file specified.

# API
```js
import FunctionFactory from 'function-factory';

FunctionFactory.load( options );

See docs/lib.md for full API.

Contributing

Changes are tracked in CHANGELOG.md.

License

MIT ©2020-2022 Anadian

SEE LICENSE IN LICENSE

\ This project's documentation is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.