Flutter项目快速创建与管理插件very_good_cli的使用

发布于 1周前 作者 yuanlaile 来自 Flutter

Flutter项目快速创建与管理插件very_good_cli的使用

Very Good CLI 🦄

ci coverage pub package style: very good analysis License: MIT

一个非常好用的Dart命令行接口。

Very Good Ventures 开发。


文档 📝

官方文档请访问 https://cli.vgv.dev

快速开始 🚀

安装 🧑‍💻

dart pub global activate very_good_cli

或者安装特定版本:

dart pub global activate very_good_cli <version>

如果你还没有设置路径,请参考 配置全局路径

在CI环境中,可以使用以下命令运行 very_good 命令:

dart pub global run very_good_cli:very_good <command> <args>

命令 ✨

创建项目 very_good create

very_good create 可以根据提供的模板快速创建项目。每个模板都有相应的子命令(例如,very_good create flutter_app 将生成一个Flutter启动应用程序)。

Very Good Create

用法:

# 创建一个新的Flutter应用程序
very_good create flutter_app my_app

# 创建一个新的Flutter应用程序并指定描述和组织
very_good create flutter_app my_app --desc "My new Flutter app" --org "com.custom.org"

# 创建一个新的Flutter应用程序并指定描述和应用ID
very_good create flutter_app my_app --desc "My new Flutter app" --application-id "com.custom.app.id"

# 创建一个新的Flame游戏
very_good create flame_game my_game --desc "My new Flame game"

# 创建一个新的Wear OS应用程序
very_good create flutter_app my_wear_app --desc "My new Wear OS app" --template wear

# 创建一个新的Flutter包
very_good create flutter_package my_flutter_package --desc "My new Flutter package"

# 创建一个新的Dart包
very_good create dart_package my_dart_package --desc "My new Dart package"

# 创建一个可发布的Dart包
very_good create dart_package my_dart_package --desc "My new Dart package" --publishable

# 创建一个新的Dart CLI应用程序
very_good create dart_cli my_dart_cli --desc "My new Dart CLI package"

# 创建一个新的Dart CLI应用程序并指定可执行文件名
very_good create dart_cli my_dart_cli --desc "My new Dart CLI package" --executable-name my_executable_name

# 创建一个新的Flutter插件(支持所有平台)
very_good create flutter_plugin my_flutter_plugin --desc "My new Flutter plugin"

# 创建一个新的Flutter插件(仅支持某些平台)
very_good create flutter_plugin my_flutter_plugin --desc "My new Flutter plugin" --platforms android,ios,macos

# 创建一个新的文档站点
very_good create docs_site my_docs_site

运行测试 very_good test

运行Dart或Flutter项目的测试。

# 运行所有测试
very_good test

# 运行所有测试并收集覆盖率
very_good test --coverage

# 运行所有测试并强制100%覆盖率
very_good test --coverage --min-coverage 100

# 运行特定目录中的测试
very_good test ./some/other/directory

# 递归运行测试
very_good test --recursive

# 递归运行测试(简写)
very_good test -r

获取依赖包 very_good packages get

获取Dart或Flutter项目的依赖包。

# 安装当前目录中的依赖包
very_good packages get

# 安装特定目录中的依赖包
very_good packages get ./some/other/directory

# 递归安装依赖包
very_good packages get --recursive

# 递归安装依赖包(简写)
very_good packages get -r

检查依赖包许可证 very_good packages check licenses

检查Dart或Flutter项目的依赖包许可证。

# 检查当前目录中的许可证
very_good packages check licenses

# 仅允许使用某些许可证
very_good packages check licenses --allowed="MIT,BSD-3-Clause,BSD-2-Clause,Apache-2.0"

# 禁止使用某些许可证
very_good packages check licenses --forbidden="unknown"

# 检查特定依赖类型的许可证
very_good packages check licenses --dependency-type="direct-main,transitive"

查看帮助信息 very_good --help

查看所有命令和使用信息。

🦄 A Very Good Command-Line Interface

Usage: very_good <command> [arguments]

Global options:
-h, --help            Print this usage information.
    --version         Print the current version.
    --[no-]verbose    Noisy logging, including all shell commands executed.

