Flutter代码生成或处理插件dart_code的使用

Flutter代码生成或处理插件dart_code的使用

dart_code

dart_code 是一个用于创建有效且格式化的代码的包，例如在编写代码时使用 builders。

使用

dart_code 提供了一个 Dart 代码模型，可以通过 toString() 方法转换为代码。

示例：主函数中的打印语句

import 'package:dart_code/dart_code.dart';

main() {
  print(Function.main(Statement.print(Expression.ofString('Hello World.'))));
}

输出：

main() {
  print('Hello World.');
}

使用 CodeFormatter 类进行其他格式化。它使用官方的 (dartfmt) 规则与 dart_style 包一起工作。您可以使用以下 CodeFormatter 构造函数参数：

• String lineEnding
• int pageWidth
• int indent

注意，此格式器可能会抛出解析异常。当您需要部分无法由 Dart 格式器解析的代码时，可以使用 [CodeFormatter.unFormatted] 方法。

替代格式化示例

import 'package:dart_code/dart_code.dart';

main() {
  print(CodeFormatter(pageWidth: 20).format(
      Function.main(Statement.print(Expression.ofString('Hello World.'))));
}

输出：

main() {
  print(
      'Hello World.');
}

示例：带有独特导入的库

import 'package:dart_code/dart_code.dart';

main() {
   print(Library(classes: [
     Class(
       'Employee',
       superClass: Type('Person', libraryUri: 'package:my_package/person.dart'),
       implements: [
         Type('Skills', libraryUri: 'package:my_package/skills.dart')
       ],
       abstract: true,
     )
   ]));
}

输出：

import 'package:my_package/person.dart' as i1;
import 'package:my_package/skills.dart' as i2;

abstract class Employee extends i1.Person implements i2.Skills {}

更多示例，请参阅：https://github.com/efficientyboosters/dart_code/tree/main/test

最重要的类要使用的

您可能需要使用以下代码建模类：

• Library
  • Function
  • Class
    • Field
    • Constructor
    • Method
• Expressions（对于结果产生值的代码
• Statement（对于执行操作的代码
• Comment
• DocComment
• Annotation
• Code（对于任何其他内容

灵感

这个包受到了 code_builder 包的启发。

• dart_code 更简单且可能不那么完整
• dart_code 类可以扩展（没有使用 fluent builders），因此可以在扩展类的构造函数中编写代码模型逻辑。
• dart_code 允许直接使用代码类上的 toString() 方法，或者使用 CodeFormatter 类进行其他格式设置。

示例代码

import 'package:dart_code/dart_code.dart';

main() {
  /// A simple formatting example:
  print(
      DartFunction.main(Statement.print(Expression.ofString('Hello World.'))));

  // OUTPUTS:
  // main() {
  //   print('Hello World.');
  // }

  /// An alternative formatting example
  print(CodeFormatter(pageWidth: 20).format(
      DartFunction.main(Statement.print(Expression.ofString('Hello World.')))));

  // OUTPUTS:
  // main() {
  //   print(
  //       'Hello World.');
  // }

  /// An library example with imports
  print(Library(classes: [
    Class(
      'Employee',
      superClass: Type('Person', libraryUri: 'package:my_package/person.dart'),
      implements: [
        Type('Skills', libraryUri: 'package:my_package/skills.dart')
      ],
      abstract: true,
    )
  ]));

  // OUTPUTS:
  // import 'package:my_package/person.dart' as i1;
  // import 'package:my_package/skills.dart' as i2;
  //
  // abstract class Employee extends i1.Person implements i2.Skills {}
}