ts-commands - Readme

Installation

1. npm i ts-commands

Creating Commands

Create a command file:

src/bin/greet-command.ts

1import { Command, OptionType } from '../src';
2
3interface Args {
4	fname: string;
5	lname: string;
6	informal?: boolean;
7}
8
9export class GreetCommmand extends Command {
10	signature = 'greet [fname] [lname]';
11	description = 'say hello';
12
13	positional = [
14		{
15			key: 'fname',
16			type: OptionType.string,
17			description: 'first name',
18			default: 'Tom',
19		},
20		{
21			key: 'lname',
22			type: OptionType.string,
23			description: 'last name',
24			default: 'Tester',
25		},
26	];
27
28	options = [
29		{
30			key: 'informal',
31			type: OptionType.boolean,
32			default: false,
33			description: 'Informal?',
34		},
35	];
36
37	async handle(args: Args) {
38		const greeting = args.informal ? 'yo' : 'hello';
39
40		console.log(`${greeting} ${args.fname} ${args.lname}`);
41	}
42}

Register Commands

Create an index file to register your command(s):

src/bin/index.ts

1import { registerCommands } from 'ts-commands';
2import { GreetCommmand } from './greet-command';
3
4registerCommands({
5	name: 'examples',
6	commands: [GreetCommmand],
7});

Create Additional Commands

1. Repeat "Creating Commands" section for each command
2. Add each command in the commands array of registerCommands