@deep-foundation/create-typescript-npm-package

Creates a new npm package with typescript support that will help you to manage your deep package. Uses @deep-foundation/typescript-npm-package-template as a template

Table Of Contents

• Table Of Contents
• Library
• Cli
  • Cli Usage
    • create-typescript-npm-package
  • Cli Usage Ways
    • Directly running using npx
    • Global Installation
      • Global installation and running using binary name
      • Global installation and running using npx
    • Local installation
      • Local installation and running using npx
      • Local installation and running using npm script

Library

See Documentation for examples and API

Cli

Cli Usage

create-typescript-npm-package

create-typescript-npm-package [Options]

Creates a new npm package with typescript support that will help you to manage y
our deep package. Uses [`@deep-foundation/typescript-npm-package-template`](http
s://github.com/deep-foundation/typescript-npm-package-template) as a template

Options:
  --help            Show help                                          [boolean]
  --version         Show version number                                [boolean]
  --directory-name  The name of the directory where the package will be created
                                                             [string] [required]
  --package-name    The name of the package                  [string] [required]
  --description     The description of the package                      [string]
  --repository-url  The url of the repository                           [string]

Cli Usage Ways

If you are going to use this package in a project - it is recommended to install it is Locally
If you are going to use this package for yourself - it is recommended to install it Globally or run it directly using npx

Directly running using npx

npx --yes @deep-foundation/create-typescript-npm-package

Global Installation

Global installation and running using binary name

npm install --global @deep-foundation/create-typescript-npm-package
/home/runner/work/create-typescript-npm-package/create-typescript-npm-package/dist/cli/create-typescript-npm-package

Global installation and running using npx

npm install --global @deep-foundation/create-typescript-npm-package
npx /home/runner/work/create-typescript-npm-package/create-typescript-npm-package/dist/cli/create-typescript-npm-package

Local installation

Local installation and running using npx

npm install @deep-foundation/create-typescript-npm-package
npx /home/runner/work/create-typescript-npm-package/create-typescript-npm-package/dist/cli/create-typescript-npm-package

Local installation and running using npm script

npm install @deep-foundation/create-typescript-npm-package

Add npm script to package.json. Note that you can name your script as you want but it must call binary file provided by the package

{
  "scripts": {
    "/home/runner/work/create-typescript-npm-package/create-typescript-npm-package/dist/cli/create-typescript-npm-package": "/home/runner/work/create-typescript-npm-package/create-typescript-npm-package/dist/cli/create-typescript-npm-package"
  }
}

and run

npm run /home/runner/work/create-typescript-npm-package/create-typescript-npm-package/dist/cli/create-typescript-npm-package