chore: enforce consistency of translations in CI (#268)

Author: TomAFrench

.github/workflows/default_workflow.yml

@@ -31,6 +31,9 @@ jobs:
           flutter-version: '3.27.1'
           channel: 'stable'
           cache: true
+
+      - name: Setup Just
+        uses: taiki-e/install-action@just
 
       - name: Cache Flutter packages
         uses: actions/cache@v4
@@ -40,22 +43,10 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pub-cache-
 
-      - name: Install Pub Dependencies
-        run: flutter pub get
-        
-      - name: Build with secrets
-        run: flutter pub run build_runner build --delete-conflicting-outputs
+      - name: Run CI
+        run: just ci
         env:
           FDC_API_KEY: ${{ secrets.FDC_API_KEY }}
           SENTRY_DNS: ${{ secrets.SENTRY_DNS }}
           SUPABASE_PROJECT_ANON_KEY: ${{ secrets.SUPABASE_PROJECT_ANON_KEY }}
           SUPABASE_PROJECT_URL: ${{ secrets.SUPABASE_PROJECT_URL }}
-
-      - name: Run Formatter
-        run: dart format --set-exit-if-changed ./lib ./test
-
-      - name: Analyze Code
-        run: flutter analyze
-
-      - name: Run Tests
-        run: flutter test

analysis_options.yaml

@@ -9,6 +9,12 @@
 # packages, and plugins designed to encourage good coding practices.
 include: package:flutter_lints/flutter.yaml
 
+analyzer:
+  # generated files throw `unnecessary_string_escapes` lint so we ignore warnings.
+  # TODO: inject `ignore_for_file` as described below.
+  exclude:
+    - lib/generated/intl/*.dart
+
 linter:
   # The lint rules applied to this project can be customized in the
   # section below to disable rules from the `package:flutter_lints/flutter.yaml`

justfile

@@ -0,0 +1,29 @@
+intl_output_dir := "./lib/generated/intl/"
+
+# Install dependencies
+install:
+  flutter pub get
+
+# Build OpenNutriTracker
+build:
+  flutter pub run build_runner build --delete-conflicting-outputs
+
+# Format dart code
+format *OPTIONS:
+  dart format {{OPTIONS}} ./lib ./test
+
+# Regenerate intl files
+run_intl: && format
+  dart run intl_translation:generate_from_arb --output-dir {{intl_output_dir}} lib/**/*.dart ./lib/l10n/*.arb
+
+# Check if intl files are correctly generated
+check_intl: run_intl 
+  git diff  --exit-code {{intl_output_dir}}
+
+# Run tests
+test:
+  flutter test
+
+# Run CI checks
+ci: install (format "--set-exit-if-changed") check_intl build && test
+  flutter analyze

lib/generated/intl/messages_all.dart

@@ -1,76 +1,5 @@
 // DO NOT EDIT. This is code generated via package:intl/generate_localized.dart
 // This is a library that looks up messages for specific locales by
 // delegating to the appropriate library.
-
-// Ignore issues from commonly used lints in this file.
-// ignore_for_file:implementation_imports, file_names, unnecessary_new
-// ignore_for_file:unnecessary_brace_in_string_interps, directives_ordering
-// ignore_for_file:argument_type_not_assignable, invalid_assignment
-// ignore_for_file:prefer_single_quotes, prefer_generic_function_type_aliases
-// ignore_for_file:comment_references
-
-import 'dart:async';
-
-import 'package:flutter/foundation.dart';
-import 'package:intl/intl.dart';
-import 'package:intl/message_lookup_by_library.dart';
-import 'package:intl/src/intl_helpers.dart';
-
-import 'messages_de.dart' as messages_de;
-import 'messages_en.dart' as messages_en;
-import 'messages_tr.dart' as messages_tr;
-
-typedef Future<dynamic> LibraryLoader();
-Map<String, LibraryLoader> _deferredLibraries = {
-  'de': () => new SynchronousFuture(null),
-  'en': () => new SynchronousFuture(null),
-  'tr': () => new SynchronousFuture(null),
-};
-
-MessageLookupByLibrary? _findExact(String localeName) {
-  switch (localeName) {
-    case 'de':
-      return messages_de.messages;
-    case 'en':
-      return messages_en.messages;
-    case 'tr':
-      return messages_tr.messages;
-    default:
-      return null;
-  }
-}
-
-/// User programs should call this before using [localeName] for messages.
-Future<bool> initializeMessages(String localeName) {
-  var availableLocale = Intl.verifiedLocale(
-    localeName,
-    (locale) => _deferredLibraries[locale] != null,
-    onFailure: (_) => null,
-  );
-  if (availableLocale == null) {
-    return new SynchronousFuture(false);
-  }
-  var lib = _deferredLibraries[availableLocale];
-  lib == null ? new SynchronousFuture(false) : lib();
-  initializeInternalMessageLookup(() => new CompositeMessageLookup());
-  messageLookup.addLocale(availableLocale, _findGeneratedMessagesFor);
-  return new SynchronousFuture(true);
-}
-
-bool _messagesExistFor(String locale) {
-  try {
-    return _findExact(locale) != null;
-  } catch (e) {
-    return false;
-  }
-}
-
-MessageLookupByLibrary? _findGeneratedMessagesFor(String locale) {
-  var actualLocale = Intl.verifiedLocale(
-    locale,
-    _messagesExistFor,
-    onFailure: (_) => null,
-  );
-  if (actualLocale == null) return null;
-  return _findExact(actualLocale);
-}
+// @dart=2.12
+export 'messages_all_locales.dart' show initializeMessages;

lib/generated/intl/messages_all_locales.dart

@@ -0,0 +1,68 @@
+// DO NOT EDIT. This is code generated via package:intl/generate_localized.dart
+// This is a library that looks up messages for specific locales by
+// delegating to the appropriate library.
+// @dart=2.12
+// Ignore issues from commonly used lints in this file.
+// ignore_for_file:implementation_imports, file_names
+// ignore_for_file:unnecessary_brace_in_string_interps, directives_ordering
+// ignore_for_file:argument_type_not_assignable, invalid_assignment
+// ignore_for_file:prefer_single_quotes, prefer_generic_function_type_aliases
+// ignore_for_file:comment_references
+
+import 'package:intl/intl.dart';
+import 'package:intl/message_lookup_by_library.dart';
+import 'package:intl/src/intl_helpers.dart';
+
+import 'messages_de.dart' deferred as messages_de;
+import 'messages_en.dart' deferred as messages_en;
+import 'messages_tr.dart' deferred as messages_tr;
+
+typedef Future<dynamic> LibraryLoader();
+Map<String, LibraryLoader> _deferredLibraries = {
+  'de': messages_de.loadLibrary,
+  'en': messages_en.loadLibrary,
+  'tr': messages_tr.loadLibrary,
+};
+
+MessageLookupByLibrary? _findExact(String localeName) {
+  switch (localeName) {
+    case 'de':
+      return messages_de.messages;
+    case 'en':
+      return messages_en.messages;
+    case 'tr':
+      return messages_tr.messages;
+    default:
+      return null;
+  }
+}
+
+/// User programs should call this before using [localeName] for messages.
+Future<bool> initializeMessages(String? localeName) async {
+  var availableLocale = Intl.verifiedLocale(
+      localeName, (locale) => _deferredLibraries[locale] != null,
+      onFailure: (_) => null);
+  if (availableLocale == null) {
+    return Future.value(false);
+  }
+  var lib = _deferredLibraries[availableLocale];
+  await (lib == null ? Future.value(false) : lib());
+  initializeInternalMessageLookup(() => CompositeMessageLookup());
+  messageLookup.addLocale(availableLocale, _findGeneratedMessagesFor);
+  return Future.value(true);
+}
+
+bool _messagesExistFor(String locale) {
+  try {
+    return _findExact(locale) != null;
+  } catch (e) {
+    return false;
+  }
+}
+
+MessageLookupByLibrary? _findGeneratedMessagesFor(String locale) {
+  var actualLocale =
+      Intl.verifiedLocale(locale, _messagesExistFor, onFailure: (_) => null);
+  if (actualLocale == null) return null;
+  return _findExact(actualLocale);
+}