LoginCommand class

Inheritance
  • Object
  • Command<void>
  • LoginCommand

Constructors

LoginCommand()

Properties

aliases → List<String>
Alternate names for this command.
no setterinherited
argParser → ArgParser
The argument parser for this command.
no setterinherited
argResults → ArgResults?
The parsed argument results for this command.
no setterinherited
category → String
The command's category.
no setterinherited
description → String
A description of this command, included in usage.
no setteroverride
globalResults → ArgResults?
The parsed global argument results.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hidden → bool
Whether or not this command should be hidden from help listings.
no setterinherited
invocation → String
A single-line template for how to invoke this command (e.g. "pub get package").
no setterinherited
name → String
The name of this command.
no setteroverride
parent → Command<void>?
The command's parent command, if this is a subcommand.
no setterinherited
runner → CommandRunner<void>?
The command runner for this command.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
subcommands → Map<String, Command<void>>
An unmodifiable view of all sublevel commands of this command.
no setterinherited
suggestionAliases → List<String>
Alternate non-functional names for this command.
no setterinherited
summary → String
A short description of this command, included in parent's CommandRunner.usage.
no setterinherited
takesArguments → bool
Whether or not this command takes positional arguments in addition to options.
no setterinherited
usage → String
Generates a string displaying usage information for this command.
no setterinherited
usageFooter → String?
An optional footer for usage.
no setterinherited

Methods

addSubcommand(Command<void> command) → void
Adds Command as a subcommand of this.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
printUsage() → void
Prints the usage information for this command.
inherited
run() → Future<void>
Runs this command.
override
toString() → String
A string representation of this object.
inherited
usageException(String message) → Never
Throws a UsageException with message.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

ciRefusalMessage({required bool isCI, required bool hasKeyArg}) → String?
Pure — no I/O — so a unit test on this function alone proves the refusal decision (CI, no --key → refuse) without a subprocess. It does not by itself prove run() consults it before constructing a Dio; that ordering is run()'s first statement, before either _loginWithKey or _loginWithPassword — the only two places a Dio gets built — are ever reached.
orphanWarning({required Map<String, dynamic>? existingKey, required String pastedRawKey}) → String?
Pure — the no-orphan / self-match decision, no I/O. Null means "print nothing": either no cli:<hostname> key exists at all, or the one that does is the very key just pasted, so nothing is orphaned.
orphanWarningMessage({required String keyName, required String prefix}) → String
Pure — text only, no lookup — so the wording is unit-testable without a Dio. Names the exact revoke command so the warning is actionable.
successMessage({required String? email, String? keyName}) → String
Pure — email and keyName only, no apiKey/rawKey parameter, so the signature itself is why this can't print a raw key. The "never writes the raw key to stdout" claim rests on that plus run() reaching this only via AppLogger.success(successMessage(...)) in _loginWithKey/_loginWithPassword above — never a raw string interpolating rawKey/result.apiKey — both verified by reading, not by this function's own tests, which pin its formatting instead.