presentio v2.0.0-beta.1

Presentio

CLI-Info... in style!

Presentio helps you to present your CLI info in a nice way.

Add as a Dependency

npm install presentio
# or
yarn add presentio

Usage/Examples

# @example (Hyper: Project-Generator CLI)
-----------------------------------------

import Present from 'presentio';

# Separated text for visual clarity
const thingToLog = `
Usage:
  $ hyper <commands> [options]

Commands:
  init   Initialize a new project
  list   List all available templates

Options:
  -h, --help      Show CLI help
  -c, --clear     Clear Terminal
  -v, --version   Show CLI version
  -r, --rainbow   I don't know what this does
`;

Present(
	{
	  title: 'Hyper',
	  tagLine: 'by @Shorky',
	  description: 'A CLI to bootstrap new projects!',
	  version: '1.0',
	  fgColor: 'white',  # optional
	  bgColor: 'green',  # optional
	  clear: true        # optional
	},
    thingToLog
    # or use the blt-in hlpTxt() fn
    # (basically, it's thingToLog but... with colors, separators, etc!)
    hlpTxt(
      'name-to-display',

      # cmds goes here
      # follow general format of:
      # cmd: 'description'
      {
        init: 'Initialize a new project',
        list: 'List all available templates'
      },

      # options (flags) goes here
      # follow general format of:
      # '-alias, --option': 'description'
      {
        '-h, --help': 'Show CLI help',
        '-c, --clear': 'Clear Terminal',
        '-v, --version': 'Show CLI version',
        '-r, --rainbow': 'I don't know what this does'
      }
    )
);

# output
# (rainbows included ;D)
# (formatting also!)
------------------------

Hyper v1.0 by @Shorky
A CLI to bootstrap new projects!

Usage:
  $ hyper <commands> [options]

Commands:
  init   Initialize a new project
  list   List all available templates

Options:
  -h, --help  Show CLI help
  -c, --clear  Clear Terminal
  -v, --version  Show CLI version

The Why?

Why use Presentio instead of console.log()?
-------------------------------------------------------

  - Elegent
  - Colorful
  - Readable
  - & Minimal

Why create a whole library for this?
------------------------------------

Presentio is a tool that was originally created for the `Hyper-CLI`;
The use of various libraries to just log some basic colored txt & a help msg was too excessive.
Here aroused the idea to create a fully fletched yet lightwieght library.
& that's how `Presentio` was born.

Available Clrs (for fg&bg)

- Black
- Red
- Green
- Yellow
- Blue
- Magenta
- Cyan
- White

Project Tree (For contributors)

📦 <Presentio>
├─ .circleci
│  └─ config.yml
├─ .github
│  ├─ ISSUE_TEMPLATE
│  │  ├─ BUG_REPORT.md
│  │  └─ FEATURE_REQUEST.md
│  ├─ workflows
│  │  └─ CodeQL.yml
│  └─ PULL_REQUEST_TEMPLATE.md
├─ .husky
│  └─ pre-commit
├─ Docs
│  ├─ CODE_OF_CONDUCT.md
│  ├─ CONTRIBUTING.md
│  └─ SECURITY.md
├─ Lib
│  ├─ Interfaces
│  │  └─ Options.ts
│  ├─ Modules
│  │  ├─ Clear.ts
│  │  ├─ Clrs.ts
│  │  └─ Fmt.ts
│  ├─ Utils
│  │  └─ Space.ts
│  ├─ Info.ts
│  └─ Present.ts
├─ Tests
│  └─ Present.Test.mjs
├─ .gitignore
├─ .prettierrc  # Available within package.json
├─ README.md
├─ package.json
├─ tsconfig.json
└─ LICENSE

License

#
# Copyright 2022 @SharkSV
# License Identifier: MIT
#