LogoRevali
mrgnhnt96/revali ★9999⑂99

Create Entrypoint

The entrypoint to retrieve the code to be generated

The entrypoint is used by Revali to retrieve the code to be generated. This file should contain a single function that returns Construct object and accepts a ConstructOptions object as a parameter.

lib/my_construct_entrypoint.dart 
import 'package:revali_construct/revali_construct.dart';

Construct myConstructEntrypoint([ConstructOptions? options]) {
    ...
}

Implement Construct#

The Construct object is an abstract class that defines the structure of the code to be returned. You'll need to implement this class and return an instance of it in the entrypoint function.

lib/my_construct.dart 
import 'package:revali_construct/revali_construct.dart';

class MyConstruct extends Construct {
  const MyConstruct();

  @override
  RevaliDirectory<AnyFile> generate(
    covariant RevaliContext context,
    MetaServer server,
  ) {
    return RevaliDirectory(
      files: [
        const AnyFile(
          basename: 'my-text-file',
          extension: 'txt',
          content: 'Hello, World!',
        ),
      ],
    );
  }
}

Return MyConstruct Instance#

Finally, return an instance of the MyConstruct class in the entrypoint function.

lib/my_construct_entrypoint.dart 
import 'package:revali_construct/revali_construct.dart';
import './my_construct.dart';

Construct myConstructEntrypoint([ConstructOptions? options]) {
    return const MyConstruct();
}