orbit-up v4.2.2

ORBIT-UP

Project scaffolding powered by Orbit Ventures GmbH.

Usage

1. Install orbit-up CLI

npm i -g orbit-up

2. Set stack source

orbit-up config set source "git+git@gitlab.com:your/repository.git"

3. Setup new projects with orbit-up CLI

orbit-up create [options] [projectPath]

Usage: orbit-up create options

Create new project

Arguments: projectPath: Path where the project should be created. If omitted, the current directory is used.

Options: -s, --source Use the specified stacks source -c, --clear-cache Clear stacks source cache -h, --help display help for command

Stacks source anatomy

A stacks source consists of a configuration file (orbit-up.config.{ts,mts,mjs,js,json,cjs}) in its root directory.

Dependency version in package.json

If a dependency in package.json is set to * the CLI will change it to the latest version prefixed by caret (^).

If a dependency is set to a distribution tag (e.g. 'latest', 'next', 'rc') the resolved version will be used, prefixed by caret (^).

'____' convention for dot files

Files and directories containing '____' will be renamed:

'____gitignore' -> '.gitignore'

This is usefull for files that may cause unwanted behaviour in the CLI project.

Orbit Up variables in source files

When writing files to the projects target directory special Orbit Up variables in text files will be replaced.

Replace syntax:

<h2>orbit-up-var-projectDisplayName</h2>

Available values:

• orbit-up-var-projectName -> kebap cased project name
• orbit-up-var-projectDisplayName -> start cased project name
• orbit-up-var-date -> ISO data (YYYY-MM-DD)

Replace pattern:

/orbit-up-var-([\d\w]+)/g;