mickambar19 / create-node-ts-cli

CLI tool to create base structure for new cli tools

Overview

Using this tool you will quickly start creating your own cli tools either for personal use or for your development team

Getting started

• Create the project by executing the following command

    $ npm init node-ts-cli@latest my-project

• Install the dependencies

  $ cd my-project
  $ yarn install

• Start creating the code in the src folder using typescript and run it with dev

  $ yarn dev

Motivation and features

• Javascript developer can avoid learning curve on how to write Bash Scripts

• Enforce good standards to get quality code using popular tools

• Reduce the effort overthinking which packages to use or defining the basic structure

Contributing

You can always help to improve this tool. See CONTRIBUTING.md for more information to have you onboard.

License

Create Node TS CLI is open source software licensed as MIT.

create-node-ts-cli's Issues

As a user, I want to have a sample file with tests so I can start writing tests of my cli

As a user, I want to be able to have a cli project which support ECMAScript modules to avoid errors with third party libraries

A user commonly use another package to ask questions through the terminal or parse arguments. These well known packages commonly support ECMAScript modules and do not have backward compatibility with Common JS in latest version of the package.
This leads to the next message

Error [ERR_REQUIRE_ESM]: require() of ES Module node_modules/inquirer/lib/inquirer.js from csv-to-insert/index.ts not supported. Instead change the require of inquirer.js in csv-to-insert/index.ts to a dynamic import() which is available in all CommonJS modules. }

You can read more about this problem in an issue of inquirer library