feat: add format config

slang-i18n · Oct 23, 2024 · 663f711 · 663f711
1 parent 13d64ff
commit 663f711
Show file tree

Hide file tree

Showing 12 changed files with 144 additions and 7 deletions.
diff --git a/slang/CHANGELOG.md b/slang/CHANGELOG.md
@@ -1,5 +1,6 @@
-## 4.0.1
+## 4.1.0
 
+- feat: add `format` config to automatically format generated files (#184)
 - fix: correctly generate with `enum_name` and `class_name` different from `AppLocale` / `Translations` (#254)
 
 ## 4.0.0

diff --git a/slang/README.md b/slang/README.md
@@ -80,6 +80,7 @@ dart run slang migrate arb src.arb dest.json # migrate arb to json
   - [Comments](#-comments)
   - [Recasing](#-recasing)
   - [Obfuscation](#-obfuscation)
+  - [Formatting](#-formatting)
   - [Dart Only](#-dart-only)
 - [Tools](#tools)
   - [Main Command](#-main-command)
@@ -332,6 +333,9 @@ interfaces:
 obfuscation:
   enabled: false
   secret: somekey
+format:
+  enabled: true
+  width: 150
 imports:
   - 'package:my_package/path_to_enum.dart'
 ```
@@ -398,6 +402,9 @@ targets:
           obfuscation:
             enabled: false
             secret: somekey
+          format:
+            enabled: true
+            width: 150
           imports:
             - 'package:my_package/path_to_enum.dart'
 ```
@@ -438,6 +445,8 @@ targets:
 | `children of interfaces`            | `Pairs of Alias:Path`                             | alias interfaces [(i)](#-interfaces)                         | `null`         |
 | `obfuscation`/`enabled`             | `Boolean`                                         | enable obfuscation [(i)](#-obfuscation)                      | `false`        |
 | `obfuscation`/`secret`              | `String`                                          | obfuscation secret (random if null) [(i)](#-obfuscation)     | `null`         |
+| `format`/`enabled`                  | `Boolean`                                         | enable auto format [(i)](#-formatting)                       | `false`        |
+| `format`/`width`                    | `String`                                          | set line length / characters per line [(i)](#-formatting)    | `null`         |
 | `imports`                           | `List<String>`                                    | generate import statements                                   | `[]`           |
 
 ## Main Features
@@ -1445,6 +1454,19 @@ Keep in mind that this only prevents simple string searches of the binary.
 
 An experienced reverse engineer can still find the strings given enough time.
 
+### ➤ Formatting
+
+The generated code is not formatted by default to keep the algorithm fast and efficient.
+
+You can enable it:
+
+```yaml
+# Config
+format:
+  enabled: true
+  width: 150 # optional
+```
+
 ### ➤ Dart Only
 
 You can use this library without flutter.

diff --git a/slang/bin/slang.dart b/slang/bin/slang.dart
@@ -14,6 +14,7 @@ import 'package:slang/src/runner/edit.dart';
 import 'package:slang/src/runner/migrate.dart';
 import 'package:slang/src/runner/normalize.dart';
 import 'package:slang/src/runner/stats.dart';
+import 'package:slang/src/runner/utils/format.dart';
 import 'package:watcher/watcher.dart';
 
 /// Determines what the runner will do
@@ -348,12 +349,31 @@ Future<void> generateTranslations({
         locale: locale,
       )}');
     }
-    print('');
+  }
 
-    if (stopwatch != null) {
-      print(
-          '${_GREEN}Translations generated successfully. ${stopwatch.elapsedSeconds}$_RESET');
+  if (fileCollection.config.format.enabled) {
+    final formatDir = PathUtils.getParentPath(outputFilePath)!;
+    Stopwatch? formatStopwatch;
+    if (verbose) {
+      print('');
+      print('Formatting "$formatDir" ...');
+      if (stopwatch != null) {
+        formatStopwatch = Stopwatch()..start();
+      }
     }
+    await runDartFormat(
+      dir: formatDir,
+      width: fileCollection.config.format.width,
+    );
+    if (verbose && formatStopwatch != null) {
+      print('Format done. ${formatStopwatch.elapsedSeconds}');
+    }
+  }
+
+  if (verbose && stopwatch != null) {
+    print('');
+    print(
+        '${_GREEN}Translations generated successfully. ${stopwatch.elapsedSeconds}$_RESET');
   }
 }
 

diff --git a/slang/lib/src/builder/builder/raw_config_builder.dart b/slang/lib/src/builder/builder/raw_config_builder.dart
@@ -1,5 +1,6 @@
 import 'package:slang/src/builder/model/context_type.dart';
 import 'package:slang/src/builder/model/enums.dart';
+import 'package:slang/src/builder/model/format_config.dart';
 import 'package:slang/src/builder/model/i18n_locale.dart';
 import 'package:slang/src/builder/model/interface.dart';
 import 'package:slang/src/builder/model/obfuscation_config.dart';
@@ -113,6 +114,8 @@ class RawConfigBuilder {
       obfuscation: (map['obfuscation'] as Map<String, dynamic>?)
               ?.toObfuscationConfig() ??
           RawConfig.defaultObfuscationConfig,
+      format: (map['format'] as Map<String, dynamic>?)?.toFormatConfig() ??
+          RawConfig.defaultFormatConfig,
       imports: map['imports']?.cast<String>() ?? RawConfig.defaultImports,
       rawMap: map,
     );
@@ -218,6 +221,14 @@ extension on Map<String, dynamic> {
       secret: this['secret'],
     );
   }
+
+  /// Parses the 'format' config
+  FormatConfig toFormatConfig() {
+    return FormatConfig(
+      enabled: this['enabled'],
+      width: this['width'],
+    );
+  }
 }
 
 extension on String {

diff --git a/slang/lib/src/builder/model/format_config.dart b/slang/lib/src/builder/model/format_config.dart
@@ -0,0 +1,13 @@
+/// Configuration model for the "format" entry.
+class FormatConfig {
+  static const bool defaultEnabled = false;
+  static const int? defaultWidth = null;
+
+  final bool enabled;
+  final int? width;
+
+  const FormatConfig({
+    required this.enabled,
+    required this.width,
+  });
+}
diff --git a/slang/lib/src/builder/model/raw_config.dart b/slang/lib/src/builder/model/raw_config.dart
@@ -1,5 +1,6 @@
 import 'package:slang/src/builder/model/context_type.dart';
 import 'package:slang/src/builder/model/enums.dart';
+import 'package:slang/src/builder/model/format_config.dart';
 import 'package:slang/src/builder/model/i18n_locale.dart';
 import 'package:slang/src/builder/model/interface.dart';
 import 'package:slang/src/builder/model/obfuscation_config.dart';
@@ -39,6 +40,10 @@ class RawConfig {
   static const List<InterfaceConfig> defaultInterfaces = <InterfaceConfig>[];
   static final ObfuscationConfig defaultObfuscationConfig =
       ObfuscationConfig.disabled();
+  static const FormatConfig defaultFormatConfig = FormatConfig(
+    enabled: FormatConfig.defaultEnabled,
+    width: FormatConfig.defaultWidth,
+  );
   static const List<String> defaultImports = <String>[];
 
   final FileType fileType;
@@ -72,6 +77,7 @@ class RawConfig {
   final List<ContextType> contexts;
   final List<InterfaceConfig> interfaces;
   final ObfuscationConfig obfuscation;
+  final FormatConfig format;
   final List<String> imports;
 
   /// Used by external tools to access the raw config. (e.g. slang_gpt)
@@ -108,6 +114,7 @@ class RawConfig {
     required this.contexts,
     required this.interfaces,
     required this.obfuscation,
+    required this.format,
     required this.imports,
     required this.rawMap,
   })  : fileType = _determineFileType(inputFilePattern),
@@ -139,6 +146,7 @@ class RawConfig {
     List<ContextType>? contexts,
     List<InterfaceConfig>? interfaces,
     ObfuscationConfig? obfuscation,
+    FormatConfig? format,
   }) {
     return RawConfig(
       baseLocale: baseLocale ?? this.baseLocale,
@@ -172,6 +180,7 @@ class RawConfig {
       contexts: contexts ?? this.contexts,
       interfaces: interfaces ?? this.interfaces,
       obfuscation: obfuscation ?? this.obfuscation,
+      format: format ?? this.format,
       imports: imports,
       rawMap: rawMap,
     );
@@ -249,6 +258,8 @@ class RawConfig {
       }
     }
     print(' -> obfuscation: ${obfuscation.enabled ? 'enabled' : 'disabled'}');
+    print(
+        ' -> format: ${format.enabled ? 'enabled (width=${format.width})' : 'disabled'}');
     print(' -> imports: $imports');
   }
 
@@ -285,6 +296,7 @@ class RawConfig {
     contexts: RawConfig.defaultContexts,
     interfaces: RawConfig.defaultInterfaces,
     obfuscation: RawConfig.defaultObfuscationConfig,
+    format: RawConfig.defaultFormatConfig,
     imports: RawConfig.defaultImports,
     className: RawConfig.defaultClassName,
     rawMap: {},

diff --git a/slang/lib/src/builder/utils/path_utils.dart b/slang/lib/src/builder/utils/path_utils.dart
@@ -39,6 +39,15 @@ class PathUtils {
     return segments[segments.length - 2];
   }
 
+  /// Converts /a/b/file.json to /a/b
+  static String? getParentPath(String path) {
+    final segments = getPathSegments(path);
+    if (segments.length == 1) {
+      return null;
+    }
+    return segments.sublist(0, segments.length - 1).join('/');
+  }
+
   /// finds locale in directory path
   /// eg. /en-US/b/file.json will result in en-US
   static I18nLocale? findDirectoryLocale(

diff --git a/slang/lib/src/runner/utils/format.dart b/slang/lib/src/runner/utils/format.dart
@@ -0,0 +1,25 @@
+import 'dart:io';
+
+/// Formats a given directory by running a separate dart format process.
+Future<void> runDartFormat({
+  required String dir,
+  required int? width,
+}) async {
+  final executable = Platform.resolvedExecutable;
+
+  final status = Process.runSync(
+    executable,
+    [
+      'format',
+      dir,
+      if (width != null) ...[
+        '--line-length',
+        width.toString(),
+      ],
+    ],
+  );
+
+  if (status.exitCode != 0) {
+    print('Dart format failed with exit code ${status.exitCode}');
+  }
+}
diff --git a/slang_build_runner/CHANGELOG.md b/slang_build_runner/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 4.1.0
+
+- feat: add `dart_style` dependency to auto format generated files
+- bump `slang` to `4.1.0`
+
 ## 4.0.0
 
 - Bump `slang` to `4.0.0`

diff --git a/slang_build_runner/lib/slang_build_runner.dart b/slang_build_runner/lib/slang_build_runner.dart
@@ -1,6 +1,7 @@
 import 'dart:async';
 
 import 'package:build/build.dart';
+import 'package:dart_style/dart_style.dart';
 import 'package:glob/glob.dart';
 // ignore: implementation_imports
 import 'package:slang/src/builder/builder/raw_config_builder.dart';
@@ -81,10 +82,15 @@ class I18nBuilder implements Builder {
     // STEP 4: write output to hard drive
     FileUtils.createMissingFolders(filePath: outputFilePath);
 
+    final formatter = DartFormatter(
+      pageWidth: config.format.width,
+    );
+
     FileUtils.writeFile(
       path: BuildResultPaths.mainPath(outputFilePath),
-      content: result.main,
+      content: result.main.formatted(config, formatter),
     );
+
     for (final entry in result.translations.entries) {
       final locale = entry.key;
       final localeTranslations = entry.value;
@@ -93,7 +99,7 @@ class I18nBuilder implements Builder {
           outputPath: outputFilePath,
           locale: locale,
         ),
-        content: localeTranslations,
+        content: localeTranslations.formatted(config, formatter),
       );
     }
   }
@@ -109,4 +115,12 @@ extension on String {
   String getFileExtension() {
     return PathUtils.getFileExtension(this);
   }
+
+  /// Conditionally formats the string using the provided [formatter].
+  String formatted(RawConfig config, DartFormatter formatter) {
+    return switch (config.format.enabled) {
+      true => formatter.format(this),
+      false => this,
+    };
+  }
 }
diff --git a/slang_build_runner/pubspec.yaml b/slang_build_runner/pubspec.yaml
@@ -8,6 +8,7 @@ environment:
 
 dependencies:
   build: ^2.2.1
+  dart_style: ^2.3.0
   glob: ^2.0.2
 
   # Use a tight version to ensure that all features are available

diff --git a/slang_flutter/CHANGELOG.md b/slang_flutter/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 4.1.0
+
+- bump `slang` to `4.1.0`
+
 ## 4.0.0
 
 - Bump `slang` to `4.0.0`