Flutter插件carve的使用_carve 插件旨在为生成 Flutter 页面或小部件以及简单的模型类提供简单支持

Flutter插件carve的使用_carve 插件旨在为生成 Flutter 页面或小部件以及简单的模型类提供简单支持

Carve

carve 插件旨在为生成 Flutter 页面或小部件以及简单的模型类提供简单支持。未来版本中还将支持生成简单的布局树。

信息

在执行 carve 命令时，必须位于当前 Flutter/Dart 项目的根目录下，因为该插件目前被硬编码为将所有子文件夹/子文件生成到项目根目录下的 lib/ 目录中。

例如： 如果你创建了一个名为 example 的 Flutter 项目，确保当前工作目录是 /example。

此外，该插件尝试遵循文件和文件夹约定。因此，-n | --name 命令仅允许使用小写字母和一个或多个下划线。

更多详细信息可参见 Dart 官方文档

开始使用

由于该插件不依赖于 Flutter，因此可以轻松安装它。只需在终端输入以下命令：

dart pub global activate carve

使用方法

当使用 -n | --name 选项时，你还可以指定输出目录。在参数中使用 / 可以创建此文件夹（如果不存在），或者将其添加到已存在的文件夹中。例如：

-n models/common/post

这将创建 models 和 common 文件夹（如果它们还不存在），并在 common 文件夹中生成 post.dart。

创建一个模型

carve model -n models/auth_user

这将生成以下模板：

class AuthUser {
  // TODO: 实现变量
  AuthUser();
}

创建一个页面

carve page -n views/login_page

这将生成以下模板：

import 'package:flutter/material.dart';

class LoginPage extends StatefulWidget {
  const LoginPage({Key? key}) : super(key: key);

  @override
  _LoginPageState createState() => _LoginPageState();
}

class _LoginPageState extends State<LoginPage> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        centerTitle: true,
        title: const Text('LoginPage'),
      ),
      body: const Center(
        child: Text('LoginPage'),
      ),
    );
  }
}

创建一个有状态的小部件

carve stateful -n widgets/custom_button

这将生成以下模板：

import 'package:flutter/material.dart';

class CustomButton extends StatefulWidget {
  const CustomButton({Key? key}) : super(key: key);

  @override
  _CustomButtonState createState() => _CustomButtonState();
}

class _CustomButtonState extends State<CustomButton> {
  @override
  Widget build(BuildContext context) {
    // TODO: 实现构建
    return Center(
      child: const Text('CustomButton'),
    );
  }
}

创建一个无状态的小部件

carve stateless -n widgets/test

这将生成以下模板：

import 'package:flutter/material.dart';

class Test extends StatelessWidget {
  const Test({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    // TODO: 实现构建
    return Center(
      child: const Text('Test'),
    );
  }
}

这些生成的示例可以在 GitHub 仓库的 example 文件夹中找到。

未来更新

目前计划增加以下功能：

• 添加一个新的选项，以便在生成页面或小部件时生成简单的组件树。
• 为模型命令添加一个新的选项，以便生成简单的 toJson 和 fromJson 方法。

虫洞、错误等

如果您发现任何奇怪的行为、错误或问题，请告知我。

示例代码

示例代码：example/lib/main.dart

void main() {
  /// 检查其他文件夹，查看生成的模板
  /// 更多信息请参阅 README！
}