katana_cli library
Command line tool for Masamune/Katana Framework. It initializes the project and initializes the services.
To use, import package:katana_cli/katana_cli.dart
.
Classes
- AnalysisOptionsCliCode
- Contents of katana.yaml.
- Api
- Provides static methods for making HTTP requests.
- AppGradle
-
Class for retrieving and saving files in
android/app/build.gradle
. - BuildCliCode
- Contents of build.yaml.
- BuildGradle
-
Class for retrieving and saving files in
android/build.gradle
. - CliCode
- Abstract class for defining base code.
- CliCodeCommand
- Abstract class for creating a code-based command template.
- CliCommand
- Abstract class for creating command templates.
- CliCommandGroup
- A template for creating command groups.
- CliTestableCodeCommand
- An abstract class for creating testable code-based command templates.
- CodeBootCliCommand
- Create a base class for the Boot page.
- CodeCacheCliCommand
-
Create a
ScopedQuery
. - CodeCliCommand
- CodeCollectionCliCommand
- Create a base class for the collection model.
- CodeControllerCliCommand
- Create a base class for the controller.
- CodeDocumentCliCommand
- Create a base class for the document model.
- CodeEnumCliCommand
- Create an Enum base.
- CodeExceptionCliCommand
- Create a base class for the exception.
- CodeFormatCliCommand
- Dart file formatting.
- CodeGenerateCliCommand
- Start Dart's build_runner to automatically generate code.
- CodeGroupCliCommand
- Create a base class for the controller group.
- CodeModelAdapterCliCommand
- Create a base class for ModelAdapter.
- CodePageCliCommand
- Create a base class for the page.
- CodePrefsCliCommand
- Create a base class for SharedPreferences.
- CodeQueryCliCommand
-
Create a
ChangeNotifierScopedQuery
. - CodeRedirectQueryCliCommand
- Create a base class for RedirectQuery.
- CodeStatefulCliCommand
- Create a base class to create a StatefulWidget.
- CodeStatelessCliCommand
- Create a base class to create a StatelessWidget.
- CodeValueCliCommand
- Create a base class for Immutable values.
- CodeWatchCliCommand
- Start Dart's build_runner to monitor the code and automatically generate code in real time.
- CodeWidgetCliCommand
- Create a base class to create a ScopedWidget.
- CodeZipCliCommand
- Output the Dart code in a hardened Zip file.
- CounterModelCliCode
- Create a base class for the counter model.
- CreateCliCommand
- Create a new Flutter project.
- DateDuration
- A class that represents a date period.
- DateFormat
- DateFormat is for formatting and parsing dates in a locale-sensitive manner.
- ExecContext
- The context in which the command is executed.
- Fuctions
- Class for specifying Functions of Firebase Functions.
- FunctionsEnv
- Class for specifying environment variables of Firebase Functions.
- GitCliCommand
- GitSubmoduleCliCommand
- Recursively clone submodules.
- GradleAllprojects
-
Data in the
allprojects
section. - GradleAllprojectsConfigurations
- Configuration class for the contents of GradleAllprojectsConfigurations.
- GradleAndroid
-
Data in the
android
section. - GradleAndroidBuildType
- Configuration class for the contents of GradleAndroidBuildTypes.
- GradleAndroidBuildTypes
- Build type setting.
- GradleAndroidCompileOptions
- Compile Option Setting.
- GradleAndroidDefaultConfig
- Default settings.
- GradleAndroidKotlinOptions
- Kotlin option settings.
- GradleAndroidSigningConfig
- Configuration class for the contents of GradleAndroidSigningConfigs.
- GradleAndroidSigningConfigs
- Signature settings.
- GradleAndroidSourceSet
- Source setting.
- GradleBuildScript
-
Data in the
buildscript
section. - GradleBuildscriptDependencies
- Configuration class for the contents of GradleBuildscriptDependencies.
- GradleDependencies
-
Data in the
dependencies
section. - GradleLoadProperties
-
Data reading part of
xxx.properties
. - GradlePlugin
-
Data in the
apply plugin
section. - HomePageCliCode
- Create a base class for the home page.
- Immutable
- Used to annotate a class.
- KatanaCliCode
- Contents of katana.yaml.
- KatanaSecretsCliCode
- Contents of katana.yaml.
- LaunchCliCode
- Contents of launch.json.
- LicenseCliCode
- Contents of LICENSE.
- LoaderCssCliCode
- Contents of loader.css.
- MainAdapterCliCode
- Contents of adapter.dart.
- MainCliCode
- Contents of main.dart.
- MainConfigCliCode
- Contents of config.dart.
- MainLocalizeCliCode
- Contents of main.dart.
- MainModuleCliCode
- Contents of module.dart.
- MainRouterCliCode
- Contents of router.dart.
- MainThemeCliCode
- Contents of theme.dart.
- MelosCliCode
- Contents of melos.yaml.
- ModuleCliCode
-
Contents of lib/
module
.dart. - ModuleReadMeCliCode
- Contents of README.md.
-
NumRange<
TNum extends num> - A class that represents a range of numbers.
- PBXBuildConfiguration
- BuildConfiguration data.
- PBXBuildConfigurationSettings
-
Data from
buildSettings
in PBXBuildConfiguration. - PBXBuildFile
- BuildFile data.
- PBXFileReference
- FileReference data.
- PBXFrameworksBuildPhase
- FrameworksBuildPhase data.
- PBXFrameworksBuildPhaseFiles
-
Class for
files
of PBXFrameworksBuildPhase. - PBXGroup
- PBXGroup data.
- PBXGroupChild
-
Class for
children
of PBXGroup. - PBXProject
- PBXProject data.
- PBXResourcesBuildPhase
- ResourcesBuildPhase data.
- PBXResourcesBuildPhaseFile
- Class for PBXResourcesBuildPhase files.
- PBXVariantGroup
- VariantGroup data.
- PBXVariantGroupChild
-
Data for
children
in PBXVariantGroup. - PostAction
- Set the action to be taken after execution.
- PubAddCliCommand
- Add packages.
- PubCliCommand
- PubGetCliCommand
- Get the packages.
- PubignoreCliCode
- Contents of .pubignore.
- PubPublishCliCommand
- Deploy the Dart package to the pub.
- PubspecOverridesCliCode
- Contents of pubspec_overrides.yaml.
- PubUpgradeCliCommand
- Upgrade the package.
- PubVersionCliCommand
- Upgrade the Dart package.
-
RectRange<
TNum extends num> - A class that represents a range of numbers.
- Required
-
Used to annotate a named parameter
p
in a method or functionf
. - SettingsCliCode
- Contents of settings.json.
- WidgetTestCliCode
- Contents of widget_test.dart.
- XCode
- Utility to edit XCode's project.pbxproj.
Enums
- DayOfWeek
- Day of the week.
- PodfilePermissionType
- Permission type for Podfile.
- XCodePermissionType
- Permission message type for XCode.
- XCodePrivacyManifests
- Privacy Manifest for XCode.
Mixins
- CliActionMixin
-
Mixin for setting up internal actions to be executed by the
apply
command.
Extensions
- BooleanExtensions on bool
- Provides extended methods for bool.
- CliDirectoryExtensions on Directory
- DateTimeExtensions on DateTime
- Provides extended methods for DateTime.
-
DateTimeIterableExtensions
on Iterable<
DateTime> - Provides extended methods for DateTime arrays.
- DoubleExtensions on double
- Provides extended methods for double.
-
DoubleIterableExtensions
on Iterable<
double> - Provides extended methods for double arrays.
- DurationExtensions on Duration
- Provides extended methods for Duration.
-
DynamicMapExtensions
on Map<
String, dynamic> - Provides extended methods for DynamicMap.
-
InterableOfIterableExtensions
on Iterable<
Iterable< T> > - Provides extended methods for Iterable arrays.
- IntExtensions on int
- Provides extended methods for int.
-
IntIterableExtensions
on Iterable<
int> - Provides extended methods for int arrays.
-
IterableExtensions
on Iterable<
T> -
Provides extended methods for
T
arrays. - JsonDynamicListExtensions on DynamicList
- Provides Json extension methods for DynamicList.
- JsonDynamicMapExtensions on DynamicMap
- Provides Json extension methods for DynamicMap.
-
ListExtensions
on List<
T> -
Provides extended methods for List in
T
. -
MapExtensions
on Map<
K, V> - Provides extended methods for Map.
- NullableDoubleExtensions on double?
- Provides an extension method for double that is nullable.
- NullableIntExtensions on int?
- Provides an extension method for int that is nullable.
-
NullableIterableExtensions
on Iterable<
T> ? - Provides an extension method for Iterable that is nullable.
-
NullableListExtensions
on List<
T> ? - Provides an extension method for List that is nullable.
-
NullableMapExtensions
on Map<
K, V> ? - Provides an extension method for Map that is nullable.
- NullableNumExtensions on num?
- Provides an extension method for num that is nullable.
- NullableObjectExtensions on Object?
- Provides an extension method for List that is nullable.
-
NullableSetExtensions
on Set<
T> ? - Provides an extension method for Set that is nullable.
- NullableStringExtensions on String?
- Provides an extension method for String that is nullable.
- NullableUriExtensions on Uri?
- Provides an extension method for Uri that is nullable.
-
NullableValueIterableExtensions
on Iterable<
T?> - Provides an extension method for Iterable whose value is nullable.
-
ProcessExtensions
on Future<
Process> - Extended methods to make Process easier to use.
- RandomExtensions on Random
- Provides extended methods for Random.
-
SetExtensions
on Set<
T> - Provides extended methods for Set.
- StringExtensions on String
- Provides extended methods for String.
- UriExtensions on Uri
- Provides extended methods for Uri.
Constants
- nullOfBool → const bool?
-
A
null
object with a defined type of bool? - nullOfDouble → const double?
-
A
null
object with a defined type of double? - nullOfDynamicList → const DynamicList?
-
A
null
object with a defined type of DynamicList? - nullOfDynamicMap → const DynamicMap?
-
A
null
object with a defined type of DynamicMap? - nullOfInt → const int?
-
A
null
object with a defined type of int? - nullOfNum → const num?
-
A
null
object with a defined type of num? - nullOfString → const String?
-
A
null
object with a defined type of String? -
otherFiles
→ const Map<
String, CliCode> - Other generated files.
- zeroOfNum → const num
-
A
0
object with a defined type of num?
Properties
-
allOptionsImportPackage
→ List<
String> -
Additional import packages if the "-a" option is used.
final
-
importDevPackages
→ List<
String> -
Package for dev to import.
final
-
importPackages
→ List<
String> -
Package to import.
final
- sprintf ↔ PrintFormat
-
getter/setter pair
Functions
-
addFlutterImport(
List< String> packages, {bool development = false, String flutterCommand = "flutter"}) → Future<void> -
Add flutter imports by giving
packages
. -
command(
String title, List< String> commands, {String? workingDirectory, bool runInShell = true, bool catchError = false}) → Future<String> - Run command.
-
error(
String message) → void - Display errors.
-
find(
Directory root, Pattern pattern, {bool recursive = true}) → Future< File?> -
Get the first file that matches
pattern
inroot
. -
findDirectory(
Directory root, Pattern pattern) → Future< Directory?> -
Get the first directory in
root
that matchespattern
. -
findGitDirectory(
Directory current) → Future< Directory?> - Get the directory where Git resides.
-
generateCode(
int length, {int seed = 0, String charSet = "23456789abcdefghjkmnpqrstuvwxy"}) → String -
Generates and returns a random string with the number of characters given by
length
. -
initializeDateFormatting(
[String? locale, String? ignored]) → Future< void> -
This should be called for at least one
locale
before any date formatting methods are called. It sets up the lookup for date symbols. Both thelocale
andignored
parameter are ignored, as the data for all locales is directly available. -
jsonDecodeAsList<
T extends Object?> (String json, [List< T> defaultValue = const []]) → List<T> -
Converts
json
to a Json-decoded List -
jsonDecodeAsMap<
T extends Object?> (String json, [Map< String, T> defaultValue = const {}]) → Map<String, T> -
Converts
json
to a Json-decoded Map<String, dynamic> object. -
jsonEncodable(
Object? o) → bool -
If this object is Json encodable,
true
is returned. -
label(
String title) → void - Display labels.
-
modifize(
dynamic object) → dynamic - Make an Unmodifidable map or listing Modifidable.
-
nullOfList<
T> () → List< T> ? -
A
null
object with a defined type of List<T>? -
nullOfMap<
K, V> () → Map< K, V> ? -
A
null
object with a defined type of Map<K, V>? -
nullOfSet<
T> () → Set< T> ? -
A
null
object with a defined type of Set<T>? -
uuid(
{DateTime? baseTime, bool reverse = false}) → String - Generate and retrieve the UUID for Version 7.
-
wait(
Iterable futures) → Future< void> -
Wait until all Futures given in
futures
are completed.
Typedefs
- ApiResponse = Response
- An HTTP response where the entire response body is known in advance.
- ApiResquest = Request
- An HTTP request where the entire request body is known in advance.
- DynamicList = List
- Represents the type of List<dynamic>.
-
DynamicMap
= Map<
String, dynamic> - Represents the type of Map<String, dynamic>.