Further cleanup, simplifications, and formatting

packages/analysis_options.yaml

@@ -17,7 +17,7 @@ linter:
     - avoid_catching_errors
     - avoid_dynamic_calls
     - avoid_empty_else
-    #- avoid_function_literals_in_foreach_calls
+    - avoid_function_literals_in_foreach_calls
     - avoid_init_to_null
     - avoid_null_checks_in_equality_operators
     - avoid_private_typedef_functions

packages/code_excerpt_updater/lib/code_excerpt_updater_cli.dart

@@ -10,9 +10,9 @@ import 'package:logging/logging.dart';
 import 'src/code_excerpt_updater.dart';
 import 'src/logger.dart';
 
-const _commandName = 'code_excerpt_updater';
-final _validExt = RegExp(r'\.(dart|jade|md)$');
-final _dotPathRe = RegExp(r'(^|/)\..*($|/)');
+const String _commandName = 'code_excerpt_updater';
+final RegExp _dotPathRe = RegExp(r'(^|/)\..*($|/)');
+final RegExp _validExt = RegExp(r'\.(dart|jade|md)$');
 
 /// Processes `.dart` and `.md` files, recursively traverses directories
 /// using [Updater]. See this command's help for CLI argument details.

packages/code_excerpt_updater/lib/src/args.dart

@@ -28,11 +28,11 @@ class ArgProcessor {
     return info;
   }
 
