+Update dependencies

robelator · robelator · commit 30f1b24ea36d · 2025-06-30T21:46:33.000-04:00
diff --git a/.gitignore b/.gitignore
@@ -10,19 +10,29 @@
 ## ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
 ##.title~
 
-**/.dart_tool/
+# MacOS.
 **/.DS_Store
-**/build/
-**/pubspec.lock
-**/.github/.git
-**/.metadata
+
+# Dart & Flutter.
+**/.dart_tool/
 **/.flutter-plugins
 **/.flutter-plugins-dependencies
+**/.metadata
+**/.pub-cache/
+**/.pub/
+**/build/
 **/pubspec_overrides.yaml
+**/pubspec.lock
+**/custom_lint.log
+
+# GitHub.
+**/.github/.git
 
-# Don't support IntelliJ.
-**/*.iml
-**/*.idea/
+# Firebase.
+**/.firebase
+**/firebase-debug.log
 
-# custom_lint
-**/custom_lint.log
+# Android
+/android/app/debug
+/android/app/profile
+/android/app/release
diff --git a/DEVELOPER_NOTES.md b/DEVELOPER_NOTES.md
diff --git a/bin/.gitignore b/bin/.gitignore
@@ -10,19 +10,29 @@
 ## ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
 ##.title~
 
-**/.dart_tool/
+# MacOS.
 **/.DS_Store
-**/build/
-**/pubspec.lock
-**/.github/.git
-**/.metadata
+
+# Dart & Flutter.
+**/.dart_tool/
 **/.flutter-plugins
 **/.flutter-plugins-dependencies
+**/.metadata
+**/.pub-cache/
+**/.pub/
+**/build/
 **/pubspec_overrides.yaml
+**/pubspec.lock
+**/custom_lint.log
+
+# GitHub.
+**/.github/.git
 
-# Don't support IntelliJ.
-**/*.iml
-**/*.idea/
+# Firebase.
+**/.firebase
+**/firebase-debug.log
 
