Create commands for your NodeJS Project
Report Bug
·
Request Feature
The documentation is under development. You are welcome to review the source code and document it. It will be completed soon. You can explore the code for un-documented features.
npm i sca-command --save
Register commander as follows
import { Comander } from "sca-command";
const commandManager = await Commander.start();
To create a command
export class AwesomeCommand extends BaseCommand<TData> {
public commandName(): string {
return "awesome-command";
}
public async commandAction(commandArguments: KeyValueArgument[], flags: string[]): Promise<void> {
console.log("This is an awesome command"); // This is an awesome command
console.log("Command arguments: ", commandArguments);
console.log("Command flags: ", flags);
}
}
To register command:
commandManager.registerCommands([
import("@/somewhere/in/app/awesome.command"),
])
Register entry point for commands in package.json
:
{
//
"scripts": {
"my-app": "node dist/index.js awesome-command"
}
}
To run the command manager:
await commandManager.run();
Compile the project and run the below code from command line:
npm run my-app awesome-command
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt
for more information.
Yahoo: mwaqar666@yahoo.com
Google: muhammadwaqar666@gmail.com