Flutter版权信息生成插件dotup_dart_copyright

Flutter版权信息生成插件dotup_dart_copyright_builder的使用

dotup_dart_copyright_builder 是一个Dart包，用于为每个Dart文件生成头部信息。

使用方法

示例 `build.yaml`

builders:

  copyrightBuilder:
    import: "package:dotup_dart_copyright_builder/builder.dart"
    builder_factories: ["copyrightBuilder"]
    build_extensions: {".dart": [".copyright.dart"]}
    build_to: source
    auto_apply: root_package
    applies_builders: ["copyrightBuilder"]
    defaults:
      options:
        force: false
        enabled: true
        copyright: "dotup IT solutions - Peter Ullrich"
        text: [
          "// Some additional ",
          "// header text",
        ]

运行命令

dart pub run build_runner build

或

flutter pub run build_runner build

生成的头部信息

// Powered by https://dotup.de
// Copyright (c) 2021, dotup IT solutions - Peter Ullrich
// Some additional
// header text

...your source code

注意：头部的结束标志是一个空行。如果force设置为true，则会移除并重新生成头部。

安装

在你的pubspec.yaml文件中添加以下依赖：

flutter pub add dotup_dart_copyright_builder --dev

示例代码

以下是使用dotup_dart_copyright_builder的一个完整示例：

示例代码文件

// Powered by https://dotup.de
// Copyright (c) 2021, Copyright dotup IT solutions - Peter Ullrich
// Go to https://flutter-apps.ml and check out the awesome flutter simulator


void main() {
  print("Hello, World!");
}

`build.yaml` 文件配置

builders:

  copyrightBuilder:
    import: "package:dotup_dart_copyright_builder/builder.dart"
    builder_factories: ["copyrightBuilder"]
    build_extensions: {".dart": [".copyright.dart"]}
    build_to: source
    auto_apply: root_package
    applies_builders: ["copyrightBuilder"]
    defaults:
      options:
        copyright: "Copyright dotup IT solutions - Peter Ullrich"
        text: [
          "// Some more",
          "// lines",
          "// in the header",
        ]

更多关于Flutter版权信息生成插件dotup_dart_copyright_builder的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

songsunli 1楼

更多关于Flutter版权信息生成插件dotup_dart_copyright_builder的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

安装插件

首先，你需要在 pubspec.yaml 文件中添加 dotup_dart_copyright_builder 作为开发依赖项：

dev_dependencies:
  dotup_dart_copyright_builder: ^1.0.0

然后运行 flutter pub get 来安装插件。

配置插件

在项目根目录下创建一个 build.yaml 文件，用于配置插件的参数。以下是一个示例配置：

targets:
  $default:
    builders:
      dotup_dart_copyright_builder|copyright_builder:
        options:
          copyright_text: |
            // Copyright (c) 2023 Your Company Name. All rights reserved.
            // Use of this source code is governed by a BSD-style license that can be
            // found in the LICENSE file.
          exclude:
            - "**/*.g.dart"
            - "**/*.freezed.dart"

配置说明

copyright_text: 这是你想要插入的版权信息文本。你可以根据需要自定义。
exclude: 这是一个可选配置，用于指定哪些文件不需要插入版权信息。通常，自动生成的文件（如 *.g.dart 和 *.freezed.dart）不需要版权信息。

运行插件

配置完成后，你可以通过运行以下命令来生成版权信息：

flutter pub run build_runner build

这个命令会触发 build_runner，并应用 dotup_dart_copyright_builder 插件，将版权信息插入到每个 Dart 文件的开头。

示例

假设你有一个 Dart 文件 lib/main.dart，在运行插件后，文件内容可能会变为：

// Copyright (c) 2023 Your Company Name. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:flutter/material.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

Flutter版权信息生成插件dotup_dart_copyright_builder的使用