gitsumu #

Dart package provides code about compile environment (git info, flutter version ...).

Introduction #

gitsumu provides the following info so that apps can use in code.

• Git commit time.
• Git commit revision.
• Flutter version.
• Dart version.
• App info in pubspec.yaml.
• Custom command.

// Compile environment
const flutterVersion = '3.16.0';
const flutterChannel = 'stable';
const flutterFrameworkRevision = 'db7ef5bf9f';
const flutterFrameworkTimestamp = '2023-11-15 11:25:44 -0800';
const flutterEngineRevision = '74d16627b9';
const flutterDartVersion = '3.2.0';
const flutterDevToolsVersion = '2.28.2';
const dartVersion = '3.2.0 (stable)';

// Repo info
const gitCommitTimeYear = '2023';
const gitCommitTimeMonth = '11';
const gitCommitTimeDay = '13';
const gitCommitTimeHour = '17';
const gitCommitTimeMinute = '36';
const gitCommitTimeSecond = '29';
const gitCommitTimeYMDHMS = '2023-11-13 17:36:29';
const gitCommitTimeTimezone = '+0800';
const gitCommitRevisionLong = 'eec78e9a88d93876a41c5a9bf4368cadcc8ccca8';
const gitCommitRevisionShort = 'eec78e9';

// App info
const appName = 'example';
const appDescription = 'A sample command-line application.';
const appVersion = '1.0.0';

Features #

• Easier to use than dart-define: One command at compile time and no platform specified scripts.
• Use info as const variables: All info generated are const variables.

Of course this package supports both pure dart and flutter.

Usage #

dart run gitsumu (recommended) or dart run build_runner build

Basic #

Full example can be found in example folder.

1. Add gitsumu to pubspec.yaml.

   dependencies:
     gitsumu: # current version
   

   Add build_runner to pubspec.yaml as dev dependency only if you want to use with build_runner.

   dev_dependencies:
     build_runner: # current version
   

   Note that only dart run gitsumu support regeneration, you need to delete the existing generated file before using with build_runner. See restrictions for details.
2. Create a source file as an entry, for example lib/utils/git_info.dart.
   In that source file the only line required is part 'git_info.g.dart'.
   Looks like this:

   // lib/utils/git_info.dart
   part 'git_info.g.dart';
   

3. Save the following config in build.yaml to let gitsumu know which file should generate for.

   targets:
     $default:
       builders:
         gitsumu|info:
           generate_for:
             - lib/utils/git_info.dart
   

4. Run dart run gitsumu (Recommended) or dart run build_runner build before build to generate lib/utils/git_info.g.dart.
5. Will generate code like this:

   part of 'example.dart';
      
   // Compile environment
   const flutterVersion         = '3.16.0';
   const flutterChannel         = 'stable';
   const flutterFrameworkRevision  = 'db7ef5bf9f';
   const flutterFrameworkTimestamp = '2023-11-15 11:25:44 -0800';
   const flutterEngineRevision  = '74d16627b9';
   const flutterDartVersion     = '3.2.0';
   const flutterDevToolsVersion = '2.28.2';
   const dartVersion            = '3.2.0 (stable)';
      
   // Repo info
   const gitCommitTimeYear      = '2023';
   const gitCommitTimeMonth     = '11';
   const gitCommitTimeDay       = '26';
   const gitCommitTimeHour      = '04';
   const gitCommitTimeMinute    = '07';
   const gitCommitTimeSecond    = '12';
   const gitCommitTimeYMDHMS  = '2023-11-26 04:07:12';
   const gitCommitTimeTimezone  = '+0800';
   const gitCommitRevisionLong  = '927a949985f131e27f401287e7915b832f24b301';
   const gitCommitRevisionShort = '927a949';
      
   // App info
   const appName        = 'example';
   const appDescription = 'A sample command-line application.';
   const appVersion     = '1.0.0';
   

Change generate directory #

Similar to other packages. Add the following lines to build.yaml will change the generated file to lib/generated/ folder:

targets:
  $default:
    builders:
      gitsumu|info:
        generate_for:
          # Only generate for lib/utils/git_info.dart => git_info.g.dart
          - lib/utils/git_info.dart
        # Uncomment the following options config if you want to generate
        # code into specified folder, such as "lib/generated".
        # At the same time, you shall use "part of 'generated/xxx.g.dart';" in your source file
        # instead of current "part of 'xxx.g.dart'".
        # Also, recommend to put "lib/generated/" folder in .gitignore.
        options:
          build_extensions:
            '^lib/{{}}.dart': 'lib/generated/{{}}.g.dart'

Restrictions #

As said above, when using with build_runner like dart run build_runner build, the generated code will not update even environment updated (a new git commit, flutter version changed ...). This is because gitsumu only relies on environment, build_runner does not know whether we need a rebuild. Manually delete the generated code before run dart run build_runner build again.

Although it's ok to use with build_runner in a clean environment (like CI/CD), using the separate cli dart run gitsumu is better in development.

Debugging #

Run dart run gitsumu -v to enable verbose log output.