Generate included css using sass (#3917)

Author: parlough

.gitattributes

@@ -1,6 +1,8 @@
 *.dart text eol=lf
 *.yaml text eol=lf
 
+lib/resources/styles.css linguist-generated=true
+
 # Don't collapse in github code reviews by default.
 lib/src/version.dart linguist-generated=false
 lib/src/html/resources.g.dart linguist-generated=false
@@ -10,6 +12,7 @@ lib/src/html/resources.g.dart linguist-generated=false
 # these files with `dart run tool/task.dart build`.
 lib/resources/docs.dart.js merge=theirs
 lib/resources/docs.dart.js.map merge=theirs
+lib/resources/styles.css merge=theirs
 lib/src/generator/templates.aot_renderers_for_html.dart merge=theirs
 lib/src/generator/templates.aot_renderers_for_md.dart merge=theirs
 lib/src/generator/templates.runtime_renderers.dart merge=theirs

lib/resources/styles.css

@@ -27,6 +27,7 @@ dev_dependencies:
   dart_style: ^2.3.7
   lints: ^5.0.0
   matcher: ^0.12.15
+  sass: ^1.80.4
   test: ^1.24.2
   test_descriptor: ^2.0.1
   test_process: ^2.0.3

pubspec.yaml

@@ -12,6 +12,7 @@ import 'package:crypto/crypto.dart' as crypto;
 import 'package:dartdoc/src/io_utils.dart';
 import 'package:dartdoc/src/package_meta.dart';
 import 'package:path/path.dart' as path;
+import 'package:sass/sass.dart' as sass;
 import 'package:yaml/yaml.dart' as yaml;
 import 'package:yaml/yaml.dart';
 
@@ -177,7 +178,15 @@ Future<void> buildWeb({bool debug = false}) async {
   ]);
   _delete(File('lib/resources/docs.dart.js.deps'));
 
-  var compileSig = await _calcDartFilesSig(Directory('web'));
+  final compileResult = sass.compileToResult('web/styles/styles.scss');
+  if (compileResult.css.isNotEmpty) {
+    File('lib/resources/styles.css').writeAsStringSync(compileResult.css);
+  } else {
+    throw StateError('Compiled CSS was empty.');
+  }
+
+  var compileSig =
+      await _calcFilesSig(Directory('web'), extensions: {'.dart', '.scss'});
   File(path.join('web', 'sig.txt')).writeAsStringSync('$compileSig\n');
 }
 
@@ -189,14 +198,14 @@ void _delete(FileSystemEntity entity) {
   }
 }
 
-/// Yields all of the trimmed lines of all of the `.dart` files in [dir].
-Stream<String> _dartFileLines(Directory dir) {
+/// Yields all of the trimmed lines of all of the files in [dir] with
+/// one of the specified [extensions].
+Stream<String> _fileLines(Directory dir, {required Set<String> extensions}) {
   var files = dir
       .listSync(recursive: true)
       .whereType<File>()
-      .where((file) => file.path.endsWith('.dart'))
-      .toList()
-    ..sort((a, b) => compareAsciiLowerCase(a.path, b.path));
+      .where((file) => extensions.contains(path.extension(file.path)))
+      .sorted((a, b) => compareAsciiLowerCase(a.path, b.path));
 
   return Stream.fromIterable([
     for (var file in files)
@@ -824,11 +833,12 @@ Rebuild them with "dart tool/task.dart build" and check the results in.
   }
 
   // Verify that the web frontend has been compiled.
-  final currentCodeSig = await _calcDartFilesSig(Directory('web'));
+  final currentSig =
+      await _calcFilesSig(Directory('web'), extensions: {'.dart', '.scss'});
   final lastCompileSig =
       File(path.join('web', 'sig.txt')).readAsStringSync().trim();
-  if (currentCodeSig != lastCompileSig) {
-    print('current files: $currentCodeSig');
+  if (currentSig != lastCompileSig) {
+    print('current files: $currentSig');
     print('cached sig   : $lastCompileSig');
     throw StateError(
         'The web frontend (web/docs.dart) needs to be recompiled; rebuild it '
@@ -985,8 +995,9 @@ int _findCount(String str, String match) {
   return count;
 }
 
-Future<String> _calcDartFilesSig(Directory dir) async {
-  final digest = await _dartFileLines(dir)
+Future<String> _calcFilesSig(Directory dir,
+    {required Set<String> extensions}) async {
+  final digest = await _fileLines(dir, extensions: extensions)
       .transform(utf8.encoder)
       .transform(crypto.md5)
       .single;

tool/task.dart

@@ -1 +1 @@
-A6336370D9A2C5AE421600C7D9356FC6
+3E2408ED7DD4454C55FBF018B65003E7