Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@ionic/cli-framework

ionic-team310.1kMIT6.0.1TypeScript support: included

The foundation framework of the Ionic CLI

readme

CLI Framework, by Ionic

The foundation framework of the Ionic CLI.

Getting Started

index.js:

const { Command, CommandMap, Namespace, execute } = require('@ionic/cli-framework');

class VersionCommand extends Command {
  async getMetadata() {
    return {
      name: 'version',
      summary: 'Print CLI version',
    };
  }

  async run() {
    console.log('1.0.0');
  }
}

class RootNamespace extends Namespace {
  async getMetadata() {
    return {
      name: 'mynewcli',
      summary: 'A cool CLI that prints its own version',
    };
  }

  async getCommands() {
    return new CommandMap([['version', async () => new VersionCommand(this)]]);
  }
}

module.exports = async function(argv, env) {
  await execute({ namespace: new RootNamespace(), argv, env });
}

bin/mynewcli:

#!/usr/bin/env node

const run = require('../');
run(process.argv.slice(2), process.env);

command line:

$ ./bin/mynewcli
$ ./bin/mynewcli version
$ ./bin/mynewcli version --help

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

6.0.1 (2023-12-19)

Bug Fixes

6.0.0 (2023-11-08)

Bug Fixes

BREAKING CHANGES

  • message, stack, and error properties removed from BaseError and SubprocessError

5.1.7 (2023-11-08)

Reverts

5.1.6 (2023-11-07)

Note: Version bump only for package @ionic/cli-framework

5.1.5 (2023-11-07)

Bug Fixes

5.1.4 (2023-03-29)

Note: Version bump only for package @ionic/cli-framework

5.1.3 (2022-06-16)

Note: Version bump only for package @ionic/cli-framework

5.1.2 (2022-05-09)

Note: Version bump only for package @ionic/cli-framework

5.1.1 (2022-03-04)

Note: Version bump only for package @ionic/cli-framework

5.1.0 (2020-12-10)

