setup_steps library

The guide of the steps of the setup of an app that its developer does by hand (see ManualStep), and the catalog of the steps of the modules of smf create, which the site of SMF keeps a copy of and a guide for each step of.

The catalog is setup_steps.json of the package (setupStepsFile), which tool/setup_steps.dart writes with setupStepsOf and SetupCatalog.next. It serves the repository of SMF, and its API may change in any release.

Classes

SetupCatalog

The catalog of the steps by hand of the modules of smf create: the steps of their apps today, and the retired steps, which no app has any more.

SetupStep

A step by hand of the catalog, as the site of SMF reads it.

Enums

SetupStepOwnerKind

The kind of the owner of a step by hand (see ManualStepId).

Constants

setupGuidePage → const String

The page of the site of SMF that guides the developer of an app through the steps of its setup that are done by hand (see ManualStep).

setupStepsFile → const String

The path of the catalog of the steps by hand in the package smf_flutter_cli.

Functions

setupGuideLinkOf(List<ManualStepId> steps) → Uri

The link to setupGuidePage for steps, the ids of the steps by hand of an app in their order, such as https://doc.saymyframe.com/setup?steps=app_entry.ios_app_id,firebase_messaging.apns_key: the SetupLink of smf create.

setupStepsOf(List<SmfModule> modules) → Future<List<SetupStep>>

The steps by hand of the apps of modules, the modules of smf create, each once by its id, for the catalog (see SetupCatalog.next).