I need Help

[adamthewarrior]

This is a really cool project and I was wondering if you wouldn't mind explain how I might be able to add a command to the terminal somehow. I'm a beginner when it comes to Javascript but I can follow instructions really well... I hope you consider answering my question :) thanks in advance

[m4tt72]

Hello @loeffea886,

Let's create a helloWorld command, it will take no parameters, and will return a string in the terminal displaying Hello World.

First, you need to create a file in src/utils/bin called helloWorld.ts.

Then export a function helloWorld like the following:

export const helloWorld = async (args: string[]): Promise<string> => {
  return 'Hello world';
};

Now we need to export all the functions from that file in src/utils/bin/index.ts:

// ... The previous exports
export * from './helloWorld';

Done ;)

Passing args

If you want to pass arguments to the command, say you want your command to be helloWorld [name], anything you pass after the helloWorld command in the terminal, will be available in args parameter.

Let's use it now:

export const helloWorld = async (args: string[]): Promise<string> => {
  if (args.length > 0) {
    return `Hello ${args[0]}!`;
  } else {
    return 'Hello World!';
  }
};

Now the command helloWorld will print Hello World if there are no arguments passed, or Hello [name] if you pass an argument.

Exanple

[adamthewarrior]

Thank you so much! :)