Features

  • config: add spaces option when writing JSON config (#4612) (fdd9bb2)

5.0.6 (2020-09-29)

Note: Version bump only for package @ionic/cli-framework

5.0.5 (2020-09-24)

Note: Version bump only for package @ionic/cli-framework

5.0.4 (2020-09-02)

Note: Version bump only for package @ionic/cli-framework

5.0.3 (2020-08-29)

Note: Version bump only for package @ionic/cli-framework

5.0.2 (2020-08-28)

Note: Version bump only for package @ionic/cli-framework

5.0.1 (2020-08-27)

Note: Version bump only for package @ionic/cli-framework

5.0.0 (2020-08-27)

Code Refactoring

  • do not re-export from @ionic/cli-framework-output (a91b5a4)

BREAKING CHANGES

  • Install @ionic/cli-framework-output and import from it directly.

4.2.2 (2020-08-26)

Note: Version bump only for package @ionic/cli-framework

4.2.1 (2020-08-25)

Note: Version bump only for package @ionic/cli-framework

4.2.0 (2020-06-02)

Features

  • help: formatBeforeInputSummary and formatAfterInputSummary (70ac3ab)

4.1.5 (2020-05-12)

Bug Fixes

  • pin tslib to avoid "Cannot set property pathExists" error (689e1f0)

4.1.4 (2020-05-06)

Note: Version bump only for package @ionic/cli-framework

4.1.3 (2020-04-29)

Note: Version bump only for package @ionic/cli-framework

4.1.2 (2020-03-30)

Note: Version bump only for package @ionic/cli-framework

4.1.1 (2020-03-03)

Note: Version bump only for package @ionic/cli-framework

4.1.0 (2020-02-11)

Features

4.0.2 (2020-02-10)

Note: Version bump only for package @ionic/cli-framework

4.0.1 (2020-02-03)

Bug Fixes

  • help: use proper full command/namespace name, not alias (e42efc6)

4.0.0 (2020-01-25)

chore

BREAKING CHANGES

  • A minimum of Node.js 10.3.0 is required.

3.0.6 (2020-01-13)

Note: Version bump only for package @ionic/cli-framework

3.0.5 (2019-12-10)

Bug Fixes

  • help: make namespace/command groups unique when displaying (32215b2)

3.0.4 (2019-12-05)

Note: Version bump only for package @ionic/cli-framework

3.0.3 (2019-11-25)

Note: Version bump only for package @ionic/cli-framework

3.0.2 (2019-11-24)

Bug Fixes

  • fix parsing of command line options (060f67c)

3.0.1 (2019-11-21)

Note: Version bump only for package @ionic/cli-framework

3.0.0 (2019-10-14)

Code Refactoring

  • prompts: remove prompt support (82241ef)

BREAKING CHANGES

  • prompts: This package no longer supports interactive prompts. See @ionic/cli-framework-prompts.

2.1.8 (2019-10-14)

Note: Version bump only for package @ionic/cli-framework

2.1.7 (2019-09-18)

Note: Version bump only for package @ionic/cli-framework

2.1.6 (2019-08-28)

Note: Version bump only for package @ionic/cli-framework

2.1.5 (2019-08-23)

Note: Version bump only for package @ionic/cli-framework

2.1.4 (2019-08-14)

Bug Fixes

  • help: custom colors are not passed to SchemaHelpFormatter (#4115) (5634e9f)

2.1.3 (2019-08-07)

Note: Version bump only for package @ionic/cli-framework

2.1.2 (2019-07-09)

Note: Version bump only for package @ionic/cli-framework

2.1.1 (2019-06-28)

Note: Version bump only for package @ionic/cli-framework

2.1.0 (2019-06-21)

Features

  • validators: combine for combining validators into one (bcef698)

2.0.3 (2019-06-18)

Note: Version bump only for package @ionic/cli-framework

2.0.2 (2019-06-10)

Note: Version bump only for package @ionic/cli-framework

2.0.1 (2019-06-05)

Note: Version bump only for package @ionic/cli-framework

2.0.0 (2019-05-29)

chore

  • output: remove unused BottomBar stuff (e2023d1)
  • require Node 8 (5670e68)

Features

BREAKING CHANGES

  • output: Remove BottomBarOutputStrategy
  • A minimum of Node.js 8.9.4 is required.
  • help: option/command/namespace groups are now MetadataGroup

1.7.0 (2019-03-12)

Features

  • help: add flair for paid content (e7978e2)

1.6.3 (2019-03-06)

Note: Version bump only for package @ionic/cli-framework

1.6.2 (2019-02-27)

Note: Version bump only for package @ionic/cli-framework

1.6.1 (2019-02-15)

Note: Version bump only for package @ionic/cli-framework

1.6.0 (2019-01-23)

Features

  • help: text/link footnotes for descriptions (2c74d53)

1.5.3 (2019-01-08)

Note: Version bump only for package @ionic/cli-framework

1.5.2 (2019-01-07)

Note: Version bump only for package @ionic/cli-framework

1.5.1 (2018-12-19)

Note: Version bump only for package @ionic/cli-framework

1.5.0 (2018-11-27)

Features

  • help: weaken the color of deprecated commands and options (66f48d8)
  • shell: error for subprocesses that exit via signal (3af1cee)

1.4.0 (2018-11-20)

Bug Fixes

Features

  • help: spec for customizing option help schema (73830bc)

1.3.0 (2018-11-04)

Bug Fixes

  • start: fix stdio freezing issue on Windows (#3725) (a570770)

Features

  • fn: add function for resolving values from function series (ac97f78)

1.2.0 (2018-10-31)

Bug Fixes

  • config: write json file with ending newline (dc3f2a5)
  • help: filter out unnecessary global options (7809c99)
  • process: keep node running for sleepForever() (ea08f8d)

Features

  • namespace: add useAliases option to locate() (489617b)
  • object: add keysWithoutAliases() method to AliasedMap (f4807f4)
  • terminal: detect windows shell (dcc912d)

1.1.1 (2018-10-05)

Note: Version bump only for package @ionic/cli-framework

1.1.0 (2018-10-03)

Features

  • shell: accept pathed name (7e6c713)
  • shell: provide which utility for finding binaries (4dbe922)

1.0.7 (2018-09-05)

Note: Version bump only for package @ionic/cli-framework

1.0.6 (2018-08-20)

Bug Fixes

  • process: catch and log errors in exit queue (f3cd886)

1.0.5 (2018-08-09)

Bug Fixes

  • serve: fix unclosed connection issue again (#3500) (1f0ef3b)

1.0.4 (2018-08-07)

Note: Version bump only for package @ionic/cli-framework

1.0.3 (2018-08-06)

Bug Fixes

  • serve: properly cleanup child processes (#3481) (38217bf)
  • serve: use 127.0.0.1 to attempt connections (#3476) (12c3f35)

1.0.2 (2018-08-02)

Bug Fixes

  • serve: check all network interfaces for an available port (30fd6ef)

1.0.1 (2018-07-30)

Note: Version bump only for package @ionic/cli-framework

1.0.0 (2018-07-25)

Note: Version bump only for package @ionic/cli-framework