-# custom_lint
-**/custom_lint.log
+# Android
+/android/app/debug
+/android/app/profile
+/android/app/release
diff --git a/bin/df_generate_header_comments.dart b/bin/df_generate_header_comments.dart
@@ -15,7 +15,7 @@ import 'package:df_generate_header_comments/df_generate_header_comments.dart';
 // ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
 
 void main(List<String> args) async {
-  await genHeaderComments(
+  await generateHeaderComments(
     args,
     defaultTemplate:
         'https://raw.githubusercontent.com/dev-cetera/df_generate_header_comments/main/templates/v1.dart.md',
diff --git a/bin/gen_header_comments_df.dart b/bin/gen_header_comments_df.dart
diff --git a/example/df_generate_header_comments.dart b/example/df_generate_header_comments.dart
@@ -0,0 +1,13 @@
+// The use of this source code is governed by the LICENSE file located in this
+// project's root directory.
+
+import 'package:df_generate_header_comments/df_generate_header_comments.dart';
+
+// ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
+
+void main(List<String> args) async {
+  await generateHeaderComments(
+    args,
+    defaultTemplate: 'v1.dart.md',
+  );
+}
diff --git a/example/example.dart b/example/example.dart
@@ -1,13 +1,4 @@
-//.title
-// ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
-//
-// Dart/Flutter (DF) Packages by dev-cetera.com & contributors. The use of this
-// source code is governed by an MIT-style license described in the LICENSE
-// file located in this project's root directory.
-//
-// See: https://opensource.org/license/mit
-//
-// ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
-//.title~
+// The use of this source code is governed by the LICENSE file located in this
+// project's root directory.
 
 void main() {}
diff --git a/example/gen_header_comments_df.dart b/example/gen_header_comments_df.dart
diff --git a/example/v1.dart.md b/example/v1.dart.md
@@ -0,0 +1,4 @@
+```dart
+// The use of this source code is governed by the LICENSE file located in this
+// project's root directory.
+```
diff --git a/lib/src/_index.g.dart b/lib/src/_index.g.dart
@@ -7,4 +7,4 @@
 // ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
 //.title~
 
-export './gen_header_coments.dart';
+export 'generate_header_comments.dart';
diff --git a/lib/src/generate_header_comments.dart b/lib/src/generate_header_comments.dart
@@ -16,15 +16,16 @@ import 'package:path/path.dart' as p;
 
 // ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
 
-Future<void> genHeaderComments(
+Future<void> generateHeaderComments(
   List<String> args, {
   required String defaultTemplate,
 }) async {
+  Log.enableReleaseAsserts = true;
   final parser = CliParser(
-    title: 'dev-cetera.com/df/tools',
+    title: 'dev-cetera.com',
     description:
         'A tool for generating header comments for your source files. Ignores files that starts with underscores.',
-    example: 'gen-header-comments -i .',
+    example: 'df_generate_header_comments -i .',
     params: [
       DefaultFlags.HELP.flag.copyWith(negatable: true),
       DefaultOptions.INPUT_PATH.option.copyWith(
@@ -65,11 +66,6 @@ Future<void> genHeaderComments(
 
   // ---------------------------------------------------------------------------
 
-  final spinner = Spinner();
-  spinner.start();
-
-  // ---------------------------------------------------------------------------
-
   _print(Log.printWhite, 'Looking for files..');
   final filePathStream0 = PathExplorer(inputPath).exploreFiles();
   final filePathStream1 = filePathStream0.where((e) {
@@ -80,11 +76,10 @@ Future<void> genHeaderComments(
   try {
     findings = await filePathStream1.toList();
   } catch (e) {
-    _print(Log.printRed, 'Failed to read file tree!', spinner);
+    _print(Log.printRed, 'Failed to read file tree!');
     exit(ExitCodes.FAILURE.code);
   }
   if (findings.isEmpty) {
-    spinner.stop();
     _print(Log.printYellow, 'No files found in $inputPath!');
     exit(ExitCodes.SUCCESS.code);
   }
@@ -94,44 +89,38 @@ Future<void> genHeaderComments(
   String templateData;
   _print(Log.printWhite, 'Reading template at: $template...');
 
-  final result = (await MdTemplateUtility.i
-      .readTemplateFromPathOrUrl(template)
-      .value);
+  final result = (await MdTemplateUtility.i.readTemplateFromPathOrUrl(template).value);
 
   if (result.isErr()) {
-    spinner.stop();
     _print(Log.printRed, ' Failed to read template!');
     exit(ExitCodes.FAILURE.code);
   }
   templateData = result.unwrap();
 
   // ---------------------------------------------------------------------------
 
-  _print(Log.printWhite, 'Generating...', spinner);
+  _print(Log.printWhite, 'Generating...');
 
   for (final finding in findings) {
     final filePath = finding.path;
     try {
       await _generateForFile(filePath, templateData);
     } catch (_) {
-      _print(Log.printRed, 'Failed to write at: $filePath', spinner);
+      _print(Log.printRed, 'Failed to write at: $filePath');
     }
   }
 
   // ---------------------------------------------------------------------------
 
-  spinner.stop();
   _print(Log.printGreen, 'Done!');
 }
 
 // ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
 
 Future<void> _generateForFile(String filePath, String template) async {
-  final commentStarter =
-      langFileCommentStarters[p.extension(filePath).toLowerCase()] ?? '//';
+  final commentStarter = langFileCommentStarters[p.extension(filePath).toLowerCase()] ?? '//';
   var templateLines = template.split('\n');
-  final sourceLines =
-      (await FileSystemUtility.i.readLocalFileAsLinesOrNull(filePath)) ?? [];
+  final sourceLines = (await FileSystemUtility.i.readLocalFileAsLinesOrNull(filePath)) ?? [];
   if (sourceLines.isNotEmpty) {
     // Replace leading '//' in all template lines with the comment starter
     templateLines = templateLines.map((line) {
@@ -145,19 +134,16 @@ Future<void> _generateForFile(String filePath, String template) async {
       final line = sourceLines[n].trim();
       if (line.isEmpty || !line.startsWith(commentStarter)) {
         final withoutHeader = sourceLines.sublist(n).join('\n');
-        final withHeader =
-            '${templateLines.join('\n')}\n\n${withoutHeader.trimLeft()}\n';
+        final withHeader = '${templateLines.join('\n')}\n\n${withoutHeader.trimLeft()}\n';
         await FileSystemUtility.i.writeLocalFile(filePath, withHeader);
         break;
       }
     }
   }
 }
 
-void _print(void Function(String) print, String message, [Spinner? spinner]) {
-  spinner?.stop();
+void _print(void Function(String) print, String message) {
   print('[gen-header-comments] $message');
-  spinner?.start();
 }
 
 bool _isAllowedFileName(String e) {
diff --git a/pubspec.yaml b/pubspec.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +```dart
 +// The use of this source code is governed by the LICENSE file located in this
 +// project's root directory.
 +```