@ou-imdt/imdt-create v1.2.1

imdt-create

Features

• Automatic argument parsing, help text, and welcome message.
• History to maintain the last input data like author email.
• Checks Node.js version and notifies if Long Term Support (LTS) version is not used.

Compatibility note:

imdt-create requires Node.js LTS version, check LTS versions of Node.js

Install

Using NPX (recommended)

NPX is a package executer, and it is used to execute javascript packages directly, without installing them. imdt-create is a CLI tool, and it is recommended to use NPX as it will always use the latest version of the package.

npx @ou-imdt/imdt-create

or

# Global install
npm install @ou-imdt/imdt-create -g

Update to the latest version

npm update -g @ou-imdt/imdt-create

Usage

Run the imdt-create using

imdt-create <command> [option]

Then answer the following questions to generate a boilerplate.

Widget name?
Widget description?
Widget author? (name <email> **)

** will be fetched from git config if git confidentials do not exists you will be prompted to enter them.

Commands

help  Prints help info

Options

-c, --clear    Clear the console Default: true
-v, --version  Print CLI version Default: false

Changelog

❯ Read the changelog here →

Contribution guides

Boilerplate as a git submodule

Make sure to update Git submodule to pull latest changes from the Boilerplate repository.

git submodule update --remote --merge

Local testing:

Run npm link in the imdt-create directory to test the locally installed package.

Run npm unlink to remove the local package.

--debug/-d flag is available to see the debug logs.

Pre-publish tasks:

Bump the version number in package.json and changelog.md files.

npm publish dry run: npm publish --dry-run to get a preview of the files that will be published.

Git commit and push the changes.

Check if logged in to npm: npm whoami

If not logged in, login to npm: npm login

Publish the package: npm publish --access public 🚀