-  RegExp supportedArgs = RegExp(
+  final RegExp supportedArgs = RegExp(
     r'^(class|diff-with|diff-u|from|indent-by|path-base|plaster|region|replace|'
     r'remove|retain|skip|take|title|to)$',
   );
-  RegExp argRegExp = RegExp(r'^([-\w]+)\s*(=\s*"(.*?)"\s*|\b)\s*');
+  final RegExp argRegExp = RegExp(r'^([-\w]+)\s*(=\s*"(.*?)"\s*|\b)\s*');
 
   void _extractAndNormalizeNamedArgs(InstrInfo info, String? argsAsString) {
     if (argsAsString == null) return;
@@ -98,7 +98,7 @@ class ArgProcessor {
     _isNullOr(args['take'], _isInt);
   }
 
-  final isNumericRegExp = RegExp(r'^[-+]?\d+$');
+  final RegExp isNumericRegExp = RegExp(r'^[-+]?\d+$');
 
   bool _isInt(String value) => isNumericRegExp.hasMatch(value);
 

packages/code_excerpt_updater/lib/src/code_excerpt_updater.dart

@@ -18,8 +18,6 @@ import 'instr_info.dart';
 import 'issue_reporter.dart';
 import 'logger.dart';
 
-final _stringListEquality = const ListEquality<String>().equals;
-
 /// A simple line-based updater for markdown code-blocks. It processes given
 /// files line-by-line, looking for matches to [procInstrRE] contained within
 /// markdown code blocks.
@@ -55,7 +53,8 @@ class Updater {
   int _origNumLines = 0;
   List<String> _lines = [];
 
-  int _numSrcDirectives = 0, _numUpdatedFrag = 0;
+  int _numSrcDirectives = 0;
+  int _numUpdatedFrag = 0;
 
   /// [err] defaults to [stderr].
   Updater(
@@ -256,7 +255,8 @@ class Updater {
               RegExp(r'({){|(})}'), (m) => '${m[1] ?? m[2]}!${m[1] ?? m[2]}')
           : _line;
     }).toList(growable: false);
-    if (!_stringListEquality(currentCodeBlock, prefixedCodeExcerpt)) {
+    if (!const ListEquality<String>()
+        .equals(currentCodeBlock, prefixedCodeExcerpt)) {
       _numUpdatedFrag++;
     }
     final result = <String>[

packages/code_excerpt_updater/lib/src/code_transformer/core.dart

@@ -68,16 +68,8 @@ CodeTransformer toCodeTransformer(String arg) {
   final matcher = patternArgToMatcher(arg, 'to');
   return (String code) {
     final lines = code.split(eol);
-    final i = _indexWhere(lines, matcher); // lines.indexWhere(matcher)
+    final i = lines.indexWhere(matcher);
     if (i < 0) return code;
     return lines.take(i + 1).join(eol);
   };
 }
-
-/// Patch: 1.24.3 doesn't have Iterable.indexWhere(). Drop this once we drop 1.x
-int _indexWhere(List<String> list, bool Function(String s) test) {
-  for (var i = 0; i < list.length; i++) {
-    if (test(list[i])) return i;
-  }
-  return -1;
-}

packages/code_excerpt_updater/lib/src/code_transformer/plaster.dart

@@ -1,7 +1,7 @@
 import 'core.dart';
 import 'replace.dart';
 
-const defaultPlaster = '···';
+const String defaultPlaster = '···';
 
 class PlasterCodeTransformer {
   final bool excerptsYaml;

packages/code_excerpt_updater/lib/src/code_transformer/replace.dart

@@ -5,12 +5,12 @@ import '../util.dart';
 import 'core.dart';
 
 class ReplaceCodeTransformer {
-  ReplaceCodeTransformer(this._reporter);
-
   final IssueReporter _reporter;
 
-  final _matchDollarNumRE = RegExp(r'(\$+)(&|\d*)');
-  final _endRE = RegExp(r'^g;?\s*$');
+  final RegExp _matchDollarNumRE = RegExp(r'(\$+)(&|\d*)');
+  final RegExp _endRE = RegExp(r'^g;?\s*$');
+
+  ReplaceCodeTransformer(this._reporter);
 
   CodeTransformer? codeTransformer(String? replaceExp) {
     void _reportErr([String extraInfo = '']) {

packages/code_excerpt_updater/lib/src/constants.dart

@@ -1,7 +1,7 @@
 /// App-wide constants
 
-const backslash = '\\';
-const eol = '\n';
-const zeroChar = '\u{0}';
+const String backslash = '\\';
+const String eol = '\n';
+const String zeroChar = '\u{0}';
 
 typedef Predicate<T> = bool Function(T);

packages/code_excerpt_updater/lib/src/diff/diff.dart

@@ -7,7 +7,7 @@ class Diff {
   bool _parsed = false;
 
   final List<String?> fileInfo = [null, null];
-  List<Hunk> hunks = [];
+  final List<Hunk> hunks = [];
 
   Diff(this._rawText);
 
@@ -34,7 +34,7 @@ class Diff {
     for (var i = 0; i < hunks.length; i++) {
       final hunk = hunks[i];
       if (hunk.dropLinesAfter(to)) {
-        hunks = hunks.take(i + 1).toList();
+        hunks.length = i + 1;
         return true;
       }
     }
@@ -68,7 +68,7 @@ class Diff {
     fileInfo[1] = lines[1];
 
     var i = 2;
-    hunks = [];
+    hunks.clear();
     while (i < lines.length) {
       if (!lines[i].startsWith('@@')) throw _invalidHunk(i);
       final start = i++;

packages/code_excerpt_updater/lib/src/diff/hunk.dart

@@ -21,7 +21,8 @@ const eol = '\n';
 class Hunk {
   static final Hunk empty = Hunk('');
 
-  final headRegExp = RegExp(r'@@ -(\d+)(,(\d+))? \+(\d+)(,(\d+))? @@(.*)');
+  static final RegExp headRegExp =
+      RegExp(r'@@ -(\d+)(,(\d+))? \+(\d+)(,(\d+))? @@(.*)');
 
   String _rawText;
 

packages/code_excerpt_updater/lib/src/differ.dart

@@ -12,14 +12,14 @@ typedef ErrorReporter = void Function(String msg);
 typedef ExcerptFetcher = Iterable<String>? Function(String path, String region);
 
 class Differ {
-  Differ(this._excerptFetcher, this._log, this._reportError);
-
-  final docregionRe = RegExp(r'#(end)?doc(plaster|region)\b');
+  final RegExp docregionRe = RegExp(r'#(end)?doc(plaster|region)\b');
   final ExcerptFetcher _excerptFetcher;
   final ErrorReporter _reportError;
   final Logger _log;
 
-  Directory? _tmpDir;
+  late final Directory _tmpDir = Directory.systemTemp;
+
+  Differ(this._excerptFetcher, this._log, this._reportError);
 
   Iterable<String>? getDiff(String relativeSrcPath1, String region,
       Map<String, String?> args, String pathPrefix) {
@@ -129,7 +129,7 @@ class Differ {
   File _writeTmp(String filePath, String content) {
     final ext = p.extension(filePath);
     final tmpFilePath =
-        p.join(getTmpDir().path, 'differ_src_${filePath.hashCode}$ext');
+        p.join(tempDirectory.path, 'differ_src_${filePath.hashCode}$ext');
     final tmpFile = File(tmpFilePath);
     tmpFile.writeAsStringSync(content);
     return tmpFile;
@@ -141,7 +141,7 @@ class Differ {
   //    return i;
   //  }
 
-  final _diffFileIdRegEx = RegExp(r'^(---|\+\+\+) ([^\t]+)\t(.*)$');
+  final RegExp _diffFileIdRegEx = RegExp(r'^(---|\+\+\+) ([^\t]+)\t(.*)$');
 
   String _adjustDiffFileIdLine(String relativePath, String diffFileIdLine) {
     final line = diffFileIdLine;
@@ -153,6 +153,5 @@ class Differ {
     return '${match[1]} $relativePath';
   }
 
-  Directory getTmpDir() =>
-      _tmpDir ??= Directory.systemTemp; // .createTempSync();
+  Directory get tempDirectory => _tmpDir;
 }

packages/code_excerpt_updater/lib/src/excerpt_getter.dart

@@ -9,8 +9,8 @@ import 'issue_reporter.dart';
 import 'logger.dart';
 import 'util.dart';
 
-const _defaultYamlExcerptLeftBorderChar = ''; // I.e., no char by default
-const _yamlExcerptLeftBorderCharKey = '#border';
+const String _defaultYamlExcerptLeftBorderChar = ''; // I.e., no char by default
+const String _yamlExcerptLeftBorderCharKey = '#border';
 
 class ExcerptGetter {
   ExcerptGetter(

packages/code_excerpt_updater/lib/src/issue_reporter.dart

@@ -4,7 +4,8 @@ class IssueReporter {
   final IssueContext _ctx;
   final Stdout _stderr;
 
-  int numWarnings = 0, numErrors = 0;
+  int numWarnings = 0;
+  int numErrors = 0;
 
   IssueReporter(this._ctx, [Stdout? err]) : _stderr = err ?? stderr;
 

packages/code_excerpt_updater/lib/src/util.dart

@@ -2,8 +2,6 @@ import 'dart:math';
 
 import 'constants.dart';
 
-// ignore_for_file: type_annotate_public_apis
-
 /// String to int conversion
 int? toInt(String? s, {int radix = 10, int? errorValue}) {
   if (s == null) {
@@ -18,8 +16,8 @@ int? toInt(String? s, {int radix = 10, int? errorValue}) {
 
 //-----------------------------------------------------------------------------
 
-final _blankLineRegEx = RegExp(r'^\s*$');
-final _leadingWhitespaceRegEx = RegExp(r'^[ \t]*');
+final RegExp _blankLineRegEx = RegExp(r'^\s*$');
+final RegExp _leadingWhitespaceRegEx = RegExp(r'^[ \t]*');
 
 Iterable<String> trimMinLeadingSpace(Iterable<String> lines) {
   final nonBlankLines = lines.where((s) => !_blankLineRegEx.hasMatch(s));
@@ -43,10 +41,10 @@ Iterable<String> trimMinLeadingSpace(Iterable<String> lines) {
 //-----------------------------------------------------------------------------
 // TODO: consider writing the following conversions as a string transformer.
 
-final escapedSlashRE = RegExp(r'\\/');
+final RegExp escapedSlashRE = RegExp(r'\\/');
 
-final _slashHexCharRE = RegExp(r'\\x(..)');
-final _slashLetterRE = RegExp(r'\\([\\nt])');
+final RegExp _slashHexCharRE = RegExp(r'\\x(..)');
+final RegExp _slashLetterRE = RegExp(r'\\([\\nt])');
 
 /// Encode special characters: '\t', `\n`, and `\xHH` where `HH` are hex digits.
 String encodeSlashChar(String s) => s

packages/code_excerpter/lib/builder.dart

@@ -5,10 +5,10 @@ import 'package:build/build.dart';
 import 'src/excerpter.dart';
 import 'src/util/line.dart';
 
-const excerptLineLeftBorderChar = '|';
+const String excerptLineLeftBorderChar = '|';
 
 class CodeExcerptBuilder implements Builder {
-  final outputExtension = '.excerpt.yaml';
+  static const outputExtension = '.excerpt.yaml';
 
   final BuilderOptions? options;
 

packages/code_excerpter/lib/src/directive.dart

@@ -5,10 +5,10 @@
 /// - CSS and Java-like languages: `*/`
 /// - HTML: `-->`
 ///
-final _directiveRegEx = RegExp(
+final RegExp _directiveRegEx = RegExp(
     r'^(\s*)(\S.*?)?#((?:end)?docregion)\b\s*(.*?)(?:\s*(?:-->|\*\/))?\s*$');
 
-final _argSeparator = RegExp(r'\s*,\s*');
+final RegExp _argSeparator = RegExp(r'\s*,\s*');
 
 /// Represents a code-excerpter directive (both the model and lexical elements)
 class Directive {

packages/code_excerpter/lib/src/excerpter.dart

@@ -74,7 +74,9 @@ class Excerpter {
 
     if (directive == null) {
       // Add line to open regions
-      _openExcerpts.forEach((name) => excerpts[name]?.add(_line));
+      for (final name in _openExcerpts) {
+        excerpts[name]?.add(_line);
+      }
       return;
     }
 

packages/code_excerpter/lib/src/util/line.dart

@@ -1,9 +1,9 @@
 import 'dart:math' show min;
 
-const eol = '\n';
+const String eol = '\n';
 
-final blankLine = RegExp(r'^\s*$');
-final _leadingWhitespace = RegExp(r'^[ \t]*');
+final RegExp blankLine = RegExp(r'^\s*$');
+final RegExp _leadingWhitespace = RegExp(r'^[ \t]*');
 
 /// WARNING: this method potentially mutates its argument.
 void dropTrailingBlankLines(List<String> lines) {

packages/code_excerpter/lib/src/util/logging.dart

@@ -23,7 +23,11 @@ final Logger log = () {
   if (logger == null) {
     logger = Logger('package:code_excerpter');
     Logger.root.level = initLevel;
-    Logger.root.onRecord.listen((r) => logListeners.forEach((h) => h(r)));
+    Logger.root.onRecord.listen((r) {
+      for (final h in logListeners) {
+        h(r);
+      }
+    });
   }
 
   return logger;

packages/code_excerpter/test/excerpter_test.dart

@@ -117,7 +117,7 @@ void main() {
   });
 
   group('region not closed:', () {
-    ['', '\n'].forEach((eol) {
+    for (final eol in const ['', '\n']) {
       group('empty region:', () {
         test('default region', () {
           final excerpter = Excerpter(uri, '#docregion$eol');
@@ -140,7 +140,7 @@ void main() {
             {defaultRegionKey: expectedLines, 'b': expectedLines});
         _expectNoLogs();
       });
-    });
+    }
   });
 
   group('problems:', problemCases);