Available commands:
  create     very_good create <subcommand> <project-name> [arguments]
             Creates a new very good project in the specified directory.
  packages   Command for managing packages.
  test       Run tests in a Dart or Flutter project.
  update     Update Very Good CLI.

Run "very_good help <command>" for more information about a command.

示例代码

示例项目

# 激活Very Good CLI
dart pub global activate very_good_cli

# 查看可用命令列表
very_good --help

通过以上命令,你可以快速上手 very_good_cli,轻松管理和创建Flutter项目。希望这些内容对你有所帮助!如果有任何问题,欢迎随时提问。


更多关于Flutter项目快速创建与管理插件very_good_cli的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter项目快速创建与管理插件very_good_cli的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然,以下是如何在Flutter项目中快速创建与管理插件,通过使用very_good_cli(一个非常有用的命令行工具)的相关代码案例。

安装 very_good_cli

首先,确保你已经安装了Dart和Flutter。然后,你可以通过Dart的包管理工具pub来全局安装very_good_cli

dart pub global activate very_good_cli

安装完成后,你可以通过运行以下命令来验证安装是否成功:

vg --version

创建一个新的Flutter项目

使用very_good_cli来创建一个新的Flutter项目是非常简单的。你可以使用以下命令:

vg create my_flutter_project

这将创建一个名为my_flutter_project的新Flutter项目,并应用very_good_cli的默认模板和配置。

创建和管理插件

very_good_cli并没有直接的命令来创建Flutter插件,但它提供了一些模板和约定来帮助你更好地组织和管理你的项目,包括插件。

不过,你可以手动创建一个插件,然后将其集成到你的Flutter项目中。以下是如何手动创建一个Flutter插件,并将其添加到你的Flutter项目的步骤:

  1. 创建一个新的Flutter插件

    在项目的根目录下,你可以使用Flutter的插件创建命令来创建一个新的插件:

    flutter create --org com.example --template=plugin my_custom_plugin
    

    这将创建一个名为my_custom_plugin的新Flutter插件,并将其放置在你的项目目录的一个子目录中。

  2. 将插件添加到你的Flutter项目中

    然后,你需要在你的Flutter项目的pubspec.yaml文件中添加对这个插件的依赖。编辑你的pubspec.yaml文件,并添加以下依赖项:

    dependencies:
      flutter:
        sdk: flutter
      my_custom_plugin:
        path: ./my_custom_plugin
    

    注意,这里我们使用path依赖来指定插件的本地路径。

  3. 使用插件

    现在,你可以在你的Flutter项目的代码中导入并使用这个插件了。例如,在lib/main.dart文件中,你可以这样使用:

    import 'package:flutter/material.dart';
    import 'package:my_custom_plugin/my_custom_plugin.dart'; // 导入插件
    
    void main() {
      runApp(MyApp());
    }
    
    class MyApp extends StatelessWidget {
      @override
      Widget build(BuildContext context) {
        return MaterialApp(
          home: Scaffold(
            appBar: AppBar(
              title: Text('Plugin Example'),
            ),
            body: Center(
              child: MyCustomPluginExample(),
            ),
          ),
        );
      }
    }
    
    class MyCustomPluginExample extends StatefulWidget {
      @override
      _MyCustomPluginExampleState createState() => _MyCustomPluginExampleState();
    }
    
    class _MyCustomPluginExampleState extends State<MyCustomPluginExample> {
      String? result;
    
      @override
      void initState() {
        super.initState();
        // 调用插件的方法
        MyCustomPlugin.someMethod().then((value) {
          setState(() {
            result = value;
          });
        });
      }
    
      @override
      Widget build(BuildContext context) {
        return Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text('Result: ${result ?? 'Loading...'}'),
          ],
        );
      }
    }
    

    注意,这里的MyCustomPlugin.someMethod()应该替换为你插件中实际提供的方法。

总结

虽然very_good_cli没有直接的命令来创建Flutter插件,但它提供了一些有用的模板和约定来帮助你更好地组织和管理你的Flutter项目。通过结合使用very_good_cli和Flutter的插件创建命令,你可以快速创建并管理你的Flutter插件。

回